From ff06cd382011e3f255a602a813289609eb930ef3 Mon Sep 17 00:00:00 2001 From: Deyaaeldeen Almahallawi Date: Fri, 4 Sep 2020 16:11:45 -0400 Subject: [PATCH 001/164] [Text Analytics] Make redactedText required (#10691) --- .../TextAnalytics/preview/v3.1-preview.2/TextAnalytics.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.2/TextAnalytics.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.2/TextAnalytics.json index defe5093ca91..fcb470b19c05 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.2/TextAnalytics.json +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.2/TextAnalytics.json @@ -976,7 +976,8 @@ "required": [ "id", "entities", - "warnings" + "warnings", + "redactedText" ], "properties": { "id": { From b2ef24ed86d61493d268c57d733d6ba2c171a9da Mon Sep 17 00:00:00 2001 From: Arcturus Date: Mon, 7 Sep 2020 10:03:56 +0800 Subject: [PATCH 002/164] Add api-version of hybridcompute to go SDK (#10703) * Add new api-version of hybrid compute to go SDK * Fix bad output-folder --- .../hybridcompute/resource-manager/readme.go.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/specification/hybridcompute/resource-manager/readme.go.md b/specification/hybridcompute/resource-manager/readme.go.md index 7b5ae1bdae0f..85441e52dba6 100644 --- a/specification/hybridcompute/resource-manager/readme.go.md +++ b/specification/hybridcompute/resource-manager/readme.go.md @@ -20,6 +20,16 @@ go: ``` yaml $(go) && $(multiapi) batch: - tag: package-2019-12 + - tag: package-2020-08-02 +``` + +### Tag: package-2020-08-02 and go + +These settings apply only when `--tag=package-2020-08-02 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2020-08-02' && $(go) +output-folder: $(go-sdk-folder)/services/hybridcompute/mgmt/2020-08-02/hybridcompute ``` ### Tag: package-2019-12 and go @@ -28,5 +38,5 @@ These settings apply only when `--tag=package-2019-12 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag)=='package-2019-12' && $(go) -output-folder: $(go-sdk-folder)/services/preview/hybridcompute/mgmt/2019-12-12/hybridcompute +output-folder: $(go-sdk-folder)/services/hybridcompute/mgmt/2019-12-12/hybridcompute ``` From 0ae8a304bf43cff0a04a61bce8eb36232728aae0 Mon Sep 17 00:00:00 2001 From: hutzleo <8101994+hutzleo@users.noreply.github.com> Date: Mon, 7 Sep 2020 05:34:36 +0300 Subject: [PATCH 003/164] add skip metric definition to swagger (#10712) * add skip metric definition to spec * prettier fix * chnage description --- .../Microsoft.Insights/stable/2018-03-01/metricAlert_API.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/metricAlert_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/metricAlert_API.json index e88efc9a9349..a5f09da2e038 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/metricAlert_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/metricAlert_API.json @@ -851,6 +851,10 @@ "$ref": "#/definitions/MetricDimension" }, "description": "List of dimension conditions." + }, + "skipMetricValidation": { + "type": "boolean", + "description": "Allows creating an alert rule on a custom metric that isn't yet emitted, by causing the metric validation to be skipped." } }, "required": [ From 49cbc7f8e4242ea824b67748ed5cc8471053f2a2 Mon Sep 17 00:00:00 2001 From: omerhaimov <55688621+omerhaimov@users.noreply.github.com> Date: Mon, 7 Sep 2020 05:46:27 +0300 Subject: [PATCH 004/164] Add office ATP to Swagger (#10674) * Add office ATP to Swagger * fixes * merge --- .../2019-01-01-preview/SecurityInsights.json | 65 +++++++++++++++++++ .../CheckRequirementsOfficeATP.json | 23 +++++++ .../dataConnectors/GetDataConnectors.json | 15 +++++ ...Office365AdvancedThreatProtectionById.json | 29 +++++++++ 4 files changed, 132 insertions(+) create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/CheckRequirementsOfficeATP.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetOffice365AdvancedThreatProtectionById.json diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json index ac47cdd8aba1..cadf9002a0ce 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json @@ -1729,6 +1729,9 @@ }, "Get a MDATP data connector": { "$ref": "./examples/dataConnectors/GetMicrosoftDefenderAdvancedThreatProtectionById.json" + }, + "Get a Office ATP data connector": { + "$ref": "./examples/dataConnectors/GetOffice365AdvancedThreatProtectionById.json" } }, "tags": [ @@ -1899,6 +1902,9 @@ }, "Check requirements for Mdatp.": { "$ref": "./examples/dataConnectors/CheckRequirementsMdatp.json" + }, + "Check requirements for OfficeATP.": { + "$ref": "./examples/dataConnectors/CheckRequirementsOfficeATP.json" } }, "tags": [ @@ -5669,6 +5675,7 @@ "ThreatIntelligence", "ThreatIntelligenceTaxii", "Office365", + "OfficeATP", "AmazonWebServicesCloudTrail", "AzureAdvancedThreatProtection", "MicrosoftDefenderAdvancedThreatProtection" @@ -5696,6 +5703,9 @@ { "value": "Office365" }, + { + "value": "OfficeATP" + }, { "value": "AmazonWebServicesCloudTrail" }, @@ -7382,6 +7392,61 @@ "type": "object", "x-ms-discriminator-value": "MicrosoftSecurityIncidentCreation" }, + "OfficeATPDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents OfficeATP (Office 365 Advanced Threat Protection) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficeATPDataConnectorProperties", + "description": "OfficeATP (Office 365 Advanced Threat Protection) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "OfficeATP" + }, + "OfficeATPDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + }, + { + "$ref": "#/definitions/DataConnectorWithAlertsProperties" + } + ], + "description": "OfficeATP (Office 365 Advanced Threat Protection) data connector properties.", + "type": "object" + }, + "OfficeATPCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents OfficeATP (Office 365 Advanced Threat Protection) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficeATPCheckRequirementsProperties", + "description": "OfficeATP (Office 365 Advanced Threat Protection) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "OfficeATP" + }, + "OfficeATPCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "OfficeATP (Office 365 Advanced Threat Protection) requirements check properties.", + "type": "object" + }, "OfficeConsent": { "allOf": [ { diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/CheckRequirementsOfficeATP.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/CheckRequirementsOfficeATP.json new file mode 100644 index 000000000000..2e1b31f61760 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/CheckRequirementsOfficeATP.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "DataConnectorsCheckRequirements": { + "kind": "OfficeATP", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetDataConnectors.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetDataConnectors.json index 6c783118cb3b..d5cc1b3077fc 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetDataConnectors.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetDataConnectors.json @@ -156,6 +156,21 @@ } } } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/3d3e955e-33eb-401d-89a7-251c81ddd660", + "name": "3d3e955e-33eb-401d-89a7-251c81ddd660", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "OfficeATP", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } } ] } diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetOffice365AdvancedThreatProtectionById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetOffice365AdvancedThreatProtectionById.json new file mode 100644 index 000000000000..cf6f4020b451 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetOffice365AdvancedThreatProtectionById.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "dataConnectorId": "3d3e955e-33eb-401d-89a7-251c81ddd660" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/3d3e955e-33eb-401d-89a7-251c81ddd660", + "name": "3d3e955e-33eb-401d-89a7-251c81ddd660", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "OfficeATP", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + } + } + } +} From f19ed0186981aa6fe7d0f8570e160b5db603772b Mon Sep 17 00:00:00 2001 From: zhaomuzhi Date: Sun, 6 Sep 2020 20:08:26 -0700 Subject: [PATCH 005/164] Update delete pe connection to long running (#10387) * Add Identity to createWorkpace example * correct several places in swagger * add id,name,type to PrivateEndpointConnection * fix lintDiff error * fix CI pipelines * fix sku swagger not aligned with service problem --- .../stable/2020-06-01/examples/ListSkus.json | 76 ++++++------------- ...kspaceDeletePrivateEndpointConnection.json | 1 + .../2020-06-01/machineLearningServices.json | 54 ++++++++++--- 3 files changed, 67 insertions(+), 64 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListSkus.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListSkus.json index 7f3f77cc768a..f3d57d4a6891 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListSkus.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListSkus.json @@ -9,67 +9,35 @@ "value": [ { "resourceType": "workspaces", - "name": "Basic", - "tier": "Basic", - "locations": [ - "westus" - ], - "locationInfo": [ + "skus": [ { - "location": "westus", - "zones": [ - "westus-AZ02", - "westus-AZ01" - ] - } - ], - "capabilities": [ - { - "name": "automatedml_readhyperdrivesdk", - "value": "{\n \"id\": \"automatedml_ readhyperdrivesdk\",\n \"name\": \"Read hyperdrive SDK\",\n \"description\": \"Read only access to Hyperdrive in the SDK\"\n}" - }, - { - "name": "workspace_upgradeworkspacesdk", - "value": "{\n \"id\": \"workspace_upgradeworkspacesdk\",\n \"name\": \"Upgrade workspace SDK\",\n \"description\": \"Upgrade workspace from Basic to enterprise from the SDK\"\n}" - } - ], - "restrictions": [] - }, - { - "resourceType": "workspaces", - "name": "Enterprise", - "tier": "Enterprise", - "locations": [ - "westus" - ], - "locationInfo": [ - { - "location": "westus", - "zones": [ - "westus-AZ01" + "name": "Basic", + "tier": "Basic", + "locations": [ + "westus" ], - "zoneDetails": [ + "locationInfo": [ { - "name": [ + "location": "westus", + "zones": [ + "westus-AZ02", "westus-AZ01" - ], - "capabilities": [ - { - "name": "automatedml_createeditexperimentssdk", - "value": "{\n \"id\": \"automatedml_createeditexperimentssdk\",\n \"name\": \"Create edit experiments SDK\",\n \"description\": \"Create, edit or delete AutoML experiments in the SDK\"\n}" - } ] } - ] - } - ], - "capabilities": [ - { - "name": "automatedml_createeditexperimentssdk", - "value": "{\n \"id\": \"automatedml_createeditexperimentssdk\",\n \"name\": \"Create edit experiments SDK\",\n \"description\": \"Create, edit or delete AutoML experiments in the SDK\"\n}" + ], + "capabilities": [ + { + "name": "automatedml_readhyperdrivesdk", + "value": "{\n \"id\": \"automatedml_ readhyperdrivesdk\",\n \"name\": \"Read hyperdrive SDK\",\n \"description\": \"Read only access to Hyperdrive in the SDK\"\n}" + }, + { + "name": "workspace_upgradeworkspacesdk", + "value": "{\n \"id\": \"workspace_upgradeworkspacesdk\",\n \"name\": \"Upgrade workspace SDK\",\n \"description\": \"Upgrade workspace from Basic to enterprise from the SDK\"\n}" + } + ], + "restrictions": [] } - ], - "restrictions": [] + ] } ], "nextLink": null diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspaceDeletePrivateEndpointConnection.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspaceDeletePrivateEndpointConnection.json index d6cddc4a0c2c..b493ea44b56e 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspaceDeletePrivateEndpointConnection.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspaceDeletePrivateEndpointConnection.json @@ -9,6 +9,7 @@ }, "responses": { "200": {}, + "202": {}, "204": {} } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/machineLearningServices.json index c61833520064..9641d26adc27 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/machineLearningServices.json @@ -1344,7 +1344,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/MachineLearningServiceError" } } } @@ -1396,7 +1396,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/MachineLearningServiceError" } } } @@ -1407,6 +1407,7 @@ ], "operationId": "PrivateEndpointConnections_Delete", "description": "Deletes the specified private endpoint connection associated with the workspace.", + "x-ms-long-running-operation": true, "x-ms-examples": { "WorkspaceDeletePrivateEndpointConnection": { "$ref": "./examples/workspaceDeletePrivateEndpointConnection.json" @@ -1433,13 +1434,16 @@ "200": { "description": "OK -- Delete the private endpoint connection successfully." }, + "202": { + "description": "The request was successful; the request was well-formed and received properly." + }, "204": { "description": "No Content -- The private endpoint connection does not exist." }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/MachineLearningServiceError" } } } @@ -3533,6 +3537,24 @@ "description": "Describes The zonal capabilities of a SKU." }, "WorkspaceSku": { + "type": "object", + "description": "AML workspace sku information", + "properties": { + "resourceType": { + "readOnly": true, + "type": "string" + }, + "skus": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SkuSettings" + }, + "description": "The list of workspace sku settings" + } + } + }, + "SkuSettings": { "description": "Describes Workspace Sku details and features", "type": "object", "properties": { @@ -3646,19 +3668,31 @@ } }, "PrivateEndpointConnection": { + "x-ms-azure-resource": true, + "description": "The Private Endpoint Connection resource.", + "type": "object", "properties": { + "id": { + "type": "string", + "description": "ResourceId of the private endpoint connection.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Friendly name of the private endpoint connection.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Resource type of private endpoint connection.", + "readOnly": true + }, "properties": { "$ref": "#/definitions/PrivateEndpointConnectionProperties", "x-ms-client-flatten": true, "description": "Resource properties." } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "The Private Endpoint Connection resource." + } }, "PrivateEndpointConnectionProperties": { "properties": { From 35d24315a39e1519597ec5d5b55f73921f12b57a Mon Sep 17 00:00:00 2001 From: changlong-liu <59815250+changlong-liu@users.noreply.github.com> Date: Mon, 7 Sep 2020 15:19:54 +0800 Subject: [PATCH 006/164] tag: package-2020-08 (#10658) * tag: package-2020-08 * use package-2020-08-02 --- specification/hybridcompute/resource-manager/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/hybridcompute/resource-manager/readme.md b/specification/hybridcompute/resource-manager/readme.md index 9e66c97b61a8..8a979ba5fe64 100644 --- a/specification/hybridcompute/resource-manager/readme.md +++ b/specification/hybridcompute/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the HybridCompute API. ``` yaml openapi-type: arm -tag: package-preview-2020-08 +tag: package-2020-08-02 ``` From ddfe040e320a928c1a3cec4e7a4024ff448c6a4c Mon Sep 17 00:00:00 2001 From: Yeming Liu Date: Tue, 8 Sep 2020 10:05:10 +0800 Subject: [PATCH 007/164] [KeyVault] Change default tag (#10684) --- specification/keyvault/resource-manager/readme.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/specification/keyvault/resource-manager/readme.md b/specification/keyvault/resource-manager/readme.md index c2d3793b10e5..0fec867b1a2c 100644 --- a/specification/keyvault/resource-manager/readme.md +++ b/specification/keyvault/resource-manager/readme.md @@ -26,12 +26,13 @@ These are the global settings for the KeyVault API. ``` yaml openapi-type: arm -tag: package-preview-2020-04 +tag: package-2019-09 ``` ### Tag: package-preview-2020-04 These settings apply only when `--tag=package-preview-2020-04` is specified on the command line. +This tag is for the development of preview features related to managed HSM of Azure CLI and PowerShell. ```yaml $(tag) == 'package-preview-2020-04' input-file: From 8f09f311667a59ead1ed1a0afcfd0b5ed4c31ea6 Mon Sep 17 00:00:00 2001 From: AKachan0v Date: Mon, 7 Sep 2020 21:37:23 -0700 Subject: [PATCH 008/164] Add TenantConfiguration API to the Microsoft.Portal provider (version 2019-01-01-preview) (#10603) * #7912260: Add tenant configuration API * Fix version * Fix references * Fix Prettier * Add new file to readme.md * Fix Linter warnings * Add Delete method * Adds suppression to readme * Remove suppression for boolean * Ref to common type instead of redefine generic fields * Fix Prettier * Change resource type to plural and descriptions * Add Tenant configuration list * Fix example position * Fix Prettier * Change version for common types * Use local definition instead of ref common types * Revoke 2 latest commits and return repo to signed off state * Fix Prettier Co-authored-by: Alex Kachanov --- .../CreateOrUpdateTenantConfiguration.json | 33 +++ .../DeleteTenantConfiguration.json | 10 + .../GetListOfTenantConfigurations.json | 21 ++ .../GetTenantConfiguration.json | 18 ++ .../tenantConfiguration.json | 256 ++++++++++++++++++ .../portal/resource-manager/readme.md | 9 +- 6 files changed, 343 insertions(+), 4 deletions(-) create mode 100644 specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/examples/TenantConfiguration/CreateOrUpdateTenantConfiguration.json create mode 100644 specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/examples/TenantConfiguration/DeleteTenantConfiguration.json create mode 100644 specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/examples/TenantConfiguration/GetListOfTenantConfigurations.json create mode 100644 specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/examples/TenantConfiguration/GetTenantConfiguration.json create mode 100644 specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/tenantConfiguration.json diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/examples/TenantConfiguration/CreateOrUpdateTenantConfiguration.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/examples/TenantConfiguration/CreateOrUpdateTenantConfiguration.json new file mode 100644 index 000000000000..804d967b678c --- /dev/null +++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/examples/TenantConfiguration/CreateOrUpdateTenantConfiguration.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "configurationName": "default", + "api-version": "2019-01-01-preview", + "tenantConfiguration": { + "properties": { + "enforcePrivateMarkdownStorage": true + } + } + }, + "responses": { + "201": { + "body": { + "id": "/providers/Microsoft.Portal/tenantConfigurations/default", + "name": "default", + "type": "Microsoft.Portal/tenantConfiguration", + "properties": { + "enforcePrivateMarkdownStorage": true + } + } + }, + "200": { + "body": { + "id": "/providers/Microsoft.Portal/tenantConfigurations/default", + "name": "default", + "type": "Microsoft.Portal/tenantConfiguration", + "properties": { + "enforcePrivateMarkdownStorage": true + } + } + } + } +} diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/examples/TenantConfiguration/DeleteTenantConfiguration.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/examples/TenantConfiguration/DeleteTenantConfiguration.json new file mode 100644 index 000000000000..640025727bc7 --- /dev/null +++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/examples/TenantConfiguration/DeleteTenantConfiguration.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "configurationName": "default", + "api-version": "2019-01-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/examples/TenantConfiguration/GetListOfTenantConfigurations.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/examples/TenantConfiguration/GetListOfTenantConfigurations.json new file mode 100644 index 000000000000..bbb7cfefdb1f --- /dev/null +++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/examples/TenantConfiguration/GetListOfTenantConfigurations.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Portal/tenantConfigurations", + "name": "default", + "type": "Microsoft.Portal/tenantConfiguration", + "properties": { + "enforcePrivateMarkdownStorage": true + } + } + ] + } + } + } +} diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/examples/TenantConfiguration/GetTenantConfiguration.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/examples/TenantConfiguration/GetTenantConfiguration.json new file mode 100644 index 000000000000..b945a54fcc08 --- /dev/null +++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/examples/TenantConfiguration/GetTenantConfiguration.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "configurationName": "default", + "api-version": "2019-01-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Portal/tenantConfigurations/default", + "name": "default", + "type": "Microsoft.Portal/tenantConfiguration", + "properties": { + "enforcePrivateMarkdownStorage": true + } + } + } + } +} diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/tenantConfiguration.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/tenantConfiguration.json new file mode 100644 index 000000000000..a7ff3f47c85a --- /dev/null +++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2019-01-01-preview/tenantConfiguration.json @@ -0,0 +1,256 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-01-01-preview", + "title": "portal", + "description": "Manage tenant configuration.", + "x-ms-code-generation-settings": { + "name": "portalClient" + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/providers/Microsoft.Portal/tenantConfigurations": { + "get": { + "tags": [ + "tenantConfiguration" + ], + "operationId": "TenantConfigurations_List", + "description": "Gets list of the tenant configurations.", + "parameters": [ + { + "$ref": "portal.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Returns the list of tenant configurations.", + "schema": { + "$ref": "#/definitions/ConfigurationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "portal.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get list of Tenant configurations": { + "$ref": "examples/TenantConfiguration/GetListOfTenantConfigurations.json" + } + } + } + }, + "/providers/Microsoft.Portal/tenantConfigurations/{configurationName}": { + "get": { + "tags": [ + "tenantConfiguration" + ], + "operationId": "TenantConfigurations_Get", + "description": "Gets the tenant configuration.", + "parameters": [ + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "portal.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Returns the tenant configuration.", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "portal.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Tenant configuration": { + "$ref": "examples/TenantConfiguration/GetTenantConfiguration.json" + } + } + }, + "put": { + "tags": [ + "tenantConfiguration" + ], + "operationId": "TenantConfigurations_Create", + "description": "Create the tenant configuration. If configuration already exists - update it. User has to be a Tenant Admin for this operation.", + "parameters": [ + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "portal.json#/parameters/ApiVersionParameter" + }, + { + "name": "tenantConfiguration", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Configuration" + }, + "description": "The parameters required to create or update tenant configuration." + } + ], + "responses": { + "201": { + "description": "Created. New configuration was created", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "200": { + "description": "OK. Existing configuration updated.", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "portal.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update Tenant configuration": { + "$ref": "examples/TenantConfiguration/CreateOrUpdateTenantConfiguration.json" + } + } + }, + "delete": { + "tags": [ + "tenantConfiguration" + ], + "operationId": "TenantConfigurations_Delete", + "description": "Delete the tenant configuration. User has to be a Tenant Admin for this operation.", + "parameters": [ + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "portal.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Configuration was deleted." + }, + "204": { + "description": "No content. Configuration was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "portal.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Tenant configuration": { + "$ref": "examples/TenantConfiguration/DeleteTenantConfiguration.json" + } + } + } + } + }, + "parameters": { + "ConfigurationNameParameter": { + "name": "configurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The configuration name. Value must be 'default'", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "configurationName", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "ConfigurationList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Configuration" + }, + "description": "The array of custom resource provider manifests." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of tenant configurations." + }, + "Configuration": { + "type": "object", + "description": "Tenant configuration.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConfigurationProperties", + "description": "Tenant configuration properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "ConfigurationProperties": { + "type": "object", + "description": "Tenant configuration properties.", + "x-ms-azure-resource": true, + "properties": { + "enforcePrivateMarkdownStorage": { + "type": "boolean", + "description": "When flag is set to true Markdown tile will require external storage configuration (URI). The inline content configuration will be prohibited." + } + } + } + }, + "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" + } + } + } +} diff --git a/specification/portal/resource-manager/readme.md b/specification/portal/resource-manager/readme.md index ee9417d8fb23..389c00a6bfd6 100644 --- a/specification/portal/resource-manager/readme.md +++ b/specification/portal/resource-manager/readme.md @@ -36,13 +36,14 @@ These settings apply only when `--tag=package-2019-01-01-preview` is specified o ``` yaml $(tag) == 'package-2019-01-01-preview' input-file: - Microsoft.Portal/preview/2019-01-01-preview/portal.json + - Microsoft.Portal/preview/2019-01-01-preview/tenantConfiguration.json ``` ### Tag: package-2018-10-01-preview These settings apply only when `--tag=package-2018-10-01-preview` is specified on the command line. -```yaml $(tag) == 'package-2018-10-01-preview' +``` yaml $(tag) == 'package-2018-10-01-preview' input-file: - Microsoft.Portal/preview/2018-10-01-preview/portal.json ``` @@ -109,7 +110,7 @@ See configuration in [readme.nodejs.md](./readme.nodejs.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators +## Multi-API/Profile support for AutoRest v3 generators AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. @@ -122,16 +123,16 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: - $(this-folder)/Microsoft.Portal/preview/2019-01-01-preview/portal.json + - $(this-folder)/Microsoft.Portal/preview/2019-01-01-preview/tenantConfiguration.json - $(this-folder)/Microsoft.Portal/preview/2018-10-01-preview/portal.json - $(this-folder)/Microsoft.Portal/preview/2015-08-01-preview/portal.json ``` -If there are files that should not be in the `all-api-versions` set, +If there are files that should not be in the `all-api-versions` set, uncomment the `exclude-file` section below and add the file paths. ``` yaml $(tag) == 'all-api-versions' #exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json ``` - From 3308ab5ad8a788fa049642b71447b206749969c1 Mon Sep 17 00:00:00 2001 From: rickysun93 Date: Tue, 8 Sep 2020 14:54:22 +0800 Subject: [PATCH 009/164] add maxrowperfile/filenameprefix (#10666) Co-authored-by: Haoran Sun --- .../2018-06-01/entityTypes/Pipeline.json | 62 +++++++++++++++++++ 1 file changed, 62 insertions(+) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index c58a77bbfffb..be8062d5491d 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -1066,6 +1066,52 @@ "recordNamespace": { "type": "string", "description": "Record namespace in the write result." + }, + "maxRowsPerFile": { + "type": "object", + "description": "Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer)." + }, + "fileNamePrefix": { + "type": "object", + "description": "Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string)." + } + } + }, + "OrcWriteSettings": { + "description": "Orc write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatWriteSettings" + } + ], + "properties": { + "maxRowsPerFile": { + "type": "object", + "description": "Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer)." + }, + "fileNamePrefix": { + "type": "object", + "description": "Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string)." + } + } + }, + "ParquetWriteSettings": { + "description": "Parquet write settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatWriteSettings" + } + ], + "properties": { + "maxRowsPerFile": { + "type": "object", + "description": "Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer)." + }, + "fileNamePrefix": { + "type": "object", + "description": "Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string)." } } }, @@ -1085,6 +1131,14 @@ "fileExtension": { "type": "object", "description": "The file extension used to create the files. Type: string (or Expression with resultType string)." + }, + "maxRowsPerFile": { + "type": "object", + "description": "Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer)." + }, + "fileNamePrefix": { + "type": "object", + "description": "Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string)." } }, "required": [ @@ -1330,6 +1384,10 @@ "storeSettings": { "$ref": "#/definitions/StoreWriteSettings", "description": "ORC store settings." + }, + "formatSettings": { + "$ref": "#/definitions/OrcWriteSettings", + "description": "ORC format settings." } } }, @@ -3739,6 +3797,10 @@ "storeSettings": { "$ref": "#/definitions/StoreWriteSettings", "description": "Parquet store settings." + }, + "formatSettings": { + "$ref": "#/definitions/ParquetWriteSettings", + "description": "Parquet format settings." } } }, From fceeea43dc236b6914a1c5eb5d4b97fd056ed9d9 Mon Sep 17 00:00:00 2001 From: Suna Liu Date: Tue, 8 Sep 2020 16:49:33 +0800 Subject: [PATCH 010/164] Update MySQL flexibleServer swagger to change some APIs (#10660) * Update MySQL flexibleServer swagger to change some APIs * Add BYOK APIs and change primaryServerId to sourceServerId * Rename keys to serverkeys to follow the old naming * Fix 202 response for ServerKey PUT API * Remove CheckVirtualNetworkSubnetUsage operation id * Change LocationBasedCapabilities_List response body --- .../examples/CapabilitiesByLocationList.json | 197 +++++ .../CheckVirtualNetworkSubnetUsage.json | 26 + .../examples/MaintenanceWindowCreate.json | 46 -- .../examples/MaintenanceWindowDelete.json | 14 - .../examples/MaintenanceWindowGet.json | 24 - .../MaintenanceWindowsListByServer.json | 27 - .../examples/ReplicasListByServer.json | 6 +- .../examples/ServerCreateReplica.json | 4 +- .../examples/ServerGet.json | 16 +- .../examples/ServerGetWithVnet.json | 10 +- .../examples/ServerKeyCreate.json | 44 + .../examples/ServerKeyDelete.json | 14 + .../examples/ServerKeyGet.json | 24 + .../examples/ServerKeysListByServer.json | 27 + .../examples/ServerUpdate.json | 13 +- ...erUpdateWithCustomerMaintenanceWindow.json | 59 ++ .../2020-07-01-privatepreview/mysql.json | 774 +++++++++++++----- 17 files changed, 991 insertions(+), 334 deletions(-) create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/CapabilitiesByLocationList.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/CheckVirtualNetworkSubnetUsage.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/MaintenanceWindowCreate.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/MaintenanceWindowDelete.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/MaintenanceWindowGet.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/MaintenanceWindowsListByServer.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerKeyCreate.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerKeyDelete.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerKeyGet.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerKeysListByServer.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerUpdateWithCustomerMaintenanceWindow.json diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/CapabilitiesByLocationList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/CapabilitiesByLocationList.json new file mode 100644 index 000000000000..ac537987f888 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/CapabilitiesByLocationList.json @@ -0,0 +1,197 @@ +{ + "parameters": { + "api-version": "2020-07-01-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "locationName": "WestUS" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "zone": "none", + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "PremiumFileShare", + "minStorageSize": { + "name": "10240", + "storageSizeMB": 10240 + }, + "maxStorageSize": { + "name": "16777216", + "storageSizeMB": 16777216 + }, + "minBackupRetentionDays": 7, + "maxBackupRetentionDays": 35 + } + ], + "supportedServerVersions": [ + { + "name": "5.7", + "supportedVcores": [ + { + "name": "Standard_B1s", + "vCores": 1, + "supportedIops": 320, + "supportedMemoryPerVcoreMB": 2048 + }, + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048 + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048 + } + ] + } + ] + }, + { + "name": "GeneralPurpose", + "supportedStorageEditions": [ + { + "name": "PremiumFileShare", + "minStorageSize": { + "name": "10240", + "storageSizeMB": 10240 + }, + "maxStorageSize": { + "name": "16777216", + "storageSizeMB": 16777216 + }, + "minBackupRetentionDays": 7, + "maxBackupRetentionDays": 35 + } + ], + "supportedServerVersions": [ + { + "name": "5.7", + "supportedVcores": [ + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 4096 + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 4096 + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 4096 + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 20000, + "supportedMemoryPerVcoreMB": 4096 + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 20000, + "supportedMemoryPerVcoreMB": 4096 + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 20000, + "supportedMemoryPerVcoreMB": 4096 + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 20000, + "supportedMemoryPerVcoreMB": 4096 + } + ] + } + ] + }, + { + "name": "MemoryOptimized", + "supportedStorageEditions": [ + { + "name": "PremiumFileShare", + "minStorageSize": { + "name": "10240", + "storageSizeMB": 10240 + }, + "maxStorageSize": { + "name": "16777216", + "storageSizeMB": 16777216 + }, + "minBackupRetentionDays": 7, + "maxBackupRetentionDays": 35 + } + ], + "supportedServerVersions": [ + { + "name": "5.7", + "supportedVcores": [ + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMB": 8192 + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMB": 8192 + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMB": 8192 + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 20000, + "supportedMemoryPerVcoreMB": 8192 + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 20000, + "supportedMemoryPerVcoreMB": 8192 + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 20000, + "supportedMemoryPerVcoreMB": 8192 + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 20000, + "supportedMemoryPerVcoreMB": 8192 + } + ] + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/CheckVirtualNetworkSubnetUsage.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/CheckVirtualNetworkSubnetUsage.json new file mode 100644 index 000000000000..2b82b6978e3a --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/CheckVirtualNetworkSubnetUsage.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2020-07-01-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "locationName": "WestUS", + "parameters": { + "virtualNetworkArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/testvnet" + } + }, + "responses": { + "200": { + "body": { + "delegatedSubnetsUsage": [ + { + "subnetName": "test-subnet-1", + "usage": 2 + }, + { + "subnetName": "test-subnet-2", + "usage": 3 + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/MaintenanceWindowCreate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/MaintenanceWindowCreate.json deleted file mode 100644 index 89163e0da956..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/MaintenanceWindowCreate.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "parameters": { - "maintenanceWindowName": "customerMaintenanceWindow", - "serverName": "testserver", - "resourceGroupName": "testrg", - "api-version": "2020-07-01-privatepreview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", - "parameters": { - "properties": { - "dayOfWeek": 1, - "startHour": 0, - "startMinute": 30, - "durationInMinutes": 30 - } - } - }, - "responses": { - "201": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/testserver/maintenanceWindows/customerMaintenanceWindow", - "name": "customerMaintenanceWindow", - "properties": { - "dayOfWeek": 1, - "startHour": 0, - "startMinute": 30, - "durationInMinutes": 30 - }, - "type": "Microsoft.DBforPostgreSQL/flexibleServers/maintenanceWindows" - } - }, - "200": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/testserver/maintenanceWindows/customerMaintenanceWindow", - "name": "customerMaintenanceWindow", - "properties": { - "dayOfWeek": 1, - "startHour": 0, - "startMinute": 30, - "durationInMinutes": 30 - }, - "type": "Microsoft.DBforPostgreSQL/flexibleServers/maintenanceWindows" - } - }, - "202": {} - } -} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/MaintenanceWindowDelete.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/MaintenanceWindowDelete.json deleted file mode 100644 index 02d91e35a6fc..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/MaintenanceWindowDelete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "maintenanceWindowName": "customerMaintenanceWindow", - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2020-07-01-privatepreview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/MaintenanceWindowGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/MaintenanceWindowGet.json deleted file mode 100644 index ba086b9877e5..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/MaintenanceWindowGet.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "maintenanceWindowName": "customerMaintenanceWindow", - "serverName": "testserver", - "resourceGroupName": "testrg", - "api-version": "2020-07-01-privatepreview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/testserver/maintenanceWindows/customerMaintenanceWindow", - "name": "customerMaintenanceWindow", - "properties": { - "dayOfWeek": 1, - "startHour": 0, - "startMinute": 30, - "durationInMinutes": 30 - }, - "type": "Microsoft.DBforMySQL/flexibleServers/maintenanceWindows" - } - } - } -} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/MaintenanceWindowsListByServer.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/MaintenanceWindowsListByServer.json deleted file mode 100644 index d67701018154..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/MaintenanceWindowsListByServer.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "serverName": "testserver", - "resourceGroupName": "testrg", - "api-version": "2020-02-14-privatepreview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/testserver/maintenanceWindows/customerMaintenanceWindow", - "name": "customerMaintenanceWindow", - "properties": { - "dayOfWeek": 1, - "startHour": 0, - "startMinute": 30, - "durationInMinutes": 30 - }, - "type": "Microsoft.DBforMySQL/flexibleServers/maintenanceWindows" - } - ] - } - } - } -} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ReplicasListByServer.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ReplicasListByServer.json index 3adac848f697..81d22cd3151f 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ReplicasListByServer.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ReplicasListByServer.json @@ -34,7 +34,7 @@ "fullyQualifiedDomainName": "testserver.mysql.database.azure.com", "version": "5.7", "replicationRole": "Replica", - "primaryServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testprimary", + "sourceServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testprimary", "replicaCapacity": 0 } }, @@ -63,7 +63,7 @@ "fullyQualifiedDomainName": "testserver1.mysql.database.azure.com", "version": "5.7", "replicationRole": "Replica", - "primaryServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testprimary", + "sourceServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testprimary", "replicaCapacity": 0 } }, @@ -92,7 +92,7 @@ "fullyQualifiedDomainName": "testserver2.mysql.database.azure.com", "version": "5.7", "replicationRole": "Replica", - "primaryServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testprimary", + "sourceServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/flexibleServers/testprimary", "replicaCapacity": 0 } } diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerCreateReplica.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerCreateReplica.json index 5fd812fe0901..bc1f9f6d98b5 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerCreateReplica.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerCreateReplica.json @@ -32,7 +32,7 @@ "state": "Ready", "fullyQualifiedDomainName": "targetserver.mysql.database.azure.com", "replicationRole": "Replica", - "primaryServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/PrimaryResourceGroup/providers/Microsoft.DBforMySQL/flexibleServers/primaryserver", + "sourceServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/PrimaryResourceGroup/providers/Microsoft.DBforMySQL/flexibleServers/primaryserver", "replicaCapacity": 0 }, "location": "westus", @@ -63,7 +63,7 @@ "state": "Ready", "fullyQualifiedDomainName": "targetserver.mysql.database.azure.com", "replicationRole": "Replica", - "primaryServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/PrimaryResourceGroup/providers/Microsoft.DBforMySQL/flexibleServers/primaryserver", + "sourceServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/PrimaryResourceGroup/providers/Microsoft.DBforMySQL/flexibleServers/primaryserver", "replicaCapacity": 0 }, "location": "westus", diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerGet.json index 26101224c4d2..70ce494f9d78 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerGet.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerGet.json @@ -25,10 +25,22 @@ "fullyQualifiedDomainName": "mysqltestsvc4.mysql.database.azure.com", "earliestRestoreDate": "2020-03-14T18:02:41.577+00:00", "replicationRole": "None", - "primaryServerId": "", + "sourceServerId": "", "replicaCapacity": 5, "publicNetworkAccess": "Enabled", - "standbyCount": 0 + "haEnabled": "Enabled", + "haState": "Healthy", + "availabilityZone": "1", + "standByAvailabilityZone": "2", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0, + "customWindow": "Disabled" + }, + "delegatedSubnetArguments": { + "subnetArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet" + } }, "location": "westus", "tags": { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerGetWithVnet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerGetWithVnet.json index a2fc5d608772..728e6eb631cf 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerGetWithVnet.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerGetWithVnet.json @@ -24,14 +24,12 @@ "state": "Ready", "fullyQualifiedDomainName": "mysqltestsrv.mysql.database.azure.com", "replicationRole": "None", - "primaryServerId": "", + "sourceServerId": "", "replicaCapacity": 5, "publicNetworkAccess": "Enabled", - "standbyCount": 0, - "vnetInjArgs": { - "delegatedSubnetName": "test-subnet", - "delegatedVnetID": "6ed504a3-24b8-4ba8-ac1f-7a1780195437", - "delegatedVnetName": "test-vnet" + "haEnabled": "Disabled", + "delegatedSubnetArguments": { + "subnetArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet" } }, "location": "westus", diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerKeyCreate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerKeyCreate.json new file mode 100644 index 000000000000..fa91152a79d9 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerKeyCreate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "serverName": "testserver", + "keyName": "someVault_someKey_01234567890123456789012345678901", + "api-version": "2020-07-01-privatepreview", + "parameters": { + "properties": { + "serverKeyType": "AzureKeyVault", + "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForMySql/flexibleServers/testserver/keys/someVault_someKey_01234567890123456789012345678901", + "name": "omeVault_someKey_01234567890123456789012345678901", + "type": "Microsoft.DBforMySQL/flexibleServers/keys", + "kind": "azurekeyvault", + "properties": { + "serverKeyType": "AzureKeyVault", + "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901", + "creationDate": "2017-05-01T00:00:00.0Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForMySql/flexibleServers/testserver/keys/someVault_someKey_01234567890123456789012345678901", + "name": "omeVault_someKey_01234567890123456789012345678901", + "type": "Microsoft.DBforMySQL/flexibleServers/keys", + "kind": "azurekeyvault", + "properties": { + "serverKeyType": "AzureKeyVault", + "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901", + "creationDate": "2017-05-01T00:00:00.0Z" + } + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerKeyDelete.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerKeyDelete.json new file mode 100644 index 000000000000..09475f2b43b8 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerKeyDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "serverName": "testserver", + "keyName": "someVault_someKey_01234567890123456789012345678901", + "api-version": "2020-07-01-privatepreview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerKeyGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerKeyGet.json new file mode 100644 index 000000000000..18d96d5f825b --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerKeyGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "serverName": "testserver", + "keyName": "someVault_someKey_01234567890123456789012345678901", + "api-version": "2020-07-01-privatepreview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForMySql/flexibleServers/testserver/keys/someVault_someKey_01234567890123456789012345678901", + "name": "someVault_someKey_01234567890123456789012345678901", + "type": "Microsoft.DBforMySQL/flexibleServers/keys", + "kind": "azurekeyvault", + "properties": { + "serverKeyType": "AzureKeyVault", + "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901", + "creationDate": "2019-12-01T00:00:00.0Z" + } + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerKeysListByServer.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerKeysListByServer.json new file mode 100644 index 000000000000..c54140e20c4f --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerKeysListByServer.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "serverName": "testserver", + "api-version": "2020-07-01-privatepreview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForMySql/flexibleServers/testserver/keys/someVault_someKey_01234567890123456789012345678901", + "name": "someVault_someKey_01234567890123456789012345678901", + "type": "Microsoft.DBforMySQL/flexibleServers/keys", + "kind": "azurekeyvault", + "properties": { + "serverKeyType": "AzureKeyVault", + "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901", + "creationDate": "2019-12-01T00:00:00.0Z" + } + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerUpdate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerUpdate.json index c042adec2a3d..5ce35b2dce59 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerUpdate.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerUpdate.json @@ -29,7 +29,18 @@ "sslEnforcement": "Disabled", "publicNetworkAccess": "Disabled", "state": "Ready", - "fullyQualifiedDomainName": "mysqltestsvc4.mysql.database.azure.com" + "fullyQualifiedDomainName": "mysqltestsvc4.mysql.database.azure.com", + "haEnabled": "Enabled", + "haState": "Healthy", + "availabilityZone": "1", + "standByAvailabilityZone": "2", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0, + "customWindow": "Disabled" + }, + "delegatedSubnetArguments": {} }, "location": "westus", "tags": { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerUpdateWithCustomerMaintenanceWindow.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerUpdateWithCustomerMaintenanceWindow.json new file mode 100644 index 000000000000..3ee6ab2d831d --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerUpdateWithCustomerMaintenanceWindow.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "serverName": "mysqltestsvc4", + "resourceGroupName": "testrg", + "api-version": "2020-07-01-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "maintenanceWindow": { + "customWindow": "Enabled", + "dayOfWeek": 0, + "startHour": 8, + "startMinute": 0 + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D12_v2", + "tier": "GeneralPurpose" + }, + "properties": { + "administratorLogin": "cloudsa", + "storageProfile": { + "storageMB": 128000, + "backupRetentionDays": 7 + }, + "version": "5.7", + "sslEnforcement": "Disabled", + "publicNetworkAccess": "Disabled", + "state": "Ready", + "fullyQualifiedDomainName": "mysqltestsvc4.mysql.database.azure.com", + "haEnabled": "Disabled", + "haState": "NotEnabled", + "availabilityZone": "1", + "standByAvailabilityZone": null, + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 8, + "startMinute": 0, + "customWindow": "Enabled" + }, + "delegatedSubnetArguments": {} + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/flexibleServers/mysqltestsvc4", + "name": "mysqltestsvc4", + "type": "Microsoft.DBforMySQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json index 52e7d53cd3da..6b2d9e2a5270 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json @@ -108,6 +108,9 @@ "x-ms-examples": { "Update a server": { "$ref": "./examples/ServerUpdate.json" + }, + "Update server customer maintenance window": { + "$ref": "./examples/ServerUpdateWithCustomerMaintenanceWindow.json" } }, "description": "Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.", @@ -496,6 +499,205 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers/{serverName}/keys/{keyName}": { + "put": { + "tags": [ + "ServerKeys" + ], + "operationId": "ServerKeys_CreateOrUpdate", + "x-ms-examples": { + "Creates or updates a MySQL Server key": { + "$ref": "./examples/ServerKeyCreate.json" + } + }, + "description": "Creates or updates a MySQL Server key.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/KeyNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested MySQL Server key resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerKey" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerKey" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ServerKey" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "ServerKeys" + ], + "operationId": "ServerKeys_Delete", + "x-ms-examples": { + "Delete the MySQL Server key": { + "$ref": "./examples/ServerKeyDelete.json" + } + }, + "description": "Deletes the MySQL Server key with the given name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/KeyNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "ServerKeys" + ], + "operationId": "ServerKeys_Get", + "x-ms-examples": { + "Get a server key": { + "$ref": "./examples/ServerKeyGet.json" + } + }, + "description": "Gets a server key.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/KeyNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerKey" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers/{serverName}/keys": { + "get": { + "tags": [ + "ServerKeys" + ], + "operationId": "ServerKeys_ListByServer", + "x-ms-examples": { + "List the keys for a server.": { + "$ref": "./examples/ServerKeysListByServer.json" + } + }, + "description": "Gets a list of Server keys.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerKeyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers/{serverName}/firewallRules/{firewallRuleName}": { "put": { "tags": [ @@ -1040,127 +1242,18 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers/{serverName}/maintenanceWindows/{maintenanceWindowName}": { - "put": { - "tags": [ - "MaintenanceWindows" - ], - "operationId": "MaintenanceWindows_CreateOrUpdate", - "x-ms-examples": { - "Create a maintenance window": { - "$ref": "./examples/MaintenanceWindowCreate.json" - } - }, - "description": "Creates a new maintenance window.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/MaintenanceWindowNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MaintenanceWindow" - }, - "description": "The required parameters for creating or updating a customer maintenance window." - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MaintenanceWindow" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/MaintenanceWindow" - } - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "MaintenanceWindows" - ], - "operationId": "MaintenanceWindows_Delete", - "x-ms-examples": { - "Delete a maintenance window": { - "$ref": "./examples/MaintenanceWindowDelete.json" - } - }, - "description": "Deletes a maintenance window.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/MaintenanceWindowNameParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "NoContent" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true - }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySql/locations/{locationName}/capabilities": { "get": { "tags": [ - "MaintenanceWindows" + "LocationBasedCapabilities" ], - "operationId": "MaintenanceWindows_Get", + "operationId": "LocationBasedCapabilities_List", "x-ms-examples": { - "Get a maintenance window": { - "$ref": "./examples/MaintenanceWindowGet.json" + "CapabilitiesList": { + "$ref": "./examples/CapabilitiesByLocationList.json" } }, - "description": "Get the maintenance windows of a given server.", + "description": "Get capabilities at specified location in a given subscription.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" @@ -1169,20 +1262,14 @@ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/MaintenanceWindowNameParameter" + "$ref": "#/parameters/LocationNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/MaintenanceWindow" + "$ref": "#/definitions/CapabilitiesListResult" } }, "default": { @@ -1191,21 +1278,24 @@ "$ref": "#/definitions/CloudError" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers/{serverName}/maintenanceWindows": { - "get": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySql/locations/{locationName}/checkVirtualNetworkSubnetUsage": { + "post": { "tags": [ - "MaintenanceWindows" + "CheckVirtualNetworkSubnetUsage" ], - "operationId": "MaintenanceWindows_ListByServer", + "operationId": "CheckVirtualNetworkSubnetUsage_Execute", "x-ms-examples": { - "List maintenance windows for a server": { - "$ref": "./examples/MaintenanceWindowsListByServer.json" + "CapabilitiesList": { + "$ref": "./examples/CheckVirtualNetworkSubnetUsage.json" } }, - "description": "List all the maintenance windows in a given server.", + "description": "Get virtual network subnet usage for a given vNet resource id.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" @@ -1214,17 +1304,23 @@ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/LocationNameParameter" }, { - "$ref": "#/parameters/ServerNameParameter" + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkSubnetUsageParameter" + }, + "description": "The required parameters for creating or updating a server." } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/MaintenanceWindowListResult" + "$ref": "#/definitions/VirtualNetworkSubnetUsageResult" } }, "default": { @@ -1233,9 +1329,6 @@ "$ref": "#/definitions/CloudError" } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" } } }, @@ -1366,22 +1459,51 @@ "modelAsString": true } }, - "VnetInjArgs": { + "HaEnabled": { + "type": "string", + "description": "Whether or not HA is enabled for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "HaEnabledEnum", + "modelAsString": true + } + }, + "DelegatedSubnetArguments": { "properties": { - "delegatedVnetID": { + "subnetArmResourceId": { "type": "string", - "description": "delegated vNet ID" - }, - "delegatedSubnetName": { + "description": "delegated subnet arm resource id." + } + }, + "description": "Delegated subnet arguments of a server" + }, + "MaintenanceWindow": { + "type": "object", + "description": "Maintenance window of a server.", + "properties": { + "customWindow": { "type": "string", - "description": "delegated subnet name" + "description": "indicates whether custom window is enabled or disabled" }, - "delegatedVnetName": { - "type": "string", - "description": "delegated vNet name" + "startHour": { + "type": "integer", + "format": "int32", + "description": "start hour for maintenance window" + }, + "startMinute": { + "type": "integer", + "format": "int32", + "description": "start minute for maintenance window" + }, + "dayOfWeek": { + "type": "integer", + "format": "int32", + "description": "day of week for maintenance window" } - }, - "description": "Vnet properties of a server" + } }, "StorageProfile": { "properties": { @@ -1435,6 +1557,10 @@ } } }, + "required": [ + "name", + "tier" + ], "description": "Billing information related properties of a server." }, "ServerProperties": { @@ -1507,10 +1633,9 @@ "modelAsString": true } }, - "standbyCount": { - "type": "integer", - "format": "int32", - "description": "stand by count value can be either 0 or 1" + "haEnabled": { + "$ref": "#/definitions/HaEnabled", + "description": "Enable HA or not for a server." }, "fullyQualifiedDomainName": { "type": "string", @@ -1530,11 +1655,6 @@ "type": "string", "description": "The replication role." }, - "primaryServerId": { - "type": "string", - "description": "The primary server id of a replica server.", - "readOnly": true - }, "replicaCapacity": { "type": "integer", "format": "int32", @@ -1545,11 +1665,16 @@ "$ref": "#/definitions/PublicNetworkAccess", "description": "Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'" }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window of a server." + }, "sourceServerId": { "type": "string", - "description": "The source MySQL server name to restore from.", + "description": "The source MySQL server id.", "x-ms-mutability": [ - "create" + "create", + "read" ] }, "restorePointInTime": { @@ -1560,9 +1685,23 @@ "create" ] }, - "vnetInjArgs": { - "$ref": "#/definitions/VnetInjArgs", - "description": "Vnet arguments." + "availabilityZone": { + "type": "string", + "description": "availability Zone information of the server." + }, + "standByAvailabilityZone": { + "type": "string", + "description": "availability Zone information of the server.", + "readOnly": true + }, + "byokEnforcement": { + "type": "string", + "description": "Status showing whether the data encryption is enabled with customer-managed keys.", + "readOnly": true + }, + "delegatedSubnetArguments": { + "$ref": "#/definitions/DelegatedSubnetArguments", + "description": "Delegated subnet arguments." }, "createMode": { "type": "string", @@ -1629,19 +1768,22 @@ "$ref": "#/definitions/SslEnforcement", "description": "Enable ssl enforcement or not when connect to server." }, - "vnetInjArgs": { - "$ref": "#/definitions/VnetInjArgs", - "description": "Vnet arguments." + "delegatedSubnetArguments": { + "$ref": "#/definitions/DelegatedSubnetArguments", + "description": "Delegated subnet arguments." }, - "standbyCount": { - "type": "integer", - "format": "int32", - "description": "stand by count value can be either 0 or 1" + "haEnabled": { + "$ref": "#/definitions/HaEnabled", + "description": "Enable HA or not for a server." }, "publicNetworkAccess": { "$ref": "#/definitions/PublicNetworkAccess", "description": "Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'" }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window of a server." + }, "replicationRole": { "type": "string", "description": "The replication role of the server." @@ -1687,6 +1829,76 @@ }, "description": "A list of servers." }, + "ServerKeyProperties": { + "description": "Properties for a key execution.", + "required": [ + "serverKeyType" + ], + "type": "object", + "properties": { + "serverKeyType": { + "description": "The key type like 'AzureKeyVault'.", + "enum": [ + "AzureKeyVault" + ], + "type": "string", + "x-ms-enum": { + "name": "ServerKeyType", + "modelAsString": true + } + }, + "uri": { + "description": "The URI of the key.", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "description": "The key creation date.", + "type": "string", + "readOnly": true + } + } + }, + "ServerKey": { + "description": "A MySQL Server key.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "kind": { + "description": "Kind of encryption protector used to protect the key.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/ServerKeyProperties", + "description": "Properties of the ServerKey Resource.", + "x-ms-client-flatten": true + } + } + }, + "ServerKeyListResult": { + "description": "A list of MySQL Server keys.", + "type": "object", + "properties": { + "value": { + "description": "A list of MySQL Server keys.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerKey" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, "FirewallRuleProperties": { "properties": { "startIpAddress": { @@ -1890,70 +2102,206 @@ }, "description": "A list of server configurations." }, - "MaintenanceWindowProperties": { + "VirtualNetworkSubnetUsageParameter": { + "type": "object", "properties": { - "dayOfWeek": { + "virtualNetworkArmResourceId": { + "type": "string", + "description": "Virtual network resource id." + } + }, + "description": "Virtual network subnet usage parameter" + }, + "DelegatedSubnetUsage": { + "type": "object", + "properties": { + "subnetName": { + "type": "string", + "readOnly": true, + "description": "name of the subnet" + }, + "usage": { "type": "integer", - "format": "int32", - "description": "The day of week of the maintenance window to start" + "format": "int64", + "readOnly": true, + "description": "Number of used delegated subnets" + } + }, + "description": "Delegated subnet usage data." + }, + "VirtualNetworkSubnetUsageResult": { + "type": "object", + "properties": { + "delegatedSubnetsUsage": { + "description": "A list of delegated subnet usage", + "type": "array", + "items": { + "$ref": "#/definitions/DelegatedSubnetUsage" + }, + "readOnly": true + } + }, + "description": "Virtual network subnet usage data." + }, + "StorageMBCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "storage MB name", + "readOnly": true }, - "durationInMinutes": { + "storageSizeMB": { "type": "integer", - "format": "int32", - "description": "The duration of the maintenance window to run." + "format": "int64", + "description": "storage size in MB", + "readOnly": true + } + }, + "description": "storage size in MB capability" + }, + "VcoreCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "vCore name", + "readOnly": true }, - "startHour": { + "vCores": { "type": "integer", - "format": "int32", - "description": "The starting hour of the maintenance window." + "format": "int64", + "description": "supported vCores", + "readOnly": true }, - "startMinute": { + "supportedIops": { "type": "integer", - "format": "int32", - "description": "The starting minutes of the maintenance window." + "format": "int64", + "description": "supported IOPS", + "readOnly": true + }, + "supportedMemoryPerVcoreMB": { + "type": "integer", + "format": "int64", + "description": "supported memory per vCore in MB", + "readOnly": true } }, - "required": [ - "dayOfWeek", - "startHour", - "startMinute" - ], - "description": "The properties of a server maintenance window." + "description": "Vcores capability" }, - "MaintenanceWindow": { + "ServerVersionCapability": { + "type": "object", "properties": { - "properties": { - "$ref": "#/definitions/MaintenanceWindowProperties", - "x-ms-client-flatten": true, - "description": "The properties of a customer maintenance window." + "name": { + "type": "string", + "description": "server version", + "readOnly": true + }, + "supportedVcores": { + "description": "A list of supported Vcores", + "type": "array", + "items": { + "$ref": "#/definitions/VcoreCapability" + }, + "readOnly": true } }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + "description": "Server version capabilities." + }, + "StorageEditionCapability": { + "properties": { + "name": { + "type": "string", + "description": "storage edition name", + "readOnly": true + }, + "minStorageSize": { + "description": "The minimal supported storage size in MB", + "$ref": "#/definitions/StorageMBCapability", + "readOnly": true + }, + "maxStorageSize": { + "description": "The maximum supported storage size in MB", + "$ref": "#/definitions/StorageMBCapability", + "readOnly": true + }, + "minBackupRetentionDays": { + "type": "integer", + "format": "int64", + "description": "Minimal backup retention days", + "readOnly": true + }, + "maxBackupRetentionDays": { + "type": "integer", + "format": "int64", + "description": "Maximum backup retention days", + "readOnly": true } - ], - "required": [ - "properties" - ], - "description": "Represents a server maintenance window." + }, + "description": "storage edition capability" }, - "MaintenanceWindowListResult": { + "ServerEditionCapability": { + "properties": { + "name": { + "type": "string", + "description": "Server edition name", + "readOnly": true + }, + "supportedStorageEditions": { + "description": "A list of supported storage editions", + "type": "array", + "items": { + "$ref": "#/definitions/StorageEditionCapability" + }, + "readOnly": true + }, + "supportedServerVersions": { + "description": "A list of supported server versions.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerVersionCapability" + }, + "readOnly": true + } + }, + "description": "Server edition capabilities." + }, + "CapabilityProperties": { + "properties": { + "zone": { + "type": "string", + "description": "zone name", + "readOnly": true + }, + "supportedFlexibleServerEditions": { + "description": "A list of supported flexible server editions.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerEditionCapability" + }, + "readOnly": true + } + }, + "description": "Location capabilities." + }, + "CapabilitiesListResult": { "type": "object", "properties": { "value": { + "description": "A list of supported capabilities.", "type": "array", "items": { - "$ref": "#/definitions/MaintenanceWindow" + "$ref": "#/definitions/CapabilityProperties" }, - "description": "The list of server maintenance window." + "readOnly": true }, "nextLink": { - "description": "The link used to get the next page of operations.", - "type": "string" + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true } }, - "description": "A list of maintenance windows for a MySQL server." + "description": "location capability" }, "OperationDisplay": { "properties": { @@ -2107,12 +2455,20 @@ "description": "The name of the server configuration.", "x-ms-parameter-location": "method" }, - "MaintenanceWindowNameParameter": { - "name": "maintenanceWindowName", + "LocationNameParameter": { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the location.", + "x-ms-parameter-location": "method" + }, + "KeyNameParameter": { + "name": "keyName", "in": "path", "required": true, "type": "string", - "description": "The name of the maintenance window.", + "description": "The name of the server key.", "x-ms-parameter-location": "method" } } From ea03cbf2dbf0822389080409e0784ed401baa66d Mon Sep 17 00:00:00 2001 From: Phoenix He Date: Tue, 8 Sep 2020 17:00:43 +0800 Subject: [PATCH 011/164] Add params to sdkautomation (#10723) --- .azure-pipelines/SDKAutomation.yml | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/.azure-pipelines/SDKAutomation.yml b/.azure-pipelines/SDKAutomation.yml index cccf557fcad8..b7caf8aa83e8 100644 --- a/.azure-pipelines/SDKAutomation.yml +++ b/.azure-pipelines/SDKAutomation.yml @@ -20,7 +20,6 @@ jobs: variables: NODE_OPTIONS: '--max-old-space-size=8192' - BLOB_STORAGE_PREFIX: sdkautomation-pipeline SPEC_REPO: $(Build.Repository.Name) PR_NUMBER: $(System.PullRequest.PullRequestNumber) BUILD_ID: $(Build.BuildId) @@ -64,13 +63,16 @@ jobs: displayName: Pull SDK Automation Image - script: | docker run \ + -e BLOB_PROXY_PREFIX \ + -e BLOB_STORAGE_PREFIX \ + -e BLOB_STORAGE_IS_PUBLIC \ + -e BLOB_DOWNLOAD_COMMAND \ -e BLOB_STORAGE_NAME \ -e BLOB_STORAGE_KEY \ -e GITHUB_COMMENT_AUTHOR_NAME \ -e GITHUBAPP_ID \ -e GITHUBAPP_PRIVATE_KEY \ -e NODE_OPTIONS \ - -e BLOB_STORAGE_PREFIX \ -e SPEC_REPO \ -e PR_NUMBER \ -e SDK_REPO_NAME \ @@ -80,6 +82,10 @@ jobs: env: BLOB_STORAGE_NAME: $(blob-storage-name) BLOB_STORAGE_KEY: $(blob-storage-key) + BLOB_STORAGE_PREFIX: $(blob-storage-prefix) + BLOB_PROXY_PREFIX: $(blob-proxy-prefix) + BLOB_STORAGE_IS_PUBLIC: $(blob-is-public) + BLOB_DOWNLOAD_COMMAND: $(blob-download-command) GITHUB_COMMENT_AUTHOR_NAME: $(github-comment-author-name) GITHUBAPP_ID: $(githubapp-id) GITHUBAPP_PRIVATE_KEY: $(githubapp-private-key) From 7b8ab42716cb0028285a5ed79328e6c4fed81e60 Mon Sep 17 00:00:00 2001 From: kangsun-ctrl <69279251+kangsun-ctrl@users.noreply.github.com> Date: Tue, 8 Sep 2020 18:27:03 -0700 Subject: [PATCH 012/164] Add new api version for gallery.json and add sharing profile support (#10466) --- .../AddToSharingProfileInAGallery.json | 68 + .../CreateOrUpdateASimpleGallery.json | 55 + ...eateOrUpdateASimpleGalleryApplication.json | 66 + ...pdateASimpleGalleryApplicationVersion.json | 123 + .../CreateOrUpdateASimpleGalleryImage.json | 75 + ...ateOrUpdateASimpleGalleryImageVersion.json | 221 ++ ...leryImageVersionWithSnapshotsAsSource.json | 226 ++ ...dateASimpleGalleryImageVersionWithVHD.json | 176 + ...pdateASimpleGalleryWithSharingProfile.json | 67 + .../2020-09-30/examples/DeleteAGallery.json | 13 + .../examples/DeleteAGalleryApplication.json | 14 + .../DeleteAGalleryApplicationVersion.json | 15 + .../examples/DeleteAGalleryImage.json | 14 + .../examples/DeleteAGalleryImageVersion.json | 15 + .../2020-09-30/examples/GetAGallery.json | 23 + .../examples/GetAGalleryApplication.json | 24 + .../GetAGalleryApplicationVersion.json | 42 + ...plicationVersionWithReplicationStatus.json | 52 + .../2020-09-30/examples/GetAGalleryImage.json | 28 + .../examples/GetAGalleryImageVersion.json | 69 + ...leryImageVersionWithReplicationStatus.json | 87 + ...leryImageVersionWithSnapshotsAsSource.json | 64 + ...etAGalleryImageVersionWithVhdAsSource.json | 55 + .../GetAGalleryWithSelectPermissions.json | 37 + .../examples/GetASharedGallery.json | 19 + .../examples/GetASharedGalleryImage.json | 30 + .../GetASharedGalleryImageVersion.json | 25 + .../ListGalleriesInAResourceGroup.json | 28 + .../ListGalleriesInASubscription.json | 27 + ...licationVersionsInAGalleryApplication.json | 46 + .../ListGalleryApplicationsInAGallery.json | 28 + ...stGalleryImageVersionsInAGalleryImage.json | 73 + .../examples/ListGalleryImagesInAGallery.json | 32 + .../examples/ListSharedGalleries.json | 23 + .../ListSharedGalleryImageVersions.json | 29 + .../examples/ListSharedGalleryImages.json | 34 + .../ResetSharingProfileInAGallery.json | 23 + .../examples/UpdateASimpleGallery.json | 28 + .../UpdateASimpleGalleryApplication.json | 35 + ...pdateASimpleGalleryApplicationVersion.json | 62 + .../examples/UpdateASimpleGalleryImage.json | 40 + .../UpdateASimpleGalleryImageVersion.json | 87 + .../preview/2020-09-30/gallery.json | 2846 +++++++++++++++++ .../preview/2020-09-30/sharedGallery.json | 786 +++++ .../compute/resource-manager/readme.md | 27 + 45 files changed, 5957 insertions(+) create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/AddToSharingProfileInAGallery.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGallery.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryApplication.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryApplicationVersion.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryImage.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryImageVersion.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryImageVersionWithSnapshotsAsSource.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryImageVersionWithVHD.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryWithSharingProfile.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/DeleteAGallery.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/DeleteAGalleryApplication.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/DeleteAGalleryApplicationVersion.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/DeleteAGalleryImage.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/DeleteAGalleryImageVersion.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGallery.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryApplication.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryApplicationVersion.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryApplicationVersionWithReplicationStatus.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryImage.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryImageVersion.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryImageVersionWithReplicationStatus.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryImageVersionWithSnapshotsAsSource.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryImageVersionWithVhdAsSource.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryWithSelectPermissions.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetASharedGallery.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetASharedGalleryImage.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetASharedGalleryImageVersion.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleriesInAResourceGroup.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleriesInASubscription.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleryApplicationVersionsInAGalleryApplication.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleryApplicationsInAGallery.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleryImageVersionsInAGalleryImage.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleryImagesInAGallery.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListSharedGalleries.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListSharedGalleryImageVersions.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListSharedGalleryImages.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ResetSharingProfileInAGallery.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/UpdateASimpleGallery.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/UpdateASimpleGalleryApplication.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/UpdateASimpleGalleryApplicationVersion.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/UpdateASimpleGalleryImage.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/UpdateASimpleGalleryImageVersion.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/gallery.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/sharedGallery.json diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/AddToSharingProfileInAGallery.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/AddToSharingProfileInAGallery.json new file mode 100644 index 000000000000..2b58d146d876 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/AddToSharingProfileInAGallery.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "sharingUpdate": { + "operationType": "Add", + "groups": [ + { + "type": "Subscriptions", + "ids": [ + "34a4ab42-0d72-47d9-bd1a-aed207386dac", + "380fd389-260b-41aa-bad9-0a83108c370b" + ] + }, + { + "type": "AADTenants", + "ids": [ + "c24c76aa-8897-4027-9b03-8f7928b54ff6" + ] + } + ] + } + }, + "responses": { + "200": { + "body": { + "operationType": "Add", + "groups": [ + { + "type": "Subscriptions", + "ids": [ + "34a4ab42-0d72-47d9-bd1a-aed207386dac", + "380fd389-260b-41aa-bad9-0a83108c370b" + ] + }, + { + "type": "AADTenants", + "ids": [ + "c24c76aa-8897-4027-9b03-8f7928b54ff6" + ] + } + ] + } + }, + "202": { + "body": { + "operationType": "Add", + "groups": [ + { + "type": "Subscriptions", + "ids": [ + "34a4ab42-0d72-47d9-bd1a-aed207386dac", + "380fd389-260b-41aa-bad9-0a83108c370b" + ] + }, + { + "type": "AADTenants", + "ids": [ + "c24c76aa-8897-4027-9b03-8f7928b54ff6" + ] + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGallery.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGallery.json new file mode 100644 index 000000000000..be3c726713ed --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGallery.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "gallery": { + "location": "West US", + "properties": { + "description": "This is the gallery description." + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "201": { + "body": { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "202": { + "body": { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryApplication.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryApplication.json new file mode 100644 index 000000000000..d4f969d2d11e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryApplication.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplication": { + "location": "West US", + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows" + }, + "location": "West US", + "name": "myGalleryApplicationName", + "type": "Microsoft.Compute/galleries", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName" + } + }, + "201": { + "body": { + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows" + }, + "location": "West US", + "name": "myGalleryApplicationName", + "type": "Microsoft.Compute/galleries", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName" + } + }, + "202": { + "body": { + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows" + }, + "location": "West US", + "name": "myGalleryApplicationName", + "type": "Microsoft.Compute/galleries", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryApplicationVersion.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryApplicationVersion.json new file mode 100644 index 000000000000..6942466a93b3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryApplicationVersion.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplicationVersionName": "1.0.0", + "galleryApplicationVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "source": { + "fileName": "package.zip", + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS" + } + ], + "replicaCount": 1, + "endOfLifeDate": "2019-07-01T07:00:00Z", + "storageAccountType": "Standard_LRS" + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "West US", + "name": "1.0.0", + "type": "Microsoft.Compute/galleries/applications/versions", + "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0", + "properties": { + "publishingProfile": { + "source": { + "fileName": "package.zip", + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "enableHealthCheck": false, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS" + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS" + }, + "provisioningState": "Updating" + } + } + }, + "201": { + "body": { + "location": "West US", + "name": "1.0.0", + "type": "Microsoft.Compute/galleries/applications/versions", + "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0", + "properties": { + "publishingProfile": { + "source": { + "fileName": "package.zip", + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "enableHealthCheck": false, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS" + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS" + }, + "provisioningState": "Creating" + } + } + }, + "202": { + "body": { + "location": "West US", + "name": "1.0.0", + "type": "Microsoft.Compute/galleries/applications/versions", + "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0", + "properties": { + "publishingProfile": { + "source": { + "fileName": "package.zip", + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "enableHealthCheck": false, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS" + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS" + }, + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryImage.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryImage.json new file mode 100644 index 000000000000..13f9b61d3641 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryImage.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImage": { + "location": "West US", + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryImageName" + } + }, + "201": { + "body": { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "myGalleryImageName" + } + }, + "202": { + "body": { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryImageName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryImageVersion.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryImageVersion.json new file mode 100644 index 000000000000..a3353dfdd97e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryImageVersion.json @@ -0,0 +1,221 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + } + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS" + } + ] + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + } + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS" + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + } + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS" + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + } + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS" + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryImageVersionWithSnapshotsAsSource.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryImageVersionWithSnapshotsAsSource.json new file mode 100644 index 000000000000..d3e4274210ce --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryImageVersionWithSnapshotsAsSource.json @@ -0,0 +1,226 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet", + "lun": 1 + } + ] + } + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS" + } + ] + }, + "storageProfile": { + "osDiskImage": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{snapshotName}" + }, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{diskSnapshotName}" + }, + "lun": 1, + "hostCaching": "None" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + } + ] + } + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS" + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{osSnapshotName}" + }, + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{diskSnapshotName}" + }, + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + } + ] + } + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS" + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{osSnapshotName}" + }, + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{diskSnapshotName}" + }, + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + } + ] + } + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS" + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{osSnapshotName}" + }, + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{diskSnapshotName}" + }, + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryImageVersionWithVHD.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryImageVersionWithVHD.json new file mode 100644 index 000000000000..e2b1b504c1ff --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryImageVersionWithVHD.json @@ -0,0 +1,176 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "location": "West US", + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet", + "lun": 1 + } + ] + } + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS" + } + ] + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + } + ] + } + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS" + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + } + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "201": { + "body": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + } + ] + } + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS" + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + } + }, + "provisioningState": "Creating" + }, + "location": "West US", + "name": "1.0.0" + } + }, + "202": { + "body": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + } + ] + } + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS" + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + } + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryWithSharingProfile.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryWithSharingProfile.json new file mode 100644 index 000000000000..b9852f7f8548 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/CreateOrUpdateASimpleGalleryWithSharingProfile.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "gallery": { + "location": "West US", + "properties": { + "description": "This is the gallery description.", + "sharingProfile": { + "permissions": "Groups" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating", + "sharingProfile": { + "permissions": "Groups" + } + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "201": { + "body": { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Creating", + "sharingProfile": { + "permissions": "Groups" + } + }, + "location": "West US", + "name": "myGalleryName" + } + }, + "202": { + "body": { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating", + "sharingProfile": { + "permissions": "Groups" + } + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/DeleteAGallery.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/DeleteAGallery.json new file mode 100644 index 000000000000..2abe4517a561 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/DeleteAGallery.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/DeleteAGalleryApplication.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/DeleteAGalleryApplication.json new file mode 100644 index 000000000000..f1014e7b7f78 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/DeleteAGalleryApplication.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/DeleteAGalleryApplicationVersion.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/DeleteAGalleryApplicationVersion.json new file mode 100644 index 000000000000..e4a43f69b126 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/DeleteAGalleryApplicationVersion.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplicationVersionName": "1.0.0" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/DeleteAGalleryImage.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/DeleteAGalleryImage.json new file mode 100644 index 000000000000..6d760641d7b4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/DeleteAGalleryImage.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/DeleteAGalleryImageVersion.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/DeleteAGalleryImageVersion.json new file mode 100644 index 000000000000..76001cffb9b2 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/DeleteAGalleryImageVersion.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGallery.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGallery.json new file mode 100644 index 000000000000..7ef46189bfcc --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGallery.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName" + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryApplication.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryApplication.json new file mode 100644 index 000000000000..37c4d1d42a00 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryApplication.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName" + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows" + }, + "location": "West US", + "name": "myGalleryApplicationName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryApplicationVersion.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryApplicationVersion.json new file mode 100644 index 000000000000..ca16dd2d6f84 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryApplicationVersion.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplicationVersionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "location": "West US", + "name": "1.0.0", + "type": "Microsoft.Compute/galleries/applications/versions", + "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0", + "properties": { + "publishingProfile": { + "source": { + "fileName": "package.zip", + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "enableHealthCheck": false, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS" + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryApplicationVersionWithReplicationStatus.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryApplicationVersionWithReplicationStatus.json new file mode 100644 index 000000000000..e3d246d4bf3e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryApplicationVersionWithReplicationStatus.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplicationVersionName": "1.0.0", + "$expand": "ReplicationStatus" + }, + "responses": { + "200": { + "body": { + "properties": { + "publishingProfile": { + "source": { + "fileName": "package.zip", + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "enableHealthCheck": false, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS" + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS" + }, + "replicationStatus": { + "aggregatedState": "Completed", + "summary": [ + { + "region": "West US", + "state": "Completed", + "details": "", + "progress": 100 + } + ] + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryImage.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryImage.json new file mode 100644 index 000000000000..8e4305e0148c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryImage.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myGalleryImageName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryImageVersion.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryImageVersion.json new file mode 100644 index 000000000000..c65d0cc43058 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryImageVersion.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + } + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_LRS" + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryImageVersionWithReplicationStatus.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryImageVersionWithReplicationStatus.json new file mode 100644 index 000000000000..7462407b0222 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryImageVersionWithReplicationStatus.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "$expand": "ReplicationStatus" + }, + "responses": { + "200": { + "body": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + } + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_LRS" + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "replicationStatus": { + "aggregatedState": "Completed", + "summary": [ + { + "region": "West US", + "state": "Completed", + "details": "", + "progress": 100 + }, + { + "region": "East US", + "state": "Completed", + "details": "", + "progress": 100 + } + ] + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryImageVersionWithSnapshotsAsSource.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryImageVersionWithSnapshotsAsSource.json new file mode 100644 index 000000000000..a0184d882337 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryImageVersionWithSnapshotsAsSource.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + } + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_LRS" + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "osDiskImage": { + "source": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{snapshotName}", + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "source": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/snapshots/{diskSnapshotName}", + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryImageVersionWithVhdAsSource.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryImageVersionWithVhdAsSource.json new file mode 100644 index 000000000000..d92d3c77540d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryImageVersionWithVhdAsSource.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + } + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_LRS" + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Storage/storageAccounts/{storageAccount}", + "uri": "https://gallerysourcencus.blob.core.windows.net/myvhds/Windows-Server-2012-R2-20171216-en.us-128GB.vhd" + } + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryWithSelectPermissions.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryWithSelectPermissions.json new file mode 100644 index 000000000000..b58ca89c0bc1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetAGalleryWithSelectPermissions.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "$select": "Permissions" + }, + "responses": { + "200": { + "body": { + "properties": { + "sharingProfile": { + "permissions": "Groups", + "groups": [ + { + "type": "Subscriptions", + "ids": [ + "34a4ab42-0d72-47d9-bd1a-aed207386dac", + "380fd389-260b-41aa-bad9-0a83108c370b" + ] + }, + { + "type": "AADTenants", + "ids": [ + "c24c76aa-8897-4027-9b03-8f7928b54ff6" + ] + } + ] + } + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetASharedGallery.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetASharedGallery.json new file mode 100644 index 000000000000..9615b8456462 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetASharedGallery.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2020-09-30", + "galleryUniqueName": "galleryUniqueName" + }, + "responses": { + "200": { + "body": { + "location": "myLocation", + "name": "myGalleryName", + "identifier": { + "uniqueId": "/SharedGalleries/galleryUniqueName" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetASharedGalleryImage.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetASharedGalleryImage.json new file mode 100644 index 000000000000..ab78ae46c4f0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetASharedGalleryImage.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2020-09-30", + "galleryUniqueName": "galleryUniqueName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + } + }, + "location": "myLocation", + "name": "myGalleryImageName", + "identifier": { + "uniqueId": "/SharedGalleries/galleryUniqueName/Images/myGalleryImageName" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetASharedGalleryImageVersion.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetASharedGalleryImageVersion.json new file mode 100644 index 000000000000..7e20e0f45d65 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/GetASharedGalleryImageVersion.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2020-09-30", + "galleryUniqueName": "galleryUniqueName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "myGalleryImageVersionName" + }, + "responses": { + "200": { + "body": { + "properties": { + "publishedDate": "2018-03-20T09:12:28Z", + "endOfLifeDate": "2022-03-20T09:12:28Z" + }, + "location": "myLocation", + "name": "myGalleryImageVersionName", + "identifier": { + "uniqueId": "/SharedGalleries/galleryUniqueName/Images/myGalleryImageName/Versions/myGalleryImageVersionName" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleriesInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleriesInAResourceGroup.json new file mode 100644 index 000000000000..756c512dd1fe --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleriesInAResourceGroup.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myGalleryName", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName" + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleriesInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleriesInASubscription.json new file mode 100644 index 000000000000..280325678dd3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleriesInASubscription.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2020-09-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myGalleryName", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName" + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/providers/Microsoft.Compute/galleries?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleryApplicationVersionsInAGalleryApplication.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleryApplicationVersionsInAGalleryApplication.json new file mode 100644 index 000000000000..0899c17bfafe --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleryApplicationVersionsInAGalleryApplication.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "West US", + "name": "1.0.0", + "type": "Microsoft.Compute/galleries/applications/versions", + "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0", + "properties": { + "publishingProfile": { + "source": { + "fileName": "package.zip", + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "enableHealthCheck": false, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS" + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS" + }, + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName/versions?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName/applications/myGalleryApplicationName/versions/myGalleryApplicationVersionName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleryApplicationsInAGallery.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleryApplicationsInAGallery.json new file mode 100644 index 000000000000..d21b58c493ff --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleryApplicationsInAGallery.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows" + }, + "location": "West US", + "name": "myGalleryApplicationName" + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName/applications/myGalleryApplicationName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleryImageVersionsInAGalleryImage.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleryImageVersionsInAGalleryImage.json new file mode 100644 index 000000000000..499ad4e6366f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleryImageVersionsInAGalleryImage.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 0, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet" + }, + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + } + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_LRS" + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "1.0.0" + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/images/myGalleryImageName/versions?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName/images/myGalleryImageName/versions/myGalleryImageVersionName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleryImagesInAGallery.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleryImagesInAGallery.json new file mode 100644 index 000000000000..570fc0e39b6f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListGalleryImagesInAGallery.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Succeeded" + }, + "location": "West US", + "name": "myGalleryImageName" + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/images?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/galleries/myGalleryName/images/myGalleryImageName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListSharedGalleries.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListSharedGalleries.json new file mode 100644 index 000000000000..baebdfed7d93 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListSharedGalleries.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2020-09-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "myLocation", + "name": "galleryUniqueName", + "identifier": { + "uniqueId": "/SharedGalleries/galleryUniqueName" + } + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscriptionId}/providers/Microsoft.Compute/sharedGalleries?$skiptoken={token}/Subscriptions/{subscriptionId}/galleries/galleryUniqueName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListSharedGalleryImageVersions.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListSharedGalleryImageVersions.json new file mode 100644 index 000000000000..95baa0b1144f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListSharedGalleryImageVersions.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2020-09-30", + "galleryUniqueName": "galleryUniqueName", + "galleryImageName": "myGalleryImageName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "publishedDate": "2018-03-20T09:12:28Z", + "endOfLifeDate": "2022-03-20T09:12:28Z" + }, + "location": "myLocation", + "name": "myGalleryImageVersionName", + "identifier": { + "uniqueId": "/SharedGalleries/galleryUniqueName/Images/myGalleryImageName/Versions/myGalleryImageVersionName" + } + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscription-Id}/providers/Microsoft.Compute/sharedGalleries/galleryUniqueName/images/myGalleryImageName/versions?$skiptoken={token}/Subscriptions/{subscription-Id}/galleries/galleryUniqueName/images/myGalleryImageName/versions/myGalleryImageVersionName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListSharedGalleryImages.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListSharedGalleryImages.json new file mode 100644 index 000000000000..47a2b4ac926a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ListSharedGalleryImages.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "myLocation", + "api-version": "2020-09-30", + "galleryUniqueName": "galleryUniqueName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + } + }, + "location": "myLocation", + "name": "myGalleryImageName", + "identifier": { + "uniqueId": "/SharedGalleries/galleryUniqueName/Images/myGalleryImageName" + } + } + ], + "nextLink": "http://svchost:99/subscriptions/{subscription-Id}/providers/Microsoft.Compute/sharedGalleries/galleryUniqueName/images?$skiptoken={token}/Subscriptions/{subscription-Id}/galleries/galleryUniqueName/images/myGalleryImageName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ResetSharingProfileInAGallery.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ResetSharingProfileInAGallery.json new file mode 100644 index 000000000000..98c4a29b2a29 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/ResetSharingProfileInAGallery.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "sharingUpdate": { + "operationType": "Reset" + } + }, + "responses": { + "200": { + "body": { + "operationType": "Reset" + } + }, + "202": { + "body": { + "operationType": "Reset" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/UpdateASimpleGallery.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/UpdateASimpleGallery.json new file mode 100644 index 000000000000..d3618117f15c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/UpdateASimpleGallery.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "gallery": { + "properties": { + "description": "This is the gallery description." + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "This is the gallery description.", + "identifier": { + "uniqueName": "{subscription-id}-MYGALLERYNAME" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/UpdateASimpleGalleryApplication.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/UpdateASimpleGalleryApplication.json new file mode 100644 index 000000000000..0bb889c29a26 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/UpdateASimpleGalleryApplication.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplication": { + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "This is the gallery application description.", + "eula": "This is the gallery application EULA.", + "privacyStatementUri": "myPrivacyStatementUri}", + "releaseNoteUri": "myReleaseNoteUri", + "supportedOSType": "Windows" + }, + "location": "West US", + "name": "myGalleryApplicationName", + "type": "Microsoft.Compute/galleries", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalleryName/applications/myGalleryApplicationName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/UpdateASimpleGalleryApplicationVersion.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/UpdateASimpleGalleryApplicationVersion.json new file mode 100644 index 000000000000..8d473b578024 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/UpdateASimpleGalleryApplicationVersion.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryApplicationName": "myGalleryApplicationName", + "galleryApplicationVersionName": "1.0.0", + "galleryApplicationVersion": { + "properties": { + "publishingProfile": { + "source": { + "fileName": "package.zip", + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS" + } + ], + "replicaCount": 1, + "endOfLifeDate": "2019-07-01T07:00:00Z", + "storageAccountType": "Standard_LRS" + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "West US", + "name": "1.0.0", + "type": "Microsoft.Compute/galleries/applications/versions", + "id": "/subscriptions/01523d7c-60da-455e-adef-521b547922c4/resourceGroups/galleryPsTestRg98/providers/Microsoft.Compute/galleries/galleryPsTestGallery6165/applications/galleryPsTestGalleryApplication7825/versions/1.0.0", + "properties": { + "publishingProfile": { + "source": { + "fileName": "package.zip", + "mediaLink": "https://mystorageaccount.blob.core.windows.net/mycontainer/package.zip?{sasKey}" + }, + "enableHealthCheck": false, + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS" + } + ], + "replicaCount": 1, + "excludeFromLatest": false, + "publishedDate": "2019-06-21T17:13:57.5972568+00:00", + "endOfLifeDate": "2019-07-01T07:00:00+00:00", + "storageAccountType": "Standard_LRS" + }, + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/UpdateASimpleGalleryImage.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/UpdateASimpleGalleryImage.json new file mode 100644 index 000000000000..ebfd473f7e95 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/UpdateASimpleGalleryImage.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImage": { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Windows", + "osState": "Generalized", + "hyperVGeneration": "V1", + "identifier": { + "publisher": "myPublisherName", + "offer": "myOfferName", + "sku": "mySkuName" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myGalleryImageName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/UpdateASimpleGalleryImageVersion.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/UpdateASimpleGalleryImageVersion.json new file mode 100644 index 000000000000..5cf4547abad1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/examples/UpdateASimpleGalleryImageVersion.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-30", + "galleryName": "myGalleryName", + "galleryImageName": "myGalleryImageName", + "galleryImageVersionName": "1.0.0", + "galleryImageVersion": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1 + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS" + } + ] + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "publishingProfile": { + "targetRegions": [ + { + "name": "West US", + "regionalReplicaCount": 1, + "storageAccountType": "Standard_LRS", + "encryption": { + "osDiskImage": { + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + }, + "dataDiskImages": [ + { + "lun": 1, + "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet" + } + ] + } + }, + { + "name": "East US", + "regionalReplicaCount": 2, + "storageAccountType": "Standard_ZRS" + } + ], + "replicaCount": 1, + "publishedDate": "2018-01-01T00:00:00Z", + "storageAccountType": "Standard_LRS" + }, + "storageProfile": { + "source": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}" + }, + "osDiskImage": { + "sizeInGB": 10, + "hostCaching": "ReadOnly" + }, + "dataDiskImages": [ + { + "lun": 1, + "sizeInGB": 10, + "hostCaching": "None" + } + ] + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "1.0.0" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/gallery.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/gallery.json new file mode 100644 index 000000000000..b5e64bcf9dde --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/gallery.json @@ -0,0 +1,2846 @@ +{ + "swagger": "2.0", + "info": { + "title": "SharedImageGalleryServiceClient", + "description": "Shared Image Gallery Service Client.", + "version": "2020-09-30" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}": { + "put": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_CreateOrUpdate", + "description": "Create or update a Shared Image Gallery.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "gallery", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Gallery" + }, + "description": "Parameters supplied to the create or update Shared Image Gallery operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a simple gallery.": { + "$ref": "./examples/CreateOrUpdateASimpleGallery.json" + }, + "Create or update a simple gallery with sharing profile.": { + "$ref": "./examples/CreateOrUpdateASimpleGalleryWithSharingProfile.json" + } + } + }, + "patch": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_Update", + "description": "Update a Shared Image Gallery.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "gallery", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryUpdate" + }, + "description": "Parameters supplied to the update Shared Image Gallery operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a simple gallery.": { + "$ref": "./examples/UpdateASimpleGallery.json" + } + } + }, + "get": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_Get", + "description": "Retrieves information about a Shared Image Gallery.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "The select expression to apply on the operation.", + "enum": [ + "Permissions" + ], + "x-ms-enum": { + "name": "Permissions", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery.": { + "$ref": "./examples/GetAGallery.json" + }, + "Get a gallery with select permissions.": { + "$ref": "./examples/GetAGalleryWithSelectPermissions.json" + } + } + }, + "delete": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_Delete", + "description": "Delete a Shared Image Gallery.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery to be deleted." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "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, + "x-ms-examples": { + "Delete a gallery.": { + "$ref": "./examples/DeleteAGallery.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}": { + "put": { + "tags": [ + "GalleryImages" + ], + "operationId": "GalleryImages_CreateOrUpdate", + "description": "Create or update a gallery image definition.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition is to be created." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "galleryImage", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImage" + }, + "description": "Parameters supplied to the create or update gallery image operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a simple gallery image.": { + "$ref": "./examples/CreateOrUpdateASimpleGalleryImage.json" + } + } + }, + "patch": { + "tags": [ + "GalleryImages" + ], + "operationId": "GalleryImages_Update", + "description": "Update a gallery image definition.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition is to be updated." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "galleryImage", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImageUpdate" + }, + "description": "Parameters supplied to the update gallery image operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a simple gallery image.": { + "$ref": "./examples/UpdateASimpleGalleryImage.json" + } + } + }, + "get": { + "tags": [ + "GalleryImages" + ], + "operationId": "GalleryImages_Get", + "description": "Retrieves information about a gallery image definition.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery from which the Image Definitions are to be retrieved." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition to be retrieved." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery image.": { + "$ref": "./examples/GetAGalleryImage.json" + } + } + }, + "delete": { + "tags": [ + "GalleryImages" + ], + "operationId": "GalleryImages_Delete", + "description": "Delete a gallery image.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition is to be deleted." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition to be deleted." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "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, + "x-ms-examples": { + "Delete a gallery image.": { + "$ref": "./examples/DeleteAGalleryImage.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}": { + "put": { + "tags": [ + "GalleryImageVersions" + ], + "operationId": "GalleryImageVersions_CreateOrUpdate", + "description": "Create or update a gallery image version.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition resides." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition in which the Image Version is to be created." + }, + { + "name": "galleryImageVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "galleryImageVersion", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + }, + "description": "Parameters supplied to the create or update gallery image version operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a simple Gallery Image Version (Managed Image as source).": { + "$ref": "./examples/CreateOrUpdateASimpleGalleryImageVersion.json" + }, + "Create or update a simple Gallery Image Version using snapshots as a source.": { + "$ref": "./examples/CreateOrUpdateASimpleGalleryImageVersionWithSnapshotsAsSource.json" + }, + "Create or update a simple Gallery Image Version using vhd as a source.": { + "$ref": "./examples/CreateOrUpdateASimpleGalleryImageVersionWithVHD.json" + } + } + }, + "patch": { + "tags": [ + "GalleryImageVersions" + ], + "operationId": "GalleryImageVersions_Update", + "description": "Update a gallery image version.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition resides." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition in which the Image Version is to be updated." + }, + { + "name": "galleryImageVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image version to be updated. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "galleryImageVersion", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImageVersionUpdate" + }, + "description": "Parameters supplied to the update gallery image version operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a simple Gallery Image Version (Managed Image as source).": { + "$ref": "./examples/UpdateASimpleGalleryImageVersion.json" + } + } + }, + "get": { + "tags": [ + "GalleryImageVersions" + ], + "operationId": "GalleryImageVersions_Get", + "description": "Retrieves information about a gallery image version.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition resides." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition in which the Image Version resides." + }, + { + "name": "galleryImageVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image version to be retrieved." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "ReplicationStatus" + ], + "x-ms-enum": { + "name": "ReplicationStatusTypes", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery image version.": { + "$ref": "./examples/GetAGalleryImageVersion.json" + }, + "Get a gallery image version with replication status.": { + "$ref": "./examples/GetAGalleryImageVersionWithReplicationStatus.json" + }, + "Get a gallery image version with snapshots as a source.": { + "$ref": "./examples/GetAGalleryImageVersionWithSnapshotsAsSource.json" + }, + "Get a gallery image version with vhd as a source.": { + "$ref": "./examples/GetAGalleryImageVersionWithVhdAsSource.json" + } + } + }, + "delete": { + "tags": [ + "GalleryImageVersions" + ], + "operationId": "GalleryImageVersions_Delete", + "description": "Delete a gallery image version.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition resides." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image definition in which the Image Version resides." + }, + { + "name": "galleryImageVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image version to be deleted." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "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, + "x-ms-examples": { + "Delete a gallery image version.": { + "$ref": "./examples/DeleteAGalleryImageVersion.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}": { + "put": { + "tags": [ + "GalleryApplications" + ], + "operationId": "GalleryApplications_CreateOrUpdate", + "description": "Create or update a gallery Application Definition.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition is to be created." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "galleryApplication", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryApplication" + }, + "description": "Parameters supplied to the create or update gallery Application operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplication" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/GalleryApplication" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/GalleryApplication" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a simple gallery Application.": { + "$ref": "./examples/CreateOrUpdateASimpleGalleryApplication.json" + } + } + }, + "patch": { + "tags": [ + "GalleryApplications" + ], + "operationId": "GalleryApplications_Update", + "description": "Update a gallery Application Definition.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition is to be updated." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "galleryApplication", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryApplicationUpdate" + }, + "description": "Parameters supplied to the update gallery Application operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplication" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a simple gallery Application.": { + "$ref": "./examples/UpdateASimpleGalleryApplication.json" + } + } + }, + "get": { + "tags": [ + "GalleryApplications" + ], + "operationId": "GalleryApplications_Get", + "description": "Retrieves information about a gallery Application Definition.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery from which the Application Definitions are to be retrieved." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition to be retrieved." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplication" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery Application.": { + "$ref": "./examples/GetAGalleryApplication.json" + } + } + }, + "delete": { + "tags": [ + "GalleryApplications" + ], + "operationId": "GalleryApplications_Delete", + "description": "Delete a gallery Application.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition is to be deleted." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition to be deleted." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "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, + "x-ms-examples": { + "Delete a gallery Application.": { + "$ref": "./examples/DeleteAGalleryApplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}": { + "put": { + "tags": [ + "GalleryApplicationVersions" + ], + "operationId": "GalleryApplicationVersions_CreateOrUpdate", + "description": "Create or update a gallery Application Version.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition resides." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition in which the Application Version is to be created." + }, + { + "name": "galleryApplicationVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "galleryApplicationVersion", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryApplicationVersion" + }, + "description": "Parameters supplied to the create or update gallery Application Version operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplicationVersion" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/GalleryApplicationVersion" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/GalleryApplicationVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a simple gallery Application Version.": { + "$ref": "./examples/CreateOrUpdateASimpleGalleryApplicationVersion.json" + } + } + }, + "patch": { + "tags": [ + "GalleryApplicationVersions" + ], + "operationId": "GalleryApplicationVersions_Update", + "description": "Update a gallery Application Version.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition resides." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition in which the Application Version is to be updated." + }, + { + "name": "galleryApplicationVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Version to be updated. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "galleryApplicationVersion", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryApplicationVersionUpdate" + }, + "description": "Parameters supplied to the update gallery Application Version operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplicationVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a simple gallery Application Version.": { + "$ref": "./examples/UpdateASimpleGalleryApplicationVersion.json" + } + } + }, + "get": { + "tags": [ + "GalleryApplicationVersions" + ], + "operationId": "GalleryApplicationVersions_Get", + "description": "Retrieves information about a gallery Application Version.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition resides." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition in which the Application Version resides." + }, + { + "name": "galleryApplicationVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Version to be retrieved." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "ReplicationStatus" + ], + "x-ms-enum": { + "name": "ReplicationStatusTypes", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplicationVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery Application Version.": { + "$ref": "./examples/GetAGalleryApplicationVersion.json" + }, + "Get a gallery Application Version with replication status.": { + "$ref": "./examples/GetAGalleryApplicationVersionWithReplicationStatus.json" + } + } + }, + "delete": { + "tags": [ + "GalleryApplicationVersions" + ], + "operationId": "GalleryApplicationVersions_Delete", + "description": "Delete a gallery Application Version.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition resides." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Definition in which the Application Version resides." + }, + { + "name": "galleryApplicationVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery Application Version to be deleted." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "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, + "x-ms-examples": { + "Delete a gallery Application Version.": { + "$ref": "./examples/DeleteAGalleryApplicationVersion.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries": { + "get": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_ListByResourceGroup", + "description": "List galleries under a resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List galleries in a resource group.": { + "$ref": "./examples/ListGalleriesInAResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/galleries": { + "get": { + "tags": [ + "Galleries" + ], + "operationId": "Galleries_List", + "description": "List galleries under a subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List galleries in a subscription.": { + "$ref": "./examples/ListGalleriesInASubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images": { + "get": { + "tags": [ + "GalleryImages" + ], + "operationId": "GalleryImages_ListByGallery", + "description": "List gallery image definitions in a gallery.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery from which Image Definitions are to be listed." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImageList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List gallery images in a gallery.": { + "$ref": "./examples/ListGalleryImagesInAGallery.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions": { + "get": { + "tags": [ + "GalleryImageVersions" + ], + "operationId": "GalleryImageVersions_ListByGalleryImage", + "description": "List gallery image versions in a gallery image definition.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery in which the Image Definition resides." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery Image Definition from which the Image Versions are to be listed." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryImageVersionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List gallery image versions in a gallery image definition.": { + "$ref": "./examples/ListGalleryImageVersionsInAGalleryImage.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications": { + "get": { + "tags": [ + "GalleryApplications" + ], + "operationId": "GalleryApplications_ListByGallery", + "description": "List gallery Application Definitions in a gallery.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery from which Application Definitions are to be listed." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplicationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List gallery Applications in a gallery.": { + "$ref": "./examples/ListGalleryApplicationsInAGallery.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions": { + "get": { + "tags": [ + "GalleryApplicationVersions" + ], + "operationId": "GalleryApplicationVersions_ListByGalleryApplication", + "description": "List gallery Application Versions in a gallery Application Definition.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery in which the Application Definition resides." + }, + { + "name": "galleryApplicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Application Gallery Application Definition from which the Application Versions are to be listed." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GalleryApplicationVersionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List gallery Application Versions in a gallery Application Definition.": { + "$ref": "./examples/ListGalleryApplicationVersionsInAGalleryApplication.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/share": { + "post": { + "tags": [ + "GallerySharingUpdate" + ], + "operationId": "GallerySharingProfile_Update", + "description": "Update sharing profile of a gallery.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Image Gallery." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "sharingUpdate", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SharingUpdate" + }, + "description": "Parameters supplied to the update gallery sharing profile." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SharingUpdate" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/SharingUpdate" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Add sharing id to the sharing profile of a gallery.": { + "$ref": "./examples/AddToSharingProfileInAGallery.json" + }, + "reset sharing profile of a gallery.": { + "$ref": "./examples/ResetSharingProfileInAGallery.json" + } + } + } + } + }, + "definitions": { + "Gallery": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the Shared Image Gallery that you want to create or update." + }, + "GalleryUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResourceDefinition" + } + ], + "description": "Specifies information about the Shared Image Gallery that you want to update." + }, + "GalleryProperties": { + "properties": { + "description": { + "type": "string", + "description": "The description of this Shared Image Gallery resource. This property is updatable." + }, + "identifier": { + "$ref": "#/definitions/GalleryIdentifier" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "title": "The current state of the gallery.", + "description": "The provisioning state, which only appears in the response.", + "enum": [ + "Creating", + "Updating", + "Failed", + "Succeeded", + "Deleting", + "Migrating" + ] + }, + "sharingProfile": { + "$ref": "#/definitions/SharingProfile" + } + }, + "description": "Describes the properties of a Shared Image Gallery." + }, + "GalleryIdentifier": { + "properties": { + "uniqueName": { + "readOnly": true, + "type": "string", + "description": "The unique name of the Shared Image Gallery. This name is generated automatically by Azure." + } + }, + "description": "Describes the gallery unique name." + }, + "SharingProfile": { + "description": "Profile for gallery sharing to subscription or tenant", + "properties": { + "permissions": { + "type": "string", + "description": "This property allows you to specify the permission of sharing gallery.

Possible values are:

**Private**

**Groups**", + "enum": [ + "Private", + "Groups" + ], + "x-ms-enum": { + "name": "GallerySharingPermissionTypes", + "modelAsString": true + } + }, + "groups": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SharingProfileGroup" + }, + "description": "A list of sharing profile groups." + } + } + }, + "SharingProfileGroup": { + "description": "Group of the gallery sharing profile", + "properties": { + "type": { + "type": "string", + "description": "This property allows you to specify the type of sharing group.

Possible values are:

**Subscriptions**

**AADTenants**", + "enum": [ + "Subscriptions", + "AADTenants" + ], + "x-ms-enum": { + "name": "SharingProfileGroupTypes", + "modelAsString": true + } + }, + "ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of subscription/tenant ids the gallery is aimed to be shared to." + } + } + }, + "GalleryApplication": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryApplicationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the gallery Application Definition that you want to create or update." + }, + "GalleryApplicationUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryApplicationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResourceDefinition" + } + ], + "description": "Specifies information about the gallery Application Definition that you want to update." + }, + "GalleryApplicationProperties": { + "properties": { + "description": { + "type": "string", + "description": "The description of this gallery Application Definition resource. This property is updatable." + }, + "eula": { + "type": "string", + "description": "The Eula agreement for the gallery Application Definition." + }, + "privacyStatementUri": { + "type": "string", + "description": "The privacy statement uri." + }, + "releaseNoteUri": { + "type": "string", + "description": "The release note uri." + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "supportedOSType": { + "type": "string", + "description": "This property allows you to specify the supported type of the OS that application is built for.

Possible values are:

**Windows**

**Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + } + }, + "required": [ + "supportedOSType" + ], + "description": "Describes the properties of a gallery Application Definition." + }, + "GalleryApplicationVersion": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryApplicationVersionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the gallery Application Version that you want to create or update." + }, + "GalleryApplicationVersionUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryApplicationVersionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResourceDefinition" + } + ], + "description": "Specifies information about the gallery Application Version that you want to update." + }, + "GalleryApplicationVersionProperties": { + "properties": { + "publishingProfile": { + "$ref": "#/definitions/GalleryApplicationVersionPublishingProfile" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "title": "The current state of the gallery Application Version.", + "description": "The provisioning state, which only appears in the response.", + "enum": [ + "Creating", + "Updating", + "Failed", + "Succeeded", + "Deleting", + "Migrating" + ] + }, + "replicationStatus": { + "readOnly": true, + "$ref": "#/definitions/ReplicationStatus" + } + }, + "required": [ + "publishingProfile" + ], + "description": "Describes the properties of a gallery image version." + }, + "GalleryApplicationVersionPublishingProfile": { + "properties": { + "source": { + "$ref": "#/definitions/UserArtifactSource" + }, + "contentType": { + "type": "string", + "description": "Optional. May be used to help process this file. The type of file contained in the source, e.g. zip, json, etc." + }, + "enableHealthCheck": { + "type": "boolean", + "description": "Optional. Whether or not this application reports health." + } + }, + "allOf": [ + { + "$ref": "#/definitions/GalleryArtifactPublishingProfileBase" + } + ], + "required": [ + "source" + ], + "description": "The publishing profile of a gallery image version." + }, + "UserArtifactSource": { + "properties": { + "fileName": { + "type": "string", + "description": "Required. The fileName of the artifact." + }, + "mediaLink": { + "type": "string", + "description": "Required. The mediaLink of the artifact, must be a readable storage blob." + } + }, + "required": [ + "fileName", + "mediaLink" + ], + "description": "The source image from which the Image Version is going to be created." + }, + "GalleryImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the gallery image definition that you want to create or update." + }, + "GalleryImageUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResourceDefinition" + } + ], + "description": "Specifies information about the gallery image definition that you want to update." + }, + "GalleryImageProperties": { + "properties": { + "description": { + "type": "string", + "description": "The description of this gallery image definition resource. This property is updatable." + }, + "eula": { + "type": "string", + "description": "The Eula agreement for the gallery image definition." + }, + "privacyStatementUri": { + "type": "string", + "description": "The privacy statement uri." + }, + "releaseNoteUri": { + "type": "string", + "description": "The release note uri." + }, + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image.

Possible values are:

**Windows**

**Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "osState": { + "type": "string", + "description": "This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.", + "enum": [ + "Generalized", + "Specialized" + ], + "x-ms-enum": { + "name": "OperatingSystemStateTypes", + "modelAsString": false + } + }, + "hyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only.", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true + } + }, + "features": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryImageFeature" + }, + "description": "A list of gallery image features." + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "identifier": { + "$ref": "#/definitions/GalleryImageIdentifier" + }, + "recommended": { + "$ref": "#/definitions/RecommendedMachineConfiguration" + }, + "disallowed": { + "$ref": "#/definitions/Disallowed" + }, + "purchasePlan": { + "$ref": "#/definitions/ImagePurchasePlan" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "title": "The current state of the gallery image definition.", + "description": "The provisioning state, which only appears in the response.", + "enum": [ + "Creating", + "Updating", + "Failed", + "Succeeded", + "Deleting", + "Migrating" + ] + } + }, + "required": [ + "osType", + "osState", + "identifier" + ], + "description": "Describes the properties of a gallery image definition." + }, + "GalleryImageFeature": { + "properties": { + "name": { + "type": "string", + "description": "The name of the gallery image feature." + }, + "value": { + "type": "string", + "description": "The value of the gallery image feature." + } + }, + "description": "A feature for gallery image." + }, + "GalleryImageIdentifier": { + "properties": { + "publisher": { + "type": "string", + "description": "The name of the gallery image definition publisher." + }, + "offer": { + "type": "string", + "description": "The name of the gallery image definition offer." + }, + "sku": { + "type": "string", + "description": "The name of the gallery image definition SKU." + } + }, + "required": [ + "publisher", + "offer", + "sku" + ], + "description": "This is the gallery image definition identifier." + }, + "RecommendedMachineConfiguration": { + "properties": { + "vCPUs": { + "$ref": "#/definitions/ResourceRange" + }, + "memory": { + "$ref": "#/definitions/ResourceRange" + } + }, + "description": "The properties describe the recommended machine configuration for this Image Definition. These properties are updatable." + }, + "ResourceRange": { + "properties": { + "min": { + "type": "integer", + "format": "int32", + "description": "The minimum number of the resource." + }, + "max": { + "type": "integer", + "format": "int32", + "description": "The maximum number of the resource." + } + }, + "description": "Describes the resource range." + }, + "Disallowed": { + "properties": { + "diskTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of disk types." + } + }, + "description": "Describes the disallowed disk types." + }, + "ImagePurchasePlan": { + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "product": { + "type": "string", + "description": "The product ID." + } + }, + "description": "Describes the gallery image definition purchase plan. This is used by marketplace images." + }, + "GalleryImageVersion": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryImageVersionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the gallery image version that you want to create or update." + }, + "GalleryImageVersionUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryImageVersionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResourceDefinition" + } + ], + "description": "Specifies information about the gallery image version that you want to update." + }, + "GalleryImageVersionProperties": { + "properties": { + "publishingProfile": { + "$ref": "#/definitions/GalleryImageVersionPublishingProfile" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "title": "The current state of the gallery image version.", + "description": "The provisioning state, which only appears in the response.", + "enum": [ + "Creating", + "Updating", + "Failed", + "Succeeded", + "Deleting", + "Migrating" + ] + }, + "storageProfile": { + "$ref": "#/definitions/GalleryImageVersionStorageProfile" + }, + "replicationStatus": { + "readOnly": true, + "$ref": "#/definitions/ReplicationStatus" + } + }, + "required": [ + "storageProfile" + ], + "description": "Describes the properties of a gallery image version." + }, + "GalleryArtifactPublishingProfileBase": { + "properties": { + "targetRegions": { + "type": "array", + "items": { + "$ref": "#/definitions/TargetRegion" + }, + "description": "The target regions where the Image Version is going to be replicated to. This property is updatable." + }, + "replicaCount": { + "type": "integer", + "format": "int32", + "description": "The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable." + }, + "excludeFromLatest": { + "type": "boolean", + "description": "If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version." + }, + "publishedDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The timestamp for when the gallery image version is published." + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable." + }, + "storageAccountType": { + "type": "string", + "description": "Specifies the storage account type to be used to store the image. This property is not updatable.", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": true + } + } + }, + "description": "Describes the basic gallery artifact publishing profile." + }, + "TargetRegion": { + "properties": { + "name": { + "type": "string", + "description": "The name of the region." + }, + "regionalReplicaCount": { + "type": "integer", + "format": "int32", + "description": "The number of replicas of the Image Version to be created per region. This property is updatable." + }, + "storageAccountType": { + "type": "string", + "description": "Specifies the storage account type to be used to store the image. This property is not updatable.", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": true + } + }, + "encryption": { + "$ref": "#/definitions/EncryptionImages" + } + }, + "required": [ + "name" + ], + "description": "Describes the target region information." + }, + "EncryptionImages": { + "properties": { + "osDiskImage": { + "$ref": "#/definitions/OSDiskImageEncryption" + }, + "dataDiskImages": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDiskImageEncryption" + }, + "description": "A list of encryption specifications for data disk images." + } + }, + "description": "Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact." + }, + "OSDiskImageEncryption": { + "allOf": [ + { + "$ref": "#/definitions/DiskImageEncryption" + } + ], + "description": "Contains encryption settings for an OS disk image." + }, + "DataDiskImageEncryption": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine." + } + }, + "allOf": [ + { + "$ref": "#/definitions/DiskImageEncryption" + } + ], + "required": [ + "lun" + ], + "description": "Contains encryption settings for a data disk image." + }, + "DiskImageEncryption": { + "properties": { + "diskEncryptionSetId": { + "type": "string", + "description": "A relative URI containing the resource ID of the disk encryption set." + } + }, + "description": "This is the disk image encryption base class." + }, + "GalleryArtifactSource": { + "properties": { + "managedImage": { + "$ref": "#/definitions/ManagedArtifact" + } + }, + "required": [ + "managedImage" + ], + "description": "The source image from which the Image Version is going to be created." + }, + "ManagedArtifact": { + "properties": { + "id": { + "type": "string", + "description": "The managed artifact id." + } + }, + "required": [ + "id" + ], + "description": "The managed artifact." + }, + "GalleryImageVersionPublishingProfile": { + "allOf": [ + { + "$ref": "#/definitions/GalleryArtifactPublishingProfileBase" + } + ], + "description": "The publishing profile of a gallery image Version." + }, + "GalleryImageVersionStorageProfile": { + "properties": { + "source": { + "$ref": "#/definitions/GalleryArtifactVersionSource" + }, + "osDiskImage": { + "$ref": "#/definitions/GalleryOSDiskImage" + }, + "dataDiskImages": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryDataDiskImage" + }, + "description": "A list of data disk images." + } + }, + "description": "This is the storage profile of a Gallery Image Version." + }, + "GalleryArtifactVersionSource": { + "properties": { + "id": { + "type": "string", + "description": "The id of the gallery artifact version source. Can specify a disk uri, snapshot uri, user image or storage account resource." + }, + "uri": { + "type": "string", + "description": "The uri of the gallery artifact version source. Currently used to specify vhd/blob source." + } + }, + "description": "The gallery artifact version source." + }, + "GalleryOSDiskImage": { + "allOf": [ + { + "$ref": "#/definitions/GalleryDiskImage" + } + ], + "description": "This is the OS disk image." + }, + "GalleryDataDiskImage": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine." + } + }, + "allOf": [ + { + "$ref": "#/definitions/GalleryDiskImage" + } + ], + "required": [ + "lun" + ], + "description": "This is the data disk image." + }, + "GalleryDiskImage": { + "properties": { + "sizeInGB": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "This property indicates the size of the VHD to be created." + }, + "hostCaching": { + "type": "string", + "description": "The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "HostCaching", + "modelAsString": false + } + }, + "source": { + "$ref": "#/definitions/GalleryArtifactVersionSource" + } + }, + "description": "This is the disk image base class." + }, + "ReplicationStatus": { + "properties": { + "aggregatedState": { + "readOnly": true, + "type": "string", + "description": "This is the aggregated replication status based on all the regional replication status flags.", + "enum": [ + "Unknown", + "InProgress", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "AggregatedReplicationState", + "modelAsString": true + } + }, + "summary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RegionalReplicationStatus" + }, + "description": "This is a summary of replication status for each region." + } + }, + "description": "This is the replication status of the gallery image version." + }, + "RegionalReplicationStatus": { + "properties": { + "region": { + "readOnly": true, + "type": "string", + "description": "The region to which the gallery image version is being replicated to." + }, + "state": { + "readOnly": true, + "type": "string", + "description": "This is the regional replication state.", + "enum": [ + "Unknown", + "Replicating", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "ReplicationState", + "modelAsString": true + } + }, + "details": { + "readOnly": true, + "type": "string", + "description": "The details of the replication status." + }, + "progress": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "It indicates progress of the replication job." + } + }, + "description": "This is the regional replication status." + }, + "GalleryList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Gallery" + }, + "description": "A list of galleries." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of galleries. Call ListNext() with this to fetch the next page of galleries." + } + }, + "required": [ + "value" + ], + "description": "The List Galleries operation response." + }, + "GalleryImageList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryImage" + }, + "description": "A list of Shared Image Gallery images." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Image Definitions in the Shared Image Gallery. Call ListNext() with this to fetch the next page of gallery image definitions." + } + }, + "required": [ + "value" + ], + "description": "The List Gallery Images operation response." + }, + "GalleryImageVersionList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryImageVersion" + }, + "description": "A list of gallery image versions." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of gallery image versions. Call ListNext() with this to fetch the next page of gallery image versions." + } + }, + "required": [ + "value" + ], + "description": "The List Gallery Image version operation response." + }, + "GalleryApplicationList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryApplication" + }, + "description": "A list of Gallery Applications." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Application Definitions in the Application Gallery. Call ListNext() with this to fetch the next page of gallery Application Definitions." + } + }, + "required": [ + "value" + ], + "description": "The List Gallery Applications operation response." + }, + "GalleryApplicationVersionList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryApplicationVersion" + }, + "description": "A list of gallery Application Versions." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of gallery Application Versions. Call ListNext() with this to fetch the next page of gallery Application Versions." + } + }, + "required": [ + "value" + ], + "description": "The List Gallery Application version operation response." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/ApiError" + } + }, + "description": "An error response from the Compute service." + }, + "ApiError": { + "properties": { + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiErrorBase" + }, + "description": "The Api error details" + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "The Api inner error" + }, + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error." + }, + "ApiErrorBase": { + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error base." + }, + "InnerError": { + "properties": { + "exceptiontype": { + "type": "string", + "description": "The exception type." + }, + "errordetail": { + "type": "string", + "description": "The internal error message or exception dump." + } + }, + "description": "Inner error details." + }, + "Resource": { + "description": "The Resource model definition.", + "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" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "UpdateResourceDefinition": { + "description": "The Update Resource model definition.", + "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" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "x-ms-azure-resource": true + }, + "SharingUpdate": { + "description": "Specifies information about the gallery sharing profile update.", + "properties": { + "operationType": { + "type": "string", + "description": "This property allows you to specify the operation type of gallery sharing update.

Possible values are:

**Add**

**Remove**

**Reset**", + "enum": [ + "Add", + "Remove", + "Reset" + ], + "x-ms-enum": { + "name": "SharingUpdateOperationTypes", + "modelAsString": true + } + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/definitions/SharingProfileGroup" + }, + "description": "A list of sharing profile groups." + } + }, + "required": [ + "operationType" + ], + "x-ms-azure-resource": true + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the resource group." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/sharedGallery.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/sharedGallery.json new file mode 100644 index 000000000000..c3d8a76c77d1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2020-09-30/sharedGallery.json @@ -0,0 +1,786 @@ +{ + "swagger": "2.0", + "info": { + "title": "SharedGalleryServiceClient", + "description": "Shared Gallery Service Client.", + "version": "2020-09-30" + }, + "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}/providers/Microsoft.Compute/locations/{location}/sharedGalleries": { + "get": { + "tags": [ + "SharedGalleries" + ], + "operationId": "SharedGalleries_List", + "description": "List shared galleries by subscription id or tenant id.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationNameParamter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "sharedTo", + "in": "query", + "required": false, + "type": "string", + "description": "The query parameter to decide what shared galleries to fetch when doing listing operations.", + "enum": [ + "tenant" + ], + "x-ms-enum": { + "name": "SharedToValues", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SharedGalleryList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery.": { + "$ref": "./examples/ListSharedGalleries.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images": { + "get": { + "tags": [ + "SharedGalleryImages" + ], + "operationId": "SharedGalleryImages_List", + "description": "List shared gallery images by subscription id or tenant id.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationNameParamter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "galleryUniqueName", + "in": "path", + "required": true, + "type": "string", + "description": "The unique name of the Shared Gallery." + }, + { + "name": "sharedTo", + "in": "query", + "required": false, + "type": "string", + "description": "The query parameter to decide what shared galleries to fetch when doing listing operations.", + "enum": [ + "tenant" + ], + "x-ms-enum": { + "name": "SharedToValues", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SharedGalleryImageList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery.": { + "$ref": "./examples/ListSharedGalleryImages.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}/versions": { + "get": { + "tags": [ + "SharedGalleryImageVersions" + ], + "operationId": "SharedGalleryImageVersions_List", + "description": "List shared gallery image versions by subscription id or tenant id.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationNameParamter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "galleryUniqueName", + "in": "path", + "required": true, + "type": "string", + "description": "The unique name of the Shared Gallery." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Gallery Image Definition from which the Image Versions are to be listed." + }, + { + "name": "sharedTo", + "in": "query", + "required": false, + "type": "string", + "description": "The query parameter to decide what shared galleries to fetch when doing listing operations.", + "enum": [ + "tenant" + ], + "x-ms-enum": { + "name": "SharedToValues", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SharedGalleryImageVersionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery.": { + "$ref": "./examples/ListSharedGalleryImageVersions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}": { + "get": { + "tags": [ + "SharedGalleries" + ], + "operationId": "SharedGalleries_Get", + "description": "Get a shared gallery by subscription id or tenant id.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationNameParamter" + }, + { + "name": "galleryUniqueName", + "in": "path", + "required": true, + "type": "string", + "description": "The unique name of the Shared Gallery." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SharedGallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery.": { + "$ref": "./examples/GetASharedGallery.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}": { + "get": { + "tags": [ + "SharedGalleryImages" + ], + "operationId": "SharedGalleryImages_Get", + "description": "Get a shared gallery image by subscription id or tenant id.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationNameParamter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "galleryUniqueName", + "in": "path", + "required": true, + "type": "string", + "description": "The unique name of the Shared Gallery." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Gallery Image Definition from which the Image Versions are to be listed." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SharedGalleryImage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery.": { + "$ref": "./examples/GetASharedGalleryImage.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}/versions/{galleryImageVersionName}": { + "get": { + "tags": [ + "SharedGalleryImageVersions" + ], + "operationId": "SharedGalleryImageVersions_Get", + "description": "Get a shared gallery image version by subscription id or tenant id.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationNameParamter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "galleryUniqueName", + "in": "path", + "required": true, + "type": "string", + "description": "The unique name of the Shared Gallery." + }, + { + "name": "galleryImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Shared Gallery Image Definition from which the Image Versions are to be listed." + }, + { + "name": "galleryImageVersionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SharedGalleryImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a gallery.": { + "$ref": "./examples/GetASharedGalleryImageVersion.json" + } + } + } + } + }, + "definitions": { + "PirResource": { + "description": "The Resource model definition.", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "location": { + "readOnly": true, + "type": "string", + "description": "Resource location" + } + } + }, + "PirSharedGalleryResource": { + "properties": { + "identifier": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharedGalleryIdentifier" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PirResource" + } + ], + "description": "Base information about the shared gallery resource in pir." + }, + "SharedGalleryIdentifier": { + "properties": { + "uniqueId": { + "type": "string", + "description": "The unique id of this shared gallery." + } + }, + "description": "The identifier information of shared gallery." + }, + "SharedGalleryList": { + "description": "The List Shared Galleries operation response.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SharedGallery" + }, + "description": "A list of shared galleries." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of shared galleries. Call ListNext() with this to fetch the next page of shared galleries." + } + }, + "required": [ + "value" + ] + }, + "SharedGallery": { + "properties": {}, + "allOf": [ + { + "$ref": "#/definitions/PirSharedGalleryResource" + } + ], + "description": "Specifies information about the Shared Gallery that you want to create or update." + }, + "SharedGalleryImageList": { + "description": "The List Shared Gallery Images operation response.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SharedGalleryImage" + }, + "description": "A list of shared gallery images." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of shared gallery images. Call ListNext() with this to fetch the next page of shared gallery images." + } + }, + "required": [ + "value" + ] + }, + "SharedGalleryImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharedGalleryImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PirSharedGalleryResource" + } + ], + "description": "Specifies information about the gallery image definition that you want to create or update." + }, + "SharedGalleryImageProperties": { + "properties": { + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image.

Possible values are:

**Windows**

**Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "osState": { + "type": "string", + "description": "This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'.", + "enum": [ + "Generalized", + "Specialized" + ], + "x-ms-enum": { + "name": "OperatingSystemStateTypes", + "modelAsString": false + } + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "identifier": { + "$ref": "#/definitions/GalleryImageIdentifier" + }, + "recommended": { + "$ref": "#/definitions/RecommendedMachineConfiguration" + }, + "disallowed": { + "$ref": "#/definitions/Disallowed" + }, + "hyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only.", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": false + } + }, + "features": { + "type": "array", + "items": { + "$ref": "#/definitions/GalleryImageFeature" + }, + "description": "A list of gallery image features." + }, + "purchasePlan": { + "$ref": "#/definitions/ImagePurchasePlan" + } + }, + "required": [ + "osType", + "osState", + "identifier" + ], + "description": "Describes the properties of a gallery image definition." + }, + "GalleryImageFeature": { + "properties": { + "name": { + "type": "string", + "description": "The name of the gallery image feature." + }, + "value": { + "type": "string", + "description": "The value of the gallery image feature." + } + }, + "description": "A feature for gallery image." + }, + "GalleryImageIdentifier": { + "properties": { + "publisher": { + "type": "string", + "description": "The name of the gallery image definition publisher." + }, + "offer": { + "type": "string", + "description": "The name of the gallery image definition offer." + }, + "sku": { + "type": "string", + "description": "The name of the gallery image definition SKU." + } + }, + "required": [ + "publisher", + "offer", + "sku" + ], + "description": "This is the gallery image definition identifier." + }, + "RecommendedMachineConfiguration": { + "properties": { + "vCPUs": { + "$ref": "#/definitions/ResourceRange" + }, + "memory": { + "$ref": "#/definitions/ResourceRange" + } + }, + "description": "The properties describe the recommended machine configuration for this Image Definition. These properties are updatable." + }, + "ResourceRange": { + "properties": { + "min": { + "type": "integer", + "format": "int32", + "description": "The minimum number of the resource." + }, + "max": { + "type": "integer", + "format": "int32", + "description": "The maximum number of the resource." + } + }, + "description": "Describes the resource range." + }, + "Disallowed": { + "properties": { + "diskTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of disk types." + } + }, + "description": "Describes the disallowed disk types." + }, + "ImagePurchasePlan": { + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "product": { + "type": "string", + "description": "The product ID." + } + }, + "description": "Describes the gallery image definition purchase plan. This is used by marketplace images." + }, + "SharedGalleryImageVersionList": { + "description": "The List Shared Gallery Image versions operation response.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SharedGalleryImageVersion" + }, + "description": "A list of shared gallery images versions." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of shared gallery image versions. Call ListNext() with this to fetch the next page of shared gallery image versions." + } + }, + "required": [ + "value" + ] + }, + "SharedGalleryImageVersion": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SharedGalleryImageVersionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PirSharedGalleryResource" + } + ], + "description": "Specifies information about the gallery image version that you want to create or update." + }, + "SharedGalleryImageVersionProperties": { + "properties": { + "publishedDate": { + "type": "string", + "format": "date-time", + "description": "The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable." + }, + "endOfLifeDate": { + "type": "string", + "format": "date-time", + "description": "The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable." + } + }, + "description": "Describes the properties of a gallery image version." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/ApiError" + } + }, + "description": "An error response from the Compute service." + }, + "ApiError": { + "properties": { + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiErrorBase" + }, + "description": "The Api error details" + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "The Api inner error" + }, + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error." + }, + "ApiErrorBase": { + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error base." + }, + "InnerError": { + "properties": { + "exceptiontype": { + "type": "string", + "description": "The exception type." + }, + "errordetail": { + "type": "string", + "description": "The internal error message or exception dump." + } + }, + "description": "Inner error details." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "LocationNameParamter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Resource location." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md index ab1608143c57..9480f7c084d3 100644 --- a/specification/compute/resource-manager/readme.md +++ b/specification/compute/resource-manager/readme.md @@ -232,6 +232,31 @@ input-file: - Microsoft.Compute/stable/2020-06-30/disk.json ``` +### Tag: package-2020-09-30 + +These settings apply only when `--tag=package-2020-09-30` is specified on the command line. + +``` yaml $(tag) == 'package-2020-09-30' +input-file: +- Microsoft.Compute/stable/2020-06-01/compute.json +- Microsoft.Compute/stable/2020-06-01/runCommands.json +- Microsoft.Compute/stable/2019-04-01/skus.json +- Microsoft.Compute/stable/2020-05-01/disk.json +- Microsoft.Compute/preview/2020-09-30/gallery.json +- Microsoft.Compute/preview/2020-09-30/sharedGallery.json +- Microsoft.ContainerService/stable/2017-01-31/containerService.json +``` + +### Tag: package-2020-09-30-only + +These settings apply only when `--tag=package-2020-09-30-only` is specified on the command line. + +``` yaml $(tag) == 'package-2020-09-30-only' +input-file: +- Microsoft.Compute/preview/2020-09-30/gallery.json +- Microsoft.Compute/preview/2020-09-30/sharedGallery.json +``` + ### Tag: package-2020-06-01 These settings apply only when `--tag=package-2020-06-01` is specified on the command line. @@ -846,6 +871,8 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.Compute/preview/2020-09-30/sharedGallery.json + - $(this-folder)/Microsoft.Compute/preview/2020-09-30/gallery.json - $(this-folder)/Microsoft.Compute/stable/2020-06-01/compute.json - $(this-folder)/Microsoft.Compute/stable/2020-06-01/runCommands.json - $(this-folder)/Microsoft.Compute/stable/2019-04-01/skus.json From 31734c4b1d0aa09c840f0371deb4d027f4618b0b Mon Sep 17 00:00:00 2001 From: changlong-liu <59815250+changlong-liu@users.noreply.github.com> Date: Wed, 9 Sep 2020 09:31:10 +0800 Subject: [PATCH 013/164] add tag package-preview-2020-04 (#10721) --- specification/keyvault/resource-manager/readme.python.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/keyvault/resource-manager/readme.python.md b/specification/keyvault/resource-manager/readme.python.md index d5860fc40383..b7f95e0c23ce 100644 --- a/specification/keyvault/resource-manager/readme.python.md +++ b/specification/keyvault/resource-manager/readme.python.md @@ -42,6 +42,7 @@ batch: - tag: package-2019-09 - tag: package-2018-02 - tag: package-2016-10 + - tag: package-preview-2020-04 - multiapiscript: true ``` From d2efa993873365cc9f2db920479a3e45bd8d7f0f Mon Sep 17 00:00:00 2001 From: Marwan Ahmed Date: Tue, 8 Sep 2020 18:38:16 -0700 Subject: [PATCH 014/164] Dev containerservice microsoft.container service 2020 09 01 (#10634) --- cSpell.json | 6 + custom-words.txt | 1 + .../examples/AgentPoolsCreate_Ephemeral.json | 55 + .../examples/AgentPoolsCreate_PPG.json | 52 + .../examples/AgentPoolsCreate_Spot.json | 84 + .../examples/AgentPoolsCreate_Update.json | 86 + .../2020-09-01/examples/AgentPoolsDelete.json | 13 + .../2020-09-01/examples/AgentPoolsGet.json | 29 + ...entPoolsGetAgentPoolAvailableVersions.json | 32 + .../examples/AgentPoolsGetUpgradeProfile.json | 28 + .../2020-09-01/examples/AgentPoolsList.json | 29 + .../AgentPoolsUpgradeNodeImageVersion.json | 30 + .../examples/AgentPools_Update.json | 73 + .../examples/ManagedClustersCreate_PPG.json | 236 ++ .../ManagedClustersCreate_Update.json | 280 ++ .../ManagedClustersCreate_UpdateWithAHUB.json | 275 ++ ...stersCreate_UpdateWithEnableAzureRBAC.json | 264 ++ .../examples/ManagedClustersDelete.json | 12 + .../examples/ManagedClustersGet.json | 96 + .../ManagedClustersGetAccessProfile.json | 22 + .../ManagedClustersGetUpgradeProfile.json | 49 + .../examples/ManagedClustersList.json | 65 + .../ManagedClustersListByResourceGroup.json | 66 + ...edClustersListClusterCredentialResult.json | 20 + .../ManagedClustersResetAADProfile.json | 18 + ...dClustersResetServicePrincipalProfile.json | 16 + ...agedClustersRotateClusterCertificates.json | 12 + .../examples/ManagedClustersStart.json | 12 + .../examples/ManagedClustersStop.json | 12 + .../examples/ManagedClustersUpdateTags.json | 68 + .../PrivateEndpointConnectionsDelete.json | 13 + .../PrivateEndpointConnectionsGet.json | 26 + .../PrivateEndpointConnectionsList.json | 29 + .../PrivateEndpointConnectionsUpdate.json | 33 + .../examples/PrivateLinkResourcesList.json | 25 + .../examples/ResolvePrivateLinkServiceId.json | 18 + .../stable/2020-09-01/managedClusters.json | 3337 +++++++++++++++++ .../resource-manager/readme.go.md | 11 + .../resource-manager/readme.java.md | 15 +- .../resource-manager/readme.md | 31 +- .../resource-manager/readme.python.md | 12 + 41 files changed, 5587 insertions(+), 4 deletions(-) create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsCreate_Ephemeral.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsCreate_PPG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsCreate_Spot.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsGetUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsUpgradeNodeImageVersion.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPools_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersCreate_PPG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersCreate_UpdateWithAHUB.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersGetAccessProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersGetUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersListByResourceGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersListClusterCredentialResult.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersResetAADProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersResetServicePrincipalProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersRotateClusterCertificates.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersStart.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersStop.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersUpdateTags.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/PrivateEndpointConnectionsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/PrivateEndpointConnectionsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/PrivateEndpointConnectionsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/PrivateEndpointConnectionsUpdate.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/PrivateLinkResourcesList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ResolvePrivateLinkServiceId.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/managedClusters.json diff --git a/cSpell.json b/cSpell.json index 9749c1657a3b..207203bfb932 100644 --- a/cSpell.json +++ b/cSpell.json @@ -161,6 +161,12 @@ "azpodpolicy" ] }, + { + "filename": "**/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/managedClusters.json", + "words": [ + "azpodpolicy" + ] + }, { "filename": "**/specification/containerregistry/data-plane/Microsoft.ContainerRegistry/preview/2018-08-10/containerregistry.json", "words": [ diff --git a/custom-words.txt b/custom-words.txt index 6311920fe608..05207827ee02 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -157,6 +157,7 @@ AZFW AZNB azns azpkg +azpodpolicy azureaccounts azureactivedirectory azureblob diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsCreate_Ephemeral.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsCreate_Ephemeral.json new file mode 100644 index 000000000000..0465208ed255 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsCreate_Ephemeral.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsCreate_PPG.json new file mode 100644 index 000000000000..fe3c6998bb0b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsCreate_PPG.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsCreate_Spot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsCreate_Spot.json new file mode 100644 index 000000000000..1dd25b5f1cd6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsCreate_Spot.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsCreate_Update.json new file mode 100644 index 000000000000..f72c274a469c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsCreate_Update.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsDelete.json new file mode 100644 index 000000000000..34e078b8ddc9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsGet.json new file mode 100644 index 000000000000..e2924bd00050 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json new file mode 100644 index 000000000000..0562b87ea10e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/availableagentpoolversions", + "name": "default", + "properties": { + "agentPoolVersions": [ + { + "kubernetesVersion": "1.12.7" + }, + { + "kubernetesVersion": "1.12.8" + }, + { + "default": true, + "kubernetesVersion": "1.13.5", + "isPreview": true + } + ] + }, + "type": "Microsoft.ContainerService/managedClusters/availableAgentpoolVersions" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsGetUpgradeProfile.json new file mode 100644 index 000000000000..23544c4c5b16 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsGetUpgradeProfile.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/upgradeprofiles/default", + "name": "default", + "properties": { + "kubernetesVersion": "1.12.8", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.13.5" + } + ], + "latestNodeImageVersion": "AKSUbuntu:1604:2020.03.11" + }, + "type": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsList.json new file mode 100644 index 000000000000..09ec35dd854d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsList.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsUpgradeNodeImageVersion.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsUpgradeNodeImageVersion.json new file mode 100644 index 000000000000..d1d4d87e5881 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPoolsUpgradeNodeImageVersion.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": {}, + "202": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "UpgradingNodeImageVersion", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu-1604-2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPools_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPools_Update.json new file mode 100644 index 000000000000..9c0ee3ef6a60 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/AgentPools_Update.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Updating", + "orchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersCreate_PPG.json new file mode 100644 index 000000000000..52cbf09263a2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersCreate_PPG.json @@ -0,0 +1,236 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersCreate_Update.json new file mode 100644 index 000000000000..2154502d0c28 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersCreate_Update.json @@ -0,0 +1,280 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "most-pods", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "most-pods", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersCreate_UpdateWithAHUB.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersCreate_UpdateWithAHUB.json new file mode 100644 index 000000000000..22500c964240 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersCreate_UpdateWithAHUB.json @@ -0,0 +1,275 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json new file mode 100644 index 000000000000..e88ec3b727e7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json @@ -0,0 +1,264 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "aadProfile": { + "managed": true, + "enableAzureRBAC": true + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersDelete.json new file mode 100644 index 000000000000..12a0dd0e4a25 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersGet.json new file mode 100644 index 000000000000..74d4a76054ad --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersGet.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "availabilityZones": [ + "1", + "2", + "3" + ], + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "outboundIPs": { + "publicIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip2" + } + ] + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersGetAccessProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersGetAccessProfile.json new file mode 100644 index 000000000000..e8fb8bd9c65b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersGetAccessProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "roleName": "clusterUser" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser", + "location": "location1", + "name": "clusterUser", + "properties": { + "kubeConfig": "kubeConfig1" + }, + "type": "Microsoft.ContainerService/ManagedClusters/AccessProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersGetUpgradeProfile.json new file mode 100644 index 000000000000..96bc1df11315 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersGetUpgradeProfile.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/upgradeprofiles/default", + "name": "default", + "properties": { + "agentPoolProfiles": [ + { + "kubernetesVersion": "1.7.7", + "name": "agent", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9" + }, + { + "kubernetesVersion": "1.7.11", + "isPreview": true + } + ] + } + ], + "controlPlaneProfile": { + "kubernetesVersion": "1.7.7", + "name": "master", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9", + "isPreview": true + }, + { + "kubernetesVersion": "1.7.11" + } + ] + } + }, + "type": "Microsoft.ContainerService/managedClusters/upgradeprofiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersList.json new file mode 100644 index 000000000000..e89e09461ba0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersList.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/providers/Microsoft.ContainerService/managedClusters", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersListByResourceGroup.json new file mode 100644 index 000000000000..d4337b7e4d4b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersListByResourceGroup.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersListClusterCredentialResult.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersListClusterCredentialResult.json new file mode 100644 index 000000000000..106b9437fe9b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersListClusterCredentialResult.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "credentialValue1" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersResetAADProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersResetAADProfile.json new file mode 100644 index 000000000000..f655e65a95cf --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersResetAADProfile.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientAppID": "clientappid", + "serverAppID": "serverappid", + "serverAppSecret": "serverappsecret", + "tenantID": "tenantid" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersResetServicePrincipalProfile.json new file mode 100644 index 000000000000..5849ddf284ae --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersResetServicePrincipalProfile.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientId": "clientid", + "secret": "secret" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersRotateClusterCertificates.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersRotateClusterCertificates.json new file mode 100644 index 000000000000..12a0dd0e4a25 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersRotateClusterCertificates.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersStart.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersStart.json new file mode 100644 index 000000000000..12a0dd0e4a25 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersStart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersStop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersStop.json new file mode 100644 index 000000000000..12a0dd0e4a25 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersStop.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersUpdateTags.json new file mode 100644 index 000000000000..12b1a2395edb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ManagedClustersUpdateTags.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "tags": { + "tier": "testing", + "archv3": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv3": "", + "tier": "testing" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/PrivateEndpointConnectionsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/PrivateEndpointConnectionsDelete.json new file mode 100644 index 000000000000..cb4dad284f12 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/PrivateEndpointConnectionsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/PrivateEndpointConnectionsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/PrivateEndpointConnectionsGet.json new file mode 100644 index 000000000000..9d4e3a35d790 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/PrivateEndpointConnectionsGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + }, + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/PrivateEndpointConnectionsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/PrivateEndpointConnectionsList.json new file mode 100644 index 000000000000..737edc566ede --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/PrivateEndpointConnectionsList.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + }, + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/PrivateEndpointConnectionsUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/PrivateEndpointConnectionsUpdate.json new file mode 100644 index 000000000000..7a4bb726214b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/PrivateEndpointConnectionsUpdate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + }, + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/PrivateLinkResourcesList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/PrivateLinkResourcesList.json new file mode 100644 index 000000000000..44f51606e06d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/PrivateLinkResourcesList.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "management", + "type": "Microsoft.ContainerService/managedClusters/privateLinkResources", + "groupId": "management", + "requiredMembers": [ + "management" + ], + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ResolvePrivateLinkServiceId.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ResolvePrivateLinkServiceId.json new file mode 100644 index 000000000000..c37322caf4b0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/examples/ResolvePrivateLinkServiceId.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "name": "management" + } + }, + "responses": { + "200": { + "body": { + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/managedClusters.json new file mode 100644 index 000000000000..3ef7b8c1035b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/managedClusters.json @@ -0,0 +1,3337 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2020-09-01" + }, + "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.ContainerService/operations": { + "get": { + "tags": [ + "managedClusters" + ], + "operationId": "Operations_List", + "description": "Gets a list of compute operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_List", + "summary": "Gets a list of managed clusters in the specified subscription.", + "description": "Gets a list of managed clusters in the specified subscription. The operation returns properties of each managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Clusters": { + "$ref": "./examples/ManagedClustersList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListByResourceGroup", + "summary": "Lists managed clusters in the specified subscription and resource group.", + "description": "Lists managed clusters in the specified subscription and resource group. The operation returns properties of each managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Managed Clusters by Resource Group": { + "$ref": "./examples/ManagedClustersListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetUpgradeProfile", + "summary": "Gets upgrade profile for a managed cluster.", + "description": "Gets the details of the upgrade profile for a managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Managed Cluster": { + "$ref": "./examples/ManagedClustersGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetAccessProfile", + "summary": "Gets an access profile of a managed cluster.", + "description": "Gets the accessProfile for the specified role name of the managed cluster with a specified resource group and name. **WARNING**: This API will be deprecated. Instead use [ListClusterUserCredentials](https://docs.microsoft.com/en-us/rest/api/aks/managedclusters/listclusterusercredentials) or [ListClusterAdminCredentials](https://docs.microsoft.com/en-us/rest/api/aks/managedclusters/listclusteradmincredentials) .", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role for managed cluster accessProfile resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterAccessProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGetAccessProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterAdminCredentials", + "summary": "Gets cluster admin credential of a managed cluster.", + "description": "Gets cluster admin credential of the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterUserCredentials", + "summary": "Gets cluster user credential of a managed cluster.", + "description": "Gets cluster user credential of the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterMonitoringUserCredentials", + "summary": "Gets cluster monitoring user credential of a managed cluster.", + "description": "Gets cluster monitoring user credential of the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Get", + "summary": "Gets a managed cluster.", + "description": "Gets the details of the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_CreateOrUpdate", + "summary": "Creates or updates a managed cluster.", + "description": "Creates or updates a managed cluster with the specified configuration for agents and Kubernetes version.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "Parameters supplied to the Create or Update a Managed Cluster operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Managed Cluster": { + "$ref": "./examples/ManagedClustersCreate_Update.json" + }, + "Create/Update AAD Managed Cluster with EnableAzureRBAC": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json" + }, + "Create Managed Cluster with PPG": { + "$ref": "./examples/ManagedClustersCreate_PPG.json" + }, + "Create/Update Managed Cluster with EnableAHUB": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithAHUB.json" + } + } + }, + "patch": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_UpdateTags", + "summary": "Updates tags on a managed cluster.", + "description": "Updates a managed cluster with the specified tags.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update Managed Cluster Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Managed Cluster Tags": { + "$ref": "./examples/ManagedClustersUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Delete", + "summary": "Deletes a managed cluster.", + "description": "Deletes the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Managed Cluster": { + "$ref": "./examples/ManagedClustersDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_List", + "summary": "Gets a list of agent pools in the specified managed cluster.", + "description": "Gets a list of agent pools in the specified managed cluster. The operation returns properties of each agent pool.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Agent Pools by Managed Cluster": { + "$ref": "./examples/AgentPoolsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Get", + "summary": "Gets the agent pool.", + "description": "Gets the details of the agent pool by managed cluster and resource group.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Agent Pool": { + "$ref": "./examples/AgentPoolsGet.json" + } + } + }, + "put": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_CreateOrUpdate", + "summary": "Creates or updates an agent pool.", + "description": "Creates or updates an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPool" + }, + "description": "Parameters supplied to the Create or Update an agent pool operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Update.json" + }, + "Update Agent Pool": { + "$ref": "./examples/AgentPools_Update.json" + }, + "Create Spot Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Spot.json" + }, + "Create Agent Pool with PPG": { + "$ref": "./examples/AgentPoolsCreate_PPG.json" + }, + "Create Agent Pool with Ephemeral OS Disk": { + "$ref": "./examples/AgentPoolsCreate_Ephemeral.json" + } + } + }, + "delete": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Delete", + "summary": "Deletes an agent pool.", + "description": "Deletes the agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Agent Pool": { + "$ref": "./examples/AgentPoolsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetUpgradeProfile", + "summary": "Gets upgrade profile for an agent pool.", + "description": "Gets the details of the upgrade profile for an agent pool with a specified resource group and managed cluster name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Agent Pool": { + "$ref": "./examples/AgentPoolsGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetAvailableAgentPoolVersions", + "summary": "Gets a list of supported versions for the specified agent pool.", + "description": "Gets a list of supported versions for the specified agent pool.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolAvailableVersions" + } + } + }, + "x-ms-examples": { + "Get available versions for agent pool": { + "$ref": "./examples/AgentPoolsGetAgentPoolAvailableVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetServicePrincipalProfile", + "summary": "Reset Service Principal Profile of a managed cluster.", + "description": "Update the service principal Profile for a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile" + }, + "description": "Parameters supplied to the Reset Service Principal Profile operation for a Managed Cluster." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reset Service Principal Profile": { + "$ref": "./examples/ManagedClustersResetServicePrincipalProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetAADProfile", + "summary": "Reset AAD Profile of a managed cluster.", + "description": "Update the AAD Profile for a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterAADProfile" + }, + "description": "Parameters supplied to the Reset AAD Profile operation for a Managed Cluster." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reset AAD Profile": { + "$ref": "./examples/ManagedClustersResetAADProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateClusterCertificates", + "summary": "Rotate certificates of a managed cluster.", + "description": "Rotate certificates of a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Rotate Cluster Certificates": { + "$ref": "./examples/ManagedClustersRotateClusterCertificates.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/stop": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Stop", + "summary": "Stop Managed Cluster", + "description": "Stops a Running Managed Cluster", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Stop Managed Cluster": { + "$ref": "./examples/ManagedClustersStop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/start": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Start", + "summary": "Start Managed Cluster", + "description": "Starts a Stopped Managed Cluster", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Start Managed Cluster": { + "$ref": "./examples/ManagedClustersStart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "summary": "Gets a list of private endpoint connections in the specified managed cluster.", + "description": "Gets a list of private endpoint connections in the specified managed cluster. The operation returns properties of each private endpoint connection.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Endpoint Connections by Managed Cluster": { + "$ref": "./examples/PrivateEndpointConnectionsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "summary": "Gets the private endpoint connection.", + "description": "Gets the details of the private endpoint connection by managed cluster and resource group.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Update", + "summary": "Updates a private endpoint connection.", + "description": "Updates a private endpoint connection in the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "Parameters supplied to the Update a private endpoint connection operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "summary": "Deletes a private endpoint connection.", + "description": "Deletes the private endpoint connection in the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeNodeImageVersion": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "ManagedClusters_UpgradeNodeImageVersion", + "summary": "Upgrade node image version of an agent pool to the latest.", + "description": "Upgrade node image version of an agent pool to the latest.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upgrade Agent Pool Node Image Version": { + "$ref": "./examples/AgentPoolsUpgradeNodeImageVersion.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "privateLinkResources" + ], + "operationId": "PrivateLinkResources_List", + "summary": "Gets a list of private link resources in the specified managed cluster.", + "description": "Gets a list of private link resources in the specified managed cluster. The operation returns properties of each private link resource.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Link Resources by Managed Cluster": { + "$ref": "./examples/PrivateLinkResourcesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resolvePrivateLinkServiceId": { + "post": { + "tags": [ + "resolvePrivateLinkServiceId" + ], + "operationId": "ResolvePrivateLinkServiceId_POST", + "summary": "Gets the private link service ID for the specified managed cluster.", + "description": "Gets the private link service ID the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Parameters (name, groupId) supplied in order to resolve a private link service ID." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Resolve the Private Link Service ID for Managed Cluster": { + "$ref": "./examples/ResolvePrivateLinkServiceId.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationValue" + }, + "description": "The list of compute operations" + } + }, + "description": "The List Compute Operation operation response." + }, + "OperationValue": { + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the compute operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the compute operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationValueDisplay", + "description": "Describes the properties of a Compute Operation Value Display." + } + }, + "description": "Describes the properties of a Compute Operation value." + }, + "OperationValueDisplay": { + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the compute operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Compute Operation Value Display." + }, + "Resource": { + "description": "The Resource model definition.", + "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", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "TagsObject": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "ContainerServiceOSDisk": { + "type": "integer", + "format": "int32", + "maximum": 1023, + "minimum": 0, + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "ContainerServiceStorageProfile": { + "type": "string", + "x-ms-enum": { + "name": "ContainerServiceStorageProfileTypes", + "modelAsString": true + }, + "enum": [ + "StorageAccount", + "ManagedDisks" + ], + "description": "Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice." + }, + "ContainerServiceVnetSubnetID": { + "type": "string", + "description": "VNet SubnetID specifies the VNet's subnet identifier." + }, + "ContainerServiceVMSize": { + "type": "string", + "x-ms-enum": { + "name": "ContainerServiceVMSizeTypes", + "modelAsString": true + }, + "description": "Size of agent VMs.", + "enum": [ + "Standard_A1", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2", + "Standard_A2_v2", + "Standard_A2m_v2", + "Standard_A3", + "Standard_A4", + "Standard_A4_v2", + "Standard_A4m_v2", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A8_v2", + "Standard_A8m_v2", + "Standard_A9", + "Standard_B2ms", + "Standard_B2s", + "Standard_B4ms", + "Standard_B8ms", + "Standard_D1", + "Standard_D11", + "Standard_D11_v2", + "Standard_D11_v2_Promo", + "Standard_D12", + "Standard_D12_v2", + "Standard_D12_v2_Promo", + "Standard_D13", + "Standard_D13_v2", + "Standard_D13_v2_Promo", + "Standard_D14", + "Standard_D14_v2", + "Standard_D14_v2_Promo", + "Standard_D15_v2", + "Standard_D16_v3", + "Standard_D16s_v3", + "Standard_D1_v2", + "Standard_D2", + "Standard_D2_v2", + "Standard_D2_v2_Promo", + "Standard_D2_v3", + "Standard_D2s_v3", + "Standard_D3", + "Standard_D32_v3", + "Standard_D32s_v3", + "Standard_D3_v2", + "Standard_D3_v2_Promo", + "Standard_D4", + "Standard_D4_v2", + "Standard_D4_v2_Promo", + "Standard_D4_v3", + "Standard_D4s_v3", + "Standard_D5_v2", + "Standard_D5_v2_Promo", + "Standard_D64_v3", + "Standard_D64s_v3", + "Standard_D8_v3", + "Standard_D8s_v3", + "Standard_DS1", + "Standard_DS11", + "Standard_DS11_v2", + "Standard_DS11_v2_Promo", + "Standard_DS12", + "Standard_DS12_v2", + "Standard_DS12_v2_Promo", + "Standard_DS13", + "Standard_DS13-2_v2", + "Standard_DS13-4_v2", + "Standard_DS13_v2", + "Standard_DS13_v2_Promo", + "Standard_DS14", + "Standard_DS14-4_v2", + "Standard_DS14-8_v2", + "Standard_DS14_v2", + "Standard_DS14_v2_Promo", + "Standard_DS15_v2", + "Standard_DS1_v2", + "Standard_DS2", + "Standard_DS2_v2", + "Standard_DS2_v2_Promo", + "Standard_DS3", + "Standard_DS3_v2", + "Standard_DS3_v2_Promo", + "Standard_DS4", + "Standard_DS4_v2", + "Standard_DS4_v2_Promo", + "Standard_DS5_v2", + "Standard_DS5_v2_Promo", + "Standard_E16_v3", + "Standard_E16s_v3", + "Standard_E2_v3", + "Standard_E2s_v3", + "Standard_E32-16s_v3", + "Standard_E32-8s_v3", + "Standard_E32_v3", + "Standard_E32s_v3", + "Standard_E4_v3", + "Standard_E4s_v3", + "Standard_E64-16s_v3", + "Standard_E64-32s_v3", + "Standard_E64_v3", + "Standard_E64s_v3", + "Standard_E8_v3", + "Standard_E8s_v3", + "Standard_F1", + "Standard_F16", + "Standard_F16s", + "Standard_F16s_v2", + "Standard_F1s", + "Standard_F2", + "Standard_F2s", + "Standard_F2s_v2", + "Standard_F32s_v2", + "Standard_F4", + "Standard_F4s", + "Standard_F4s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_F8", + "Standard_F8s", + "Standard_F8s_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS4-4", + "Standard_GS4-8", + "Standard_GS5", + "Standard_GS5-16", + "Standard_GS5-8", + "Standard_H16", + "Standard_H16m", + "Standard_H16mr", + "Standard_H16r", + "Standard_H8", + "Standard_H8m", + "Standard_L16s", + "Standard_L32s", + "Standard_L4s", + "Standard_L8s", + "Standard_M128-32ms", + "Standard_M128-64ms", + "Standard_M128ms", + "Standard_M128s", + "Standard_M64-16ms", + "Standard_M64-32ms", + "Standard_M64ms", + "Standard_M64s", + "Standard_NC12", + "Standard_NC12s_v2", + "Standard_NC12s_v3", + "Standard_NC24", + "Standard_NC24r", + "Standard_NC24rs_v2", + "Standard_NC24rs_v3", + "Standard_NC24s_v2", + "Standard_NC24s_v3", + "Standard_NC6", + "Standard_NC6s_v2", + "Standard_NC6s_v3", + "Standard_ND12s", + "Standard_ND24rs", + "Standard_ND24s", + "Standard_ND6s", + "Standard_NV12", + "Standard_NV24", + "Standard_NV6" + ] + }, + "ManagedClusterServicePrincipalProfile": { + "properties": { + "clientId": { + "type": "string", + "description": "The ID for the service principal." + }, + "secret": { + "type": "string", + "description": "The secret password associated with the service principal in plain text." + } + }, + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs.", + "required": [ + "clientId" + ] + }, + "ContainerServiceMasterProfile": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "enum": [ + 1, + 3, + 5 + ], + "x-ms-enum": { + "name": "Count", + "modelAsString": false + }, + "description": "Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1.", + "default": 1 + }, + "dnsPrefix": { + "type": "string", + "description": "DNS prefix to be used to create the FQDN for the master pool." + }, + "vmSize": { + "$ref": "#/definitions/ContainerServiceVMSize", + "description": "Size of agent VMs." + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk", + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "vnetSubnetID": { + "$ref": "#/definitions/ContainerServiceVnetSubnetID", + "description": "VNet SubnetID specifies the VNet's subnet identifier." + }, + "firstConsecutiveStaticIP": { + "type": "string", + "description": "FirstConsecutiveStaticIP used to specify the first static ip of masters.", + "default": "10.240.255.5" + }, + "storageProfile": { + "$ref": "#/definitions/ContainerServiceStorageProfile", + "description": "Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "FQDN for the master pool." + } + }, + "required": [ + "dnsPrefix", + "vmSize" + ], + "description": "Profile for the container service master." + }, + "ManagedClusterAgentPoolProfileProperties": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1." + }, + "vmSize": { + "$ref": "#/definitions/ContainerServiceVMSize", + "description": "Size of agent VMs." + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk", + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "osDiskType": { + "$ref": "#/definitions/OSDiskType", + "description": "OS disk type to be used for machines in a given agent pool. Allowed values are 'Ephemeral' and 'Managed'. Defaults to 'Managed'. May not be changed after creation." + }, + "vnetSubnetID": { + "$ref": "#/definitions/ContainerServiceVnetSubnetID", + "description": "VNet SubnetID specifies the VNet's subnet identifier." + }, + "maxPods": { + "type": "integer", + "format": "int32", + "description": "Maximum number of pods that can run on a node." + }, + "osType": { + "$ref": "#/definitions/OSType", + "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "Maximum number of nodes for auto-scaling" + }, + "minCount": { + "type": "integer", + "format": "int32", + "description": "Minimum number of nodes for auto-scaling" + }, + "enableAutoScaling": { + "type": "boolean", + "description": "Whether to enable auto-scaler" + }, + "type": { + "$ref": "#/definitions/AgentPoolType", + "description": "AgentPoolType represents types of an agent pool" + }, + "mode": { + "$ref": "#/definitions/AgentPoolMode", + "description": "AgentPoolMode represents mode of an agent pool" + }, + "orchestratorVersion": { + "type": "string", + "description": "Version of orchestrator specified when creating the managed cluster." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "Version of node image" + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "Settings for upgrading the agentpool" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response." + }, + "powerState": { + "readOnly": true, + "description": "Describes whether the Agent Pool is Running or Stopped", + "$ref": "#/definitions/PowerState" + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType." + }, + "enableNodePublicIP": { + "type": "boolean", + "description": "Enable public IP for nodes" + }, + "scaleSetPriority": { + "$ref": "#/definitions/ScaleSetPriority", + "description": "ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular." + }, + "scaleSetEvictionPolicy": { + "$ref": "#/definitions/ScaleSetEvictionPolicy", + "description": "ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete." + }, + "spotMaxPrice": { + "$ref": "#/definitions/SpotMaxPrice", + "description": "SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Agent pool tags to be persisted on the agent pool virtual machine scale set." + }, + "nodeLabels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Agent pool node labels to be persisted across all nodes in agent pool." + }, + "nodeTaints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule." + }, + "proximityPlacementGroupID": { + "$ref": "#/definitions/ProximityPlacementGroupID", + "description": "The ID for Proximity Placement Group." + } + }, + "description": "Properties for the container service agent pool profile." + }, + "ManagedClusterAgentPoolProfile": { + "allOf": [ + { + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties" + }, + { + "properties": { + "name": { + "type": "string", + "description": "Unique name of the agent pool profile in the context of the subscription and resource group.", + "pattern": "^[a-z][a-z0-9]{0,11}$" + } + } + } + ], + "required": [ + "name" + ], + "description": "Profile for the container service agent pool." + }, + "AgentPoolType": { + "type": "string", + "enum": [ + "VirtualMachineScaleSets", + "AvailabilitySet" + ], + "x-ms-enum": { + "name": "AgentPoolType", + "modelAsString": true + }, + "description": "AgentPoolType represents types of an agent pool." + }, + "AgentPoolMode": { + "type": "string", + "enum": [ + "System", + "User" + ], + "x-ms-enum": { + "name": "AgentPoolMode", + "modelAsString": true + }, + "description": "AgentPoolMode represents mode of an agent pool." + }, + "AgentPoolListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The list of agent pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of agent pool results.", + "readOnly": true + } + }, + "description": "The response from the List Agent Pools operation." + }, + "AgentPoolUpgradeSettings": { + "properties": { + "maxSurge": { + "type": "string", + "description": "Count or percentage of additional nodes to be added during upgrade. If empty uses AKS default" + } + }, + "description": "Settings for upgrading an agentpool" + }, + "AgentPool": { + "allOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "properties": { + "properties": { + "description": "Properties of an agent pool.", + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties", + "x-ms-client-flatten": true + } + } + } + ], + "description": "Agent Pool." + }, + "ManagedClusterWindowsProfile": { + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Windows VMs.", + "pattern": "^[a-zA-Z0-9]+([._]?[a-zA-Z0-9]+)*$" + }, + "adminPassword": { + "type": "string", + "description": "The administrator password to use for Windows VMs.", + "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*[!@#$%\\^&\\*\\(\\)])[a-zA-Z\\d!@#$%\\^&\\*\\(\\)]{12,123}$" + }, + "licenseType": { + "type": "string", + "enum": [ + "None", + "Windows_Server" + ], + "x-ms-enum": { + "name": "licenseType", + "modelAsString": true + }, + "description": "The licenseType to use for Windows VMs. Windows_Server is used to enable Azure Hybrid User Benefits for Windows VMs." + } + }, + "required": [ + "adminUsername" + ], + "description": "Profile for Windows VMs in the container service cluster." + }, + "ContainerServiceLinuxProfile": { + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Linux VMs.", + "pattern": "^[A-Za-z][-A-Za-z0-9_]*$" + }, + "ssh": { + "$ref": "#/definitions/ContainerServiceSshConfiguration", + "description": "SSH configuration for Linux-based VMs running on Azure." + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VMs in the container service cluster." + }, + "ContainerServiceNetworkProfile": { + "properties": { + "networkPlugin": { + "type": "string", + "enum": [ + "azure", + "kubenet" + ], + "default": "kubenet", + "x-ms-enum": { + "name": "NetworkPlugin", + "modelAsString": true + }, + "description": "Network plugin used for building Kubernetes network." + }, + "networkPolicy": { + "type": "string", + "enum": [ + "calico", + "azure" + ], + "x-ms-enum": { + "name": "NetworkPolicy", + "modelAsString": true + }, + "description": "Network policy used for building Kubernetes network." + }, + "networkMode": { + "type": "string", + "enum": [ + "transparent", + "bridge" + ], + "x-ms-enum": { + "name": "networkMode", + "modelAsString": true + }, + "description": "Network mode used for building Kubernetes network." + }, + "podCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.244.0.0/16", + "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used." + }, + "serviceCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.0.0.0/16", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges." + }, + "dnsServiceIP": { + "type": "string", + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "default": "10.0.0.10", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr." + }, + "dockerBridgeCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "172.17.0.1/16", + "description": "A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range." + }, + "outboundType": { + "type": "string", + "enum": [ + "loadBalancer", + "userDefinedRouting" + ], + "x-ms-enum": { + "name": "outboundType", + "modelAsString": true + }, + "default": "loadBalancer", + "description": "The outbound (egress) routing method." + }, + "loadBalancerSku": { + "type": "string", + "enum": [ + "standard", + "basic" + ], + "x-ms-enum": { + "name": "loadBalancerSku", + "modelAsString": true + }, + "description": "The load balancer sku for the managed cluster." + }, + "loadBalancerProfile": { + "$ref": "#/definitions/ManagedClusterLoadBalancerProfile", + "description": "Profile of the cluster load balancer." + } + }, + "description": "Profile of network configuration." + }, + "ManagedClusterLoadBalancerProfile": { + "properties": { + "managedOutboundIPs": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 1, + "description": "Desired number of outbound IP created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", + "default": 1 + } + }, + "description": "Desired managed outbound IPs for the cluster load balancer." + }, + "outboundIPPrefixes": { + "properties": { + "publicIPPrefixes": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP prefix resources." + } + }, + "description": "Desired outbound IP Prefix resources for the cluster load balancer." + }, + "outboundIPs": { + "properties": { + "publicIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP resources." + } + }, + "description": "Desired outbound IP resources for the cluster load balancer." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster load balancer." + }, + "allocatedOutboundPorts": { + "type": "integer", + "format": "int32", + "maximum": 64000, + "minimum": 0, + "description": "Desired number of allocated SNAT ports per VM. Allowed values must be in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.", + "default": 0 + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values must be in the range of 4 to 120 (inclusive). The default value is 30 minutes.", + "default": 30 + } + }, + "description": "Profile of the managed cluster load balancer." + }, + "ResourceReference": { + "properties": { + "id": { + "type": "string", + "description": "The fully qualified Azure resource id." + } + }, + "description": "A reference to an Azure resource." + }, + "ContainerServiceSshConfiguration": { + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + }, + "description": "The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified." + } + }, + "description": "SSH configuration for Linux-based VMs running on Azure.", + "required": [ + "publicKeys" + ] + }, + "ContainerServiceSshPublicKey": { + "properties": { + "keyData": { + "type": "string", + "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ContainerServiceDiagnosticsProfile": { + "properties": { + "vmDiagnostics": { + "$ref": "#/definitions/ContainerServiceVMDiagnostics", + "description": "Profile for diagnostics on the container service VMs." + } + }, + "description": "Profile for diagnostics on the container service cluster.", + "required": [ + "vmDiagnostics" + ] + }, + "ContainerServiceVMDiagnostics": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the VM diagnostic agent is provisioned on the VM." + }, + "storageUri": { + "readOnly": true, + "type": "string", + "description": "The URI of the storage account where diagnostics are stored." + } + }, + "description": "Profile for diagnostics on the container service VMs.", + "required": [ + "enabled" + ] + }, + "ManagedClusterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The list of managed clusters." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Clusters operation." + }, + "ManagedCluster": { + "properties": { + "sku": { + "$ref": "#/definitions/ManagedClusterSKU", + "description": "The managed cluster SKU." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "description": "Properties of a managed cluster.", + "$ref": "#/definitions/ManagedClusterProperties", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "#/definitions/ManagedClusterIdentity", + "description": "The identity of the managed cluster, if configured." + } + } + } + ], + "description": "Managed cluster." + }, + "ManagedClusterProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response." + }, + "powerState": { + "$ref": "#/definitions/PowerState", + "description": "Represents the Power State of the cluster", + "readOnly": true + }, + "maxAgentPools": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The max number of agent pools for the managed cluster." + }, + "kubernetesVersion": { + "type": "string", + "description": "Version of Kubernetes specified when creating the managed cluster." + }, + "dnsPrefix": { + "type": "string", + "description": "DNS prefix specified when creating the managed cluster." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "FQDN for the master pool." + }, + "privateFQDN": { + "readOnly": true, + "type": "string", + "description": "FQDN of private cluster." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAgentPoolProfile" + }, + "description": "Properties of the agent pool." + }, + "linuxProfile": { + "$ref": "#/definitions/ContainerServiceLinuxProfile", + "description": "Profile for Linux VMs in the container service cluster." + }, + "windowsProfile": { + "$ref": "#/definitions/ManagedClusterWindowsProfile", + "description": "Profile for Windows VMs in the container service cluster." + }, + "servicePrincipalProfile": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile", + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs." + }, + "addonProfiles": { + "additionalProperties": { + "$ref": "#/definitions/ManagedClusterAddonProfile" + }, + "description": "Profile of managed cluster add-on." + }, + "nodeResourceGroup": { + "type": "string", + "description": "Name of the resource group containing agent pool nodes." + }, + "enableRBAC": { + "type": "boolean", + "description": "Whether to enable Kubernetes Role-Based Access Control." + }, + "enablePodSecurityPolicy": { + "type": "boolean", + "description": "(DEPRECATING) Whether to enable Kubernetes pod security policy (preview). This feature is set for removal on October 15th, 2020. Learn more at aka.ms/aks/azpodpolicy." + }, + "networkProfile": { + "$ref": "#/definitions/ContainerServiceNetworkProfile", + "description": "Profile of network configuration." + }, + "aadProfile": { + "$ref": "#/definitions/ManagedClusterAADProfile", + "description": "Profile of Azure Active Directory configuration." + }, + "autoScalerProfile": { + "type": "object", + "properties": { + "balance-similar-node-groups": { + "type": "string" + }, + "expander": { + "type": "string", + "enum": [ + "least-waste", + "most-pods", + "random" + ], + "x-ms-enum": { + "name": "expander", + "modelAsString": true + } + }, + "max-empty-bulk-delete": { + "type": "string" + }, + "max-graceful-termination-sec": { + "type": "string" + }, + "max-total-unready-percentage": { + "type": "string" + }, + "new-pod-scale-up-delay": { + "type": "string" + }, + "ok-total-unready-count": { + "type": "string" + }, + "scan-interval": { + "type": "string" + }, + "scale-down-delay-after-add": { + "type": "string" + }, + "scale-down-delay-after-delete": { + "type": "string" + }, + "scale-down-delay-after-failure": { + "type": "string" + }, + "scale-down-unneeded-time": { + "type": "string" + }, + "scale-down-unready-time": { + "type": "string" + }, + "scale-down-utilization-threshold": { + "type": "string" + }, + "skip-nodes-with-local-storage": { + "type": "string" + }, + "skip-nodes-with-system-pods": { + "type": "string" + } + }, + "description": "Parameters to be applied to the cluster-autoscaler when enabled" + }, + "apiServerAccessProfile": { + "$ref": "#/definitions/ManagedClusterAPIServerAccessProfile", + "description": "Access profile for managed cluster API server." + }, + "diskEncryptionSetID": { + "type": "string", + "description": "ResourceId of the disk encryption set to use for enabling encryption at rest." + }, + "identityProfile": { + "additionalProperties": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/definitions/UserAssignedIdentity" + } + ] + }, + "description": "Identities associated with the cluster." + } + }, + "description": "Properties of the managed cluster." + }, + "PowerState": { + "description": "Describes the Power State of the cluster", + "properties": { + "code": { + "type": "string", + "description": "Tells whether the cluster is Running or Stopped", + "enum": [ + "Running", + "Stopped" + ], + "x-ms-enum": { + "name": "code", + "modelAsString": true + } + } + } + }, + "ManagedClusterAPIServerAccessProfile": { + "properties": { + "authorizedIPRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Authorized IP Ranges to kubernetes API server." + }, + "enablePrivateCluster": { + "type": "boolean", + "description": "Whether to create the cluster as a private cluster or not." + } + }, + "description": "Access profile for managed cluster API server." + }, + "ManagedClusterIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity which is used by master components." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity which is used by master components." + }, + "type": { + "type": "string", + "description": "The type of identity used for the managed cluster. Type 'SystemAssigned' will use an implicitly created identity in master components and an auto-created user assigned identity in MC_ resource group in agent nodes. Type 'None' will not use MSI for the managed cluster, service principal will be used instead.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "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 user identity associated with the managed cluster. This identity will be used in control plane and only one user assigned identity is allowed. 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 managed cluster." + }, + "UserAssignedIdentity": { + "properties": { + "resourceId": { + "type": "string", + "description": "The resource id of the user assigned identity." + }, + "clientId": { + "type": "string", + "description": "The client id of the user assigned identity." + }, + "objectId": { + "type": "string", + "description": "The object id of the user assigned identity." + } + } + }, + "ManagedClusterAccessProfile": { + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "description": "AccessProfile of a managed cluster.", + "$ref": "#/definitions/AccessProfile", + "x-ms-client-flatten": true + } + } + } + ], + "description": "Managed cluster Access Profile.", + "x-ms-azure-resource": false + }, + "AccessProfile": { + "type": "object", + "properties": { + "kubeConfig": { + "type": "string", + "format": "byte", + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "Profile for enabling a user to access a managed cluster." + }, + "ManagedClusterPoolUpgradeProfile": { + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "Kubernetes version (major, minor, patch)." + }, + "name": { + "type": "string", + "description": "Pool name." + }, + "osType": { + "$ref": "#/definitions/OSType", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "ContainerServiceOSTypes", + "modelAsString": true + }, + "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "Kubernetes version (major, minor, patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "description": "List of orchestrator types and versions available for upgrade." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "ManagedClusterUpgradeProfileProperties": { + "properties": { + "controlPlaneProfile": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile", + "description": "The list of available upgrade versions for the control plane." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile" + }, + "description": "The list of available upgrade versions for agent pools." + } + }, + "required": [ + "controlPlaneProfile", + "agentPoolProfiles" + ], + "description": "Control plane and agent pool upgrade profiles." + }, + "ManagedClusterAADProfile": { + "properties": { + "managed": { + "type": "boolean", + "description": "Whether to enable managed AAD." + }, + "enableAzureRBAC": { + "type": "boolean", + "description": "Whether to enable Azure RBAC for Kubernetes authorization." + }, + "adminGroupObjectIDs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "AAD group object IDs that will have admin role of the cluster." + }, + "clientAppID": { + "type": "string", + "description": "The client AAD application ID." + }, + "serverAppID": { + "type": "string", + "description": "The server AAD application ID." + }, + "serverAppSecret": { + "type": "string", + "description": "The server AAD application secret." + }, + "tenantID": { + "type": "string", + "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription." + } + }, + "description": "AADProfile specifies attributes for Azure Active Directory integration." + }, + "ManagedClusterAddonProfile": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the add-on is enabled or not." + }, + "config": { + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs for configuring an add-on." + }, + "identity": { + "readOnly": true, + "description": "Information of user assigned identity used by this add-on.", + "allOf": [ + { + "$ref": "#/definitions/UserAssignedIdentity" + } + ] + } + }, + "required": [ + "enabled" + ], + "description": "A Kubernetes add-on profile for a managed cluster." + }, + "ManagedClusterUpgradeProfile": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Id of upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of upgrade profile." + }, + "properties": { + "$ref": "#/definitions/ManagedClusterUpgradeProfileProperties", + "description": "Properties of upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for compute pools." + }, + "AgentPoolUpgradeProfile": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Id of the agent pool upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the agent pool upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the agent pool upgrade profile." + }, + "properties": { + "$ref": "#/definitions/AgentPoolUpgradeProfileProperties", + "description": "Properties of agent pool upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for an agent pool." + }, + "AgentPoolUpgradeProfileProperties": { + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "Kubernetes version (major, minor, patch)." + }, + "osType": { + "$ref": "#/definitions/OSType", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "ContainerServiceOSTypes", + "modelAsString": true + }, + "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "Kubernetes version (major, minor, patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "description": "List of orchestrator types and versions available for upgrade." + }, + "latestNodeImageVersion": { + "type": "string", + "description": "LatestNodeImageVersion is the latest AKS supported node image version." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "AgentPoolAvailableVersions": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Id of the agent pool available versions." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the agent pool available versions." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the agent pool available versions." + }, + "properties": { + "$ref": "#/definitions/AgentPoolAvailableVersionsProperties", + "description": "Properties of agent pool available versions.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available versions for an agent pool." + }, + "AgentPoolAvailableVersionsProperties": { + "properties": { + "agentPoolVersions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Whether this version is the default agent pool version." + }, + "kubernetesVersion": { + "type": "string", + "description": "Kubernetes version (major, minor, patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "description": "List of versions available for agent pool." + } + }, + "description": "The list of available agent pool versions." + }, + "OSType": { + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true + }, + "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." + }, + "ScaleSetPriority": { + "type": "string", + "default": "Regular", + "enum": [ + "Spot", + "Regular" + ], + "x-ms-enum": { + "name": "ScaleSetPriority", + "modelAsString": true + }, + "description": "ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular." + }, + "ScaleSetEvictionPolicy": { + "type": "string", + "default": "Delete", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleSetEvictionPolicy", + "modelAsString": true + }, + "description": "ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete." + }, + "SpotMaxPrice": { + "type": "number", + "default": -1, + "description": "SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand." + }, + "ProximityPlacementGroupID": { + "type": "string", + "description": "The ID for Proximity Placement Group." + }, + "CredentialResults": { + "properties": { + "kubeconfigs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CredentialResult" + }, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The list of credential result response." + }, + "CredentialResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the credential." + }, + "value": { + "type": "string", + "format": "byte", + "readOnly": true, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The credential result response." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the Container service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Container service." + }, + "ManagedClusterSKU": { + "properties": { + "name": { + "type": "string", + "description": "Name of a managed cluster SKU.", + "enum": [ + "Basic" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Tier of a managed cluster SKU.", + "enum": [ + "Paid", + "Free" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUTier", + "modelAsString": true + } + } + } + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "A list of private endpoint connections", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the private endpoint connection." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the private endpoint connection.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties of a private endpoint connection.", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of a private endpoint connection.", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private endpoint." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "type": "object", + "description": "Private endpoint which a connection belongs to.", + "properties": { + "id": { + "description": "The resource Id for private endpoint", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The state of a private link service connection.", + "type": "object", + "properties": { + "status": { + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "description": "The private link service connection status.", + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The private link service connection description." + } + } + }, + "PrivateLinkResourcesListResult": { + "type": "object", + "description": "A list of private link resources", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the private link resource." + }, + "name": { + "type": "string", + "description": "The name of the private link resource.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "type": "string", + "description": "The resource type." + }, + "groupId": { + "type": "string", + "description": "The group ID of the resource." + }, + "requiredMembers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "RequiredMembers of the resource" + }, + "privateLinkServiceID": { + "readOnly": true, + "type": "string", + "description": "The private link service ID of the resource, this field is exposed only to NRP internally." + } + } + }, + "OSDiskType": { + "type": "string", + "enum": [ + "Managed", + "Ephemeral" + ], + "x-ms-enum": { + "name": "OSDiskType", + "modelAsString": true + }, + "description": "OSDiskType represents the type of an OS disk on an agent pool." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version.", + "x-ms-parameter-location": "client" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The name of the managed cluster resource.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerservice/resource-manager/readme.go.md b/specification/containerservice/resource-manager/readme.go.md index 0e3f2241ca6f..4ce9ad0f6647 100644 --- a/specification/containerservice/resource-manager/readme.go.md +++ b/specification/containerservice/resource-manager/readme.go.md @@ -12,6 +12,7 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2020-09 - tag: package-2020-07 - tag: package-2020-06 - tag: package-2020-04 @@ -33,6 +34,16 @@ batch: - tag: package-2017-08 - tag: package-2017-07 ``` +### Tag: package-2020-09 and go + +These settings apply only when `--package-2020-09 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2020-09' && $(go) +namespace: containerservice +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-09-01/$(namespace) +``` + ### Tag: package-2020-07 and go These settings apply only when `--package-2020-07 --go` is specified on the command line. diff --git a/specification/containerservice/resource-manager/readme.java.md b/specification/containerservice/resource-manager/readme.java.md index 1a9dde56addb..d3c231ff32db 100644 --- a/specification/containerservice/resource-manager/readme.java.md +++ b/specification/containerservice/resource-manager/readme.java.md @@ -26,6 +26,7 @@ batch: - tag: package-2020-04 - tag: package-2020-06 - tag: package-2020-07 + - tag: package-2020-09 ``` ### Tag: package-2020-07 and java @@ -40,6 +41,18 @@ java: regenerate-manager: true generate-interface: true ``` +### Tag: package-2020-09 and java + +These settings apply only when `--tag=package-2020-09` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2020-09' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerservice.v2020_09_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/containerservice/mgmt-v2020_09_01 +regenerate-manager: true +generate-interface: true +``` ### Tag: package-2020-06 and java @@ -208,4 +221,4 @@ java: output-folder: $(azure-libraries-for-java-folder)/sdk/containerservice/mgmt-v2017_07_01 regenerate-manager: true generate-interface: true -``` \ No newline at end of file +``` diff --git a/specification/containerservice/resource-manager/readme.md b/specification/containerservice/resource-manager/readme.md index 03d99ef22e00..0422a527f0db 100644 --- a/specification/containerservice/resource-manager/readme.md +++ b/specification/containerservice/resource-manager/readme.md @@ -34,21 +34,33 @@ These are the global settings for the ContainerServices API. ``` yaml openapi-type: arm -tag: package-2020-07 +tag: package-2020-09 ``` +### Tag: package-2020-09 + +These settings apply only when `--tag=package-2020-09` is specified on the command line. + +```yaml $(tag) == 'package-2020-09' +input-file: + - Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json + - Microsoft.ContainerService/stable/2017-07-01/containerService.json + - Microsoft.ContainerService/stable/2019-08-01/location.json + - Microsoft.ContainerService/stable/2020-09-01/managedClusters.json +``` ### Tag: package-2020-07 These settings apply only when `--tag=package-2020-07` is specified on the command line. -```yaml $(tag) == 'package-2020-07' +``` yaml $(tag) == 'package-2020-07' input-file: - Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json - Microsoft.ContainerService/stable/2017-07-01/containerService.json - Microsoft.ContainerService/stable/2019-08-01/location.json - Microsoft.ContainerService/stable/2020-07-01/managedClusters.json ``` + ### Tag: package-2020-06 These settings apply only when `--tag=package-2020-06` is specified on the command line. @@ -268,6 +280,19 @@ These settings apply only when `--tag=package-2017-07` is specified on the comma ``` yaml $(tag) == 'package-2017-07' input-file: - Microsoft.ContainerService/stable/2017-07-01/containerService.json + +``` +### Tag: package-2020-09-01-only + +These settings apply only when `--tag=package-2020-09-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2020-09-01-only' +input-file: +- Microsoft.ContainerService/stable/2020-09-01/managedClusters.json +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + where: $.definitions.ManagedClusterProperties.properties.autoScalerProfile + reason: Cluster-autoscaler settings are not camel-cased ``` ### Tag: package-2020-07-01-only @@ -623,6 +648,6 @@ If there are files that should not be in the `all-api-versions` set, uncomment the `exclude-file` section below and add the file paths. ``` yaml $(tag) == 'all-api-versions' -#exclude-file: +#exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json ``` diff --git a/specification/containerservice/resource-manager/readme.python.md b/specification/containerservice/resource-manager/readme.python.md index a5e977f860d2..7a02ff59401b 100644 --- a/specification/containerservice/resource-manager/readme.python.md +++ b/specification/containerservice/resource-manager/readme.python.md @@ -18,6 +18,7 @@ Generate all API versions currently shipped for this package ```yaml $(python) && $(multiapi) batch: + - tag: package-2020-09-01-only - tag: package-2020-07-01-only - tag: package-2020-06-01-only - tag: package-2020-04-01-only @@ -39,6 +40,17 @@ batch: - tag: package-2017-07-only-extended ``` +### Tag: package-2020-09-01-only and python + +These settings apply only when `--tag=package-2020-09-01-only --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-09-01-only' && $(python) +python: + namespace: azure.mgmt.containerservice.v2020_09_01 + output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2020_09_01 +``` + ### Tag: package-2020-07-01-only and python These settings apply only when `--tag=package-2020-07-01-only --python` is specified on the command line. From 20b6c51d8ac7e3a89e94981891b44f612a648648 Mon Sep 17 00:00:00 2001 From: savaradh <60020169+savaradh@users.noreply.github.com> Date: Tue, 8 Sep 2020 19:52:24 -0700 Subject: [PATCH 015/164] CMK and Log Template (#10370) --- .../containerregistry_build.json | 35 ++++++++-- ...sksCreate_WithSystemAndUserIdentities.json | 12 +++- .../TasksCreate_WithSystemIdentity.json | 12 +++- .../TasksCreate_WithUserIdentities.json | 12 +++- ...sUpdate_WithKeyVaultCustomCredentials.json | 9 ++- .../TasksUpdate_WithMSICustomCredentials.json | 9 ++- ...RegistriesScheduleRun_WithLogTemplate.json | 55 +++++++++++++++ .../2019-06-01-preview/examples/RunsGet.json | 6 ++ .../2019-06-01-preview/examples/RunsList.json | 6 ++ .../examples/RunsUpdate.json | 12 ++++ .../examples/TasksCreate.json | 12 +++- .../examples/TasksCreate_QuickTask.json | 67 +++++++++++++++++++ .../2019-06-01-preview/examples/TasksGet.json | 4 +- .../examples/TasksGetDetails.json | 4 +- .../examples/TasksList.json | 4 +- .../examples/TasksUpdate.json | 9 ++- .../examples/TasksUpdate_QuickTask.json | 62 +++++++++++++++++ ...sksUpdate_WithOpaqueCustomCredentials.json | 10 ++- 18 files changed, 309 insertions(+), 31 deletions(-) create mode 100644 specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/RegistriesScheduleRun_WithLogTemplate.json create mode 100644 specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksCreate_QuickTask.json create mode 100644 specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksUpdate_QuickTask.json diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/containerregistry_build.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/containerregistry_build.json index 8f4a653587c2..33c8f670d108 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/containerregistry_build.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/containerregistry_build.json @@ -382,6 +382,9 @@ }, "Registries_ScheduleRun_WithCustomCredentials": { "$ref": "./examples/RegistriesScheduleRun_WithCustomCredentials.json" + }, + "Registries_ScheduleRun_WithLogTemplate": { + "$ref": "./examples/RegistriesScheduleRun_WithLogTemplate.json" } } } @@ -1154,6 +1157,9 @@ }, "Tasks_Create_WithUserIdentities": { "$ref": "./examples/ManagedIdentity/TasksCreate_WithUserIdentities.json" + }, + "Tasks_Create_QuickTask": { + "$ref": "./examples/TasksCreate_QuickTask.json" } } }, @@ -1269,6 +1275,9 @@ }, "Tasks_Update_WithOpaqueCustomCredentials": { "$ref": "./examples/TasksUpdate_WithOpaqueCustomCredentials.json" + }, + "Tasks_Update_QuickTask": { + "$ref": "./examples/TasksUpdate_QuickTask.json" } } } @@ -1459,6 +1468,10 @@ "agentPoolName": { "description": "The dedicated agent pool for the run.", "type": "string" + }, + "logTemplate": { + "description": "The template that describes the repository and tag information for run log artifact.", + "type": "string" } }, "discriminator": "type" @@ -1594,6 +1607,11 @@ "description": "The update trigger token passed for the Run.", "type": "string" }, + "logArtifact": { + "$ref": "#/definitions/ImageDescriptor", + "description": "The image description for the log artifact.", + "readOnly": true + }, "provisioningState": { "description": "The provisioning state of a run.", "enum": [ @@ -2095,10 +2113,6 @@ }, "TaskProperties": { "description": "The properties of a task.", - "required": [ - "platform", - "step" - ], "type": "object", "properties": { "provisioningState": { @@ -2167,6 +2181,15 @@ "credentials": { "$ref": "#/definitions/Credentials", "description": "The properties that describes a set of credentials that will be used when this run is invoked." + }, + "logTemplate": { + "description": "The template that describes the repository and tag information for run log artifact.", + "type": "string" + }, + "isSystemTask": { + "description": "The value of this property indicates whether the task resource is system task or not.", + "default": false, + "type": "boolean" } } }, @@ -2614,6 +2637,10 @@ "credentials": { "$ref": "#/definitions/Credentials", "description": "The parameters that describes a set of credentials that will be used when this run is invoked." + }, + "logTemplate": { + "description": "The template that describes the repository and tag information for run log artifact.", + "type": "string" } } }, diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/ManagedIdentity/TasksCreate_WithSystemAndUserIdentities.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/ManagedIdentity/TasksCreate_WithSystemAndUserIdentities.json index 98a8d6b98259..c19f52749dc3 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/ManagedIdentity/TasksCreate_WithSystemAndUserIdentities.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/ManagedIdentity/TasksCreate_WithSystemAndUserIdentities.json @@ -67,7 +67,9 @@ "updateTriggerEndpoint": "https://user:pass@mycicd.webhook.com?token=foo", "updateTriggerPayloadType": "Default" } - } + }, + "isSystemTask": false, + "logTemplate": null }, "location": "eastus", "identity": { @@ -141,7 +143,9 @@ "updateTriggerEndpoint": null, "updateTriggerPayloadType": "Default" } - } + }, + "isSystemTask": false, + "logTemplate": null }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", "name": "myTask", @@ -222,7 +226,9 @@ "updateTriggerEndpoint": null, "updateTriggerPayloadType": "Default" } - } + }, + "isSystemTask": false, + "logTemplate": null }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", "name": "myTask", diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/ManagedIdentity/TasksCreate_WithSystemIdentity.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/ManagedIdentity/TasksCreate_WithSystemIdentity.json index eeeb532c2556..d17ccca5c89f 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/ManagedIdentity/TasksCreate_WithSystemIdentity.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/ManagedIdentity/TasksCreate_WithSystemIdentity.json @@ -65,7 +65,9 @@ "name": "myBaseImageTrigger", "baseImageTriggerType": "Runtime" } - } + }, + "isSystemTask": false, + "logTemplate": null }, "location": "eastus", "identity": { @@ -134,7 +136,9 @@ "status": "Enabled", "baseImageTriggerType": "Runtime" } - } + }, + "isSystemTask": false, + "logTemplate": null }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", "name": "myTask", @@ -207,7 +211,9 @@ "status": "Enabled", "baseImageTriggerType": "Runtime" } - } + }, + "isSystemTask": false, + "logTemplate": null }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", "name": "myTask", diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/ManagedIdentity/TasksCreate_WithUserIdentities.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/ManagedIdentity/TasksCreate_WithUserIdentities.json index 06577bf137e2..faf70131a4de 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/ManagedIdentity/TasksCreate_WithUserIdentities.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/ManagedIdentity/TasksCreate_WithUserIdentities.json @@ -67,7 +67,9 @@ "updateTriggerEndpoint": "https://user:pass@mycicd.webhook.com?token=foo", "updateTriggerPayloadType": "Default" } - } + }, + "isSystemTask": false, + "logTemplate": null }, "location": "eastus", "identity": { @@ -142,7 +144,9 @@ "updateTriggerEndpoint": null, "updateTriggerPayloadType": "Default" } - } + }, + "isSystemTask": false, + "logTemplate": null }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", "name": "myTask", @@ -225,7 +229,9 @@ "updateTriggerEndpoint": null, "updateTriggerPayloadType": "Default" } - } + }, + "isSystemTask": false, + "logTemplate": null }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", "name": "myTask", diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/ManagedIdentity/TasksUpdate_WithKeyVaultCustomCredentials.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/ManagedIdentity/TasksUpdate_WithKeyVaultCustomCredentials.json index edbd95c29df8..50ecf2ddaab9 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/ManagedIdentity/TasksUpdate_WithKeyVaultCustomCredentials.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/ManagedIdentity/TasksUpdate_WithKeyVaultCustomCredentials.json @@ -48,7 +48,8 @@ "identity": "[system]" } } - } + }, + "logTemplate": null }, "tags": { "testkey": "value" @@ -121,7 +122,8 @@ "myregistry.azurecr.io": null }, "sourceRegistry": null - } + }, + "logTemplate": null }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", "name": "myTask", @@ -202,7 +204,8 @@ "myregistry.azurecr.io": null }, "sourceRegistry": null - } + }, + "logTemplate": null }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", "name": "myTask", diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/ManagedIdentity/TasksUpdate_WithMSICustomCredentials.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/ManagedIdentity/TasksUpdate_WithMSICustomCredentials.json index fc5ca27f5bcd..031821d89740 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/ManagedIdentity/TasksUpdate_WithMSICustomCredentials.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/ManagedIdentity/TasksUpdate_WithMSICustomCredentials.json @@ -40,7 +40,8 @@ "identity": "[system]" } } - } + }, + "logTemplate": null }, "tags": { "testkey": "value" @@ -111,7 +112,8 @@ "myregistry.azure.io": null }, "sourceRegistry": null - } + }, + "logTemplate": null }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", "name": "myTask", @@ -190,7 +192,8 @@ "myregistry.azure.io": null }, "sourceRegistry": null - } + }, + "logTemplate": null }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", "name": "myTask", diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/RegistriesScheduleRun_WithLogTemplate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/RegistriesScheduleRun_WithLogTemplate.json new file mode 100644 index 000000000000..5f78b70041b5 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/RegistriesScheduleRun_WithLogTemplate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-06-01-preview", + "runRequest": { + "type": "DockerBuildRequest", + "isArchiveEnabled": true, + "imageNames": [ + "azurerest:testtag" + ], + "noCache": true, + "sourceLocation": "https://myaccount.blob.core.windows.net/sascontainer/source.zip?sv=2015-04-05&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D", + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ], + "isPushEnabled": true, + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + }, + "dockerFilePath": "DockerFile", + "logTemplate": "acr/tasks:{{.Run.OS}}" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "runId": "0accec26-d6de-4757-8e74-d080f38eaaab", + "status": "Succeeded", + "lastUpdatedTime": "2018-01-25T05:13:51.617Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab", + "name": "0accec26-d6de-4757-8e74-d080f38eaaab", + "type": "Microsoft.ContainerRegistry/registries/run" + } + }, + "202": {} + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/RunsGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/RunsGet.json index cd6d56392ffd..5df1bb3606f4 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/RunsGet.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/RunsGet.json @@ -46,6 +46,12 @@ }, "agentConfiguration": { "cpu": 2 + }, + "logArtifact": { + "digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0", + "registry": "myregistry", + "repository": "acr/tasks", + "tag": "mytask-0accec26-d6de-4757-8e74-d080f38eaaab-log" } }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab", diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/RunsList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/RunsList.json index 08cf3291f7c3..59743c38a91d 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/RunsList.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/RunsList.json @@ -49,6 +49,12 @@ }, "agentConfiguration": { "cpu": 2 + }, + "logArtifact": { + "digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0", + "registry": "myregistry", + "repository": "acr/tasks", + "tag": "mytask-0accec26-d6de-4757-8e74-d080f38eaaab-log" } }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab", diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/RunsUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/RunsUpdate.json index 67554f360bd5..a6f2cc6fbbcb 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/RunsUpdate.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/RunsUpdate.json @@ -49,6 +49,12 @@ }, "agentConfiguration": { "cpu": 2 + }, + "logArtifact": { + "digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0", + "registry": "myregistry", + "repository": "acr/tasks", + "tag": "mytask-0accec26-d6de-4757-8e74-d080f38eaaab-log" } }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab", @@ -95,6 +101,12 @@ }, "agentConfiguration": { "cpu": 2 + }, + "logArtifact": { + "digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0", + "registry": "myregistry", + "repository": "acr/tasks", + "tag": "mytask-0accec26-d6de-4757-8e74-d080f38eaaab-log" } }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab", diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksCreate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksCreate.json index 6200b73c0b1e..059a023711c4 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksCreate.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksCreate.json @@ -67,7 +67,9 @@ "updateTriggerEndpoint": "https://user:pass@mycicd.webhook.com?token=foo", "updateTriggerPayloadType": "Token" } - } + }, + "isSystemTask": false, + "logTemplate": "acr/tasks:{{.Run.OS}}" }, "location": "eastus", "identity": { @@ -138,7 +140,9 @@ "updateTriggerEndpoint": null, "updateTriggerPayloadType": "Token" } - } + }, + "isSystemTask": false, + "logTemplate": "acr/tasks:{{.Run.OS}}" }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", "name": "myTask", @@ -213,7 +217,9 @@ "updateTriggerEndpoint": null, "updateTriggerPayloadType": "Token" } - } + }, + "isSystemTask": false, + "logTemplate": "acr/tasks:{{.Run.OS}}" }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", "name": "myTask", diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksCreate_QuickTask.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksCreate_QuickTask.json new file mode 100644 index 000000000000..1766aa626b10 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksCreate_QuickTask.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-06-01-preview", + "taskName": "quicktask", + "taskCreateParameters": { + "properties": { + "status": "Enabled", + "isSystemTask": true, + "logTemplate": "acr/tasks:{{.Run.OS}}" + }, + "location": "eastus", + "identity": null, + "tags": { + "testkey": "value" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": null, + "agentConfiguration": null, + "trigger": null, + "isSystemTask": true, + "logTemplate": "acr/tasks:{{.Run.OS}}" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "quicktask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": null, + "tags": { + "testkey": "value" + } + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Creating", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": null, + "agentConfiguration": null, + "trigger": null, + "isSystemTask": true, + "logTemplate": "acr/tasks:{{.Run.OS}}" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "quicktask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": null, + "tags": { + "testkey": "value" + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksGet.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksGet.json index 35233c27670d..76a4c616f2d7 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksGet.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksGet.json @@ -72,7 +72,9 @@ "myregistry.azure.io": null }, "sourceRegistry": null - } + }, + "isSystemTask": false, + "logTemplate": null }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", "name": "myTask", diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksGetDetails.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksGetDetails.json index a68531461844..c10ac1068236 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksGetDetails.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksGetDetails.json @@ -89,7 +89,9 @@ } }, "sourceRegistry": null - } + }, + "isSystemTask": false, + "logTemplate": null }, "location": "eastus", "identity": { diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksList.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksList.json index f76332bc0790..0953671b5f8a 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksList.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksList.json @@ -73,7 +73,9 @@ "myRegistry.azure.io": null }, "sourceRegistry": null - } + }, + "isSystemTask": false, + "logTemplate": null }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", "name": "myTask", diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksUpdate.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksUpdate.json index fb0e6621cb2e..bcc5d2966d67 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksUpdate.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksUpdate.json @@ -48,7 +48,8 @@ "identity": "[system]" } } - } + }, + "logTemplate": "acr/tasks:{{.Run.OS}}" }, "tags": { "testkey": "value" @@ -121,7 +122,8 @@ "myregistry.azurecr.io": null }, "sourceRegistry": null - } + }, + "logTemplate": "acr/tasks:{{.Run.OS}}" }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", "name": "myTask", @@ -202,7 +204,8 @@ "myregistry.azurecr.io": null }, "sourceRegistry": null - } + }, + "logTemplate": "acr/tasks:{{.Run.OS}}" }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", "name": "myTask", diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksUpdate_QuickTask.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksUpdate_QuickTask.json new file mode 100644 index 000000000000..7d067bad1519 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksUpdate_QuickTask.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2019-06-01-preview", + "taskName": "quicktask", + "taskUpdateParameters": { + "properties": { + "status": "Enabled", + "logTemplate": "acr/tasks:{{.Run.OS}}" + }, + "tags": { + "testkey": "value" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": null, + "agentConfiguration": null, + "trigger": null, + "logTemplate": "acr/tasks:{{.Run.OS}}" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "myTask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": null, + "tags": { + "testkey": "value" + } + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-01-25T06:54:23.536Z", + "status": "Enabled", + "platform": null, + "agentConfiguration": null, + "trigger": null, + "logTemplate": "acr/tasks:{{.Run.OS}}" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", + "name": "quicktask", + "type": "Microsoft.ContainerRegistry/registries/tasks", + "location": "eastus", + "identity": null, + "tags": { + "testkey": "value" + } + } + } + } +} diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksUpdate_WithOpaqueCustomCredentials.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksUpdate_WithOpaqueCustomCredentials.json index 8072e5b19b6e..70a55b828b9e 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksUpdate_WithOpaqueCustomCredentials.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/examples/TasksUpdate_WithOpaqueCustomCredentials.json @@ -47,7 +47,8 @@ } } } - } + }, + "logTemplate": null }, "tags": { "testkey": "value" @@ -118,7 +119,8 @@ "myregistry.azure.io": null }, "sourceRegistry": null - } + }, + "logTemplate": null }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", "name": "myTask", @@ -197,7 +199,9 @@ "myregistry.azure.io": null }, "sourceRegistry": null - } + }, + "isSystemTask": false, + "logTemplate": null }, "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask", "name": "myTask", From d3339cad1a5115b61f89cc432e67150d6d425f78 Mon Sep 17 00:00:00 2001 From: navysingla <47647464+navysingla@users.noreply.github.com> Date: Tue, 8 Sep 2020 19:52:37 -0700 Subject: [PATCH 016/164] Update subscriptions.json (#10709) --- .../stable/2020-09-01/subscriptions.json | 5 ----- 1 file changed, 5 deletions(-) diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/stable/2020-09-01/subscriptions.json b/specification/subscription/resource-manager/Microsoft.Subscription/stable/2020-09-01/subscriptions.json index 060fc0f8c40b..a4c186194cff 100644 --- a/specification/subscription/resource-manager/Microsoft.Subscription/stable/2020-09-01/subscriptions.json +++ b/specification/subscription/resource-manager/Microsoft.Subscription/stable/2020-09-01/subscriptions.json @@ -436,11 +436,6 @@ }, "PutAliasRequestProperties": { "description": "Put subscription properties.", - "required": [ - "displayName", - "workload", - "billingScope" - ], "properties": { "displayName": { "description": "The friendly name of the subscription.", From 2b484e646e2bf5a389af40c619fa57fc83e74f7f Mon Sep 17 00:00:00 2001 From: Phoenix He Date: Wed, 9 Sep 2020 10:56:10 +0800 Subject: [PATCH 017/164] Make a switch for schema generation (#10732) --- .azure-pipelines/SDKAutomation.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.azure-pipelines/SDKAutomation.yml b/.azure-pipelines/SDKAutomation.yml index b7caf8aa83e8..4cd770c7861d 100644 --- a/.azure-pipelines/SDKAutomation.yml +++ b/.azure-pipelines/SDKAutomation.yml @@ -41,6 +41,7 @@ jobs: SDK_REPO_NAME: azure-sdk-for-go Trenton: SDK_REPO_NAME: azure-sdk-for-trenton + ${{ if eq(variables['ENABLE_RESOURCE_MANAGER_SCHEMAS'], 'true') }}: Schema: SDK_REPO_NAME: azure-resource-manager-schemas steps: From 38e0aab7adf620e78a41c86f42972ca578130f37 Mon Sep 17 00:00:00 2001 From: ajaygit158 <61898818+ajaygit158@users.noreply.github.com> Date: Wed, 9 Sep 2020 09:23:39 +0530 Subject: [PATCH 018/164] =?UTF-8?q?Updated=20the=20CSharp,=20Python=20and?= =?UTF-8?q?=20GO=20SDK=20namespace=20to=20Microsoft.Migrate.ResourceMover?= =?UTF-8?q?=20and=20=E2=80=A6=20(#10661)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Updated the CSharp SDK namespace to Microsoft.Migrate.RegionMove and updated the output folder to match the folder structure in .NET SDK. * Updated namespace and package names of csharp, go and python * Updates * fix schemas parameter Co-authored-by: Ajay Gupta Co-authored-by: Lei Ni <7233663+leni-msft@users.noreply.github.com> --- .../2019-10-01-preview/regionmovecollection.json | 6 +++--- .../regionmove/resource-manager/readme.csharp.md | 4 ++-- specification/regionmove/resource-manager/readme.go.md | 2 +- specification/regionmove/resource-manager/readme.md | 2 +- .../regionmove/resource-manager/readme.python.md | 10 +++++----- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json index b73feabd34b7..c755d87cc0f4 100644 --- a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json +++ b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Region Move Service API", + "title": "Resource Mover Service API", "description": "A first party Azure service orchestrating the move of Azure resources from one Azure region to another or between zones within a region.", "version": "2019-10-01-preview" }, @@ -900,7 +900,7 @@ }, "definitions": { "ResourceIdentityType": { - "description": "The type of identity used for the region move service.", + "description": "The type of identity used for the resource mover service.", "enum": [ "None", "SystemAssigned", @@ -1540,7 +1540,7 @@ "$ref": "#/definitions/MoveResourceErrorBody" } }, - "description": "An error response from the azure region move service." + "description": "An error response from the azure resource mover service." }, "MoveResourceErrorBody": { "properties": { diff --git a/specification/regionmove/resource-manager/readme.csharp.md b/specification/regionmove/resource-manager/readme.csharp.md index f8de1d553f88..b7f74831a8c8 100644 --- a/specification/regionmove/resource-manager/readme.csharp.md +++ b/specification/regionmove/resource-manager/readme.csharp.md @@ -10,6 +10,6 @@ csharp: payload-flattening-threshold: 1 clear-output-folder: true client-side-validation: false - namespace: Microsoft.Migrate - output-folder: $(csharp-sdks-folder)/regionmove/management/Microsoft.Migrate/GeneratedProtocol + namespace: Microsoft.Azure.Management.Migrate.ResourceMover + output-folder: $(csharp-sdks-folder)/resourcemover/Microsoft.Azure.Management.Migrate/src/Generated ``` diff --git a/specification/regionmove/resource-manager/readme.go.md b/specification/regionmove/resource-manager/readme.go.md index 09eb467bdff3..a1604f9f508a 100644 --- a/specification/regionmove/resource-manager/readme.go.md +++ b/specification/regionmove/resource-manager/readme.go.md @@ -5,7 +5,7 @@ These settings apply only when `--go` is specified on the command line. ```yaml $(go) go: license-header: MICROSOFT_APACHE_NO_VERSION - namespace: regionmove + namespace: resourcemover clear-output-folder: true ``` diff --git a/specification/regionmove/resource-manager/readme.md b/specification/regionmove/resource-manager/readme.md index 436d80c6d82a..66399702cbaf 100644 --- a/specification/regionmove/resource-manager/readme.md +++ b/specification/regionmove/resource-manager/readme.md @@ -56,7 +56,7 @@ swagger-to-sdk: - repo: azure-sdk-for-js - repo: azure-sdk-for-ruby after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_regionmove'] + - bundle install && rake arm:regen_all_profiles['azure_mgmt_resourcemover'] - repo: azure-resource-manager-schemas after_scripts: - node sdkauto_afterscript.js regionmove/resource-manager diff --git a/specification/regionmove/resource-manager/readme.python.md b/specification/regionmove/resource-manager/readme.python.md index 8ced78319d88..fc7f313f9e22 100644 --- a/specification/regionmove/resource-manager/readme.python.md +++ b/specification/regionmove/resource-manager/readme.python.md @@ -8,8 +8,8 @@ python: azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION payload-flattening-threshold: 2 - namespace: azure.mgmt.regionmove - package-name: azure-mgmt-regionmove + namespace: azure.mgmt.resourcemover + package-name: azure-mgmt-resourcemover package-version: 0.1.0-preview clear-output-folder: true ``` @@ -17,7 +17,7 @@ python: ```yaml $(python) && $(track2) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION -package-name: azure-mgmt-regionmove +package-name: azure-mgmt-resourcemover clear-output-folder: true no-namespace-folders: true package-version: 0.1.0-preview @@ -25,11 +25,11 @@ package-version: 0.1.0-preview ```yaml $(python) && $(python-mode) == 'update' no-namespace-folders: true -output-folder: $(python-sdks-folder)/regionmove/azure-mgmt-regionmove/azure/mgmt/regionmove +output-folder: $(python-sdks-folder)/resourcemover/azure-mgmt-resourcemover/azure/mgmt/resourcemover ``` ``` yaml $(python) && $(python-mode) == 'create' python: basic-setup-py: true - output-folder: $(python-sdks-folder)/regionmove/azure-mgmt-regionmove + output-folder: $(python-sdks-folder)/resourcemover/azure-mgmt-resourcemover ``` From ae862b1c090b4c2c951ea46bf97ddbafd6f76d82 Mon Sep 17 00:00:00 2001 From: Phoenix He Date: Wed, 9 Sep 2020 13:58:54 +0800 Subject: [PATCH 019/164] Enable private repo support in SDK Automation (#10734) --- specificationRepositoryConfiguration.json | 41 +++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/specificationRepositoryConfiguration.json b/specificationRepositoryConfiguration.json index 31141d585fbe..23e916da5473 100644 --- a/specificationRepositoryConfiguration.json +++ b/specificationRepositoryConfiguration.json @@ -46,5 +46,46 @@ "integrationRepository": "AzureSDKAutomation/azure-resource-manager-schemas", "mainRepository": "Azure/azure-resource-manager-schemas" } + }, + "overrides": { + "Azure/azure-rest-api-specs-pr": { + "sdkRepositoryMappings": { + "azure-sdk-for-go": { + "integrationRepository": "azure-sdk/azure-sdk-for-go-pr", + "mainRepository": "Azure/azure-sdk-for-go-pr" + }, + "azure-sdk-for-java": { + "integrationRepository": "azure-sdk/azure-sdk-for-java-pr", + "mainRepository": "Azure/azure-sdk-for-java-pr" + }, + "azure-sdk-for-js": { + "integrationRepository": "azure-sdk/azure-sdk-for-js-pr", + "mainRepository": "Azure/azure-sdk-for-js-pr" + }, + "azure-sdk-for-net": { + "integrationRepository": "azure-sdk/azure-sdk-for-net-pr", + "mainRepository": "Azure/azure-sdk-for-net-pr" + }, + "azure-sdk-for-python": { + "integrationRepository": "azure-sdk/azure-sdk-for-python-pr", + "mainRepository": "Azure/azure-sdk-for-python-pr", + "mainBranch": "release/v3" + }, + "azure-sdk-for-python-track2": { + "integrationRepository": "azure-sdk/azure-sdk-for-python-pr", + "mainRepository": "Azure/azure-sdk-for-python-pr" + }, + "azure-cli-extensions": { + "integrationRepository": "azure-sdk/azure-cli-extensions-pr", + "mainRepository": "Azure/azure-cli-extensions-pr" + }, + "azure-sdk-for-trenton": { + "integrationRepository": "Azure/azure-sdk-for-trenton", + "mainRepository": "Azure/azure-sdk-for-trenton", + "secondaryRepository": "Azure/azure-sdk-for-trenton", + "secondaryBranch": "secondary" + } + } + } } } From 0318e0726b76ce83ee5079fa5dc3b86036eb45b6 Mon Sep 17 00:00:00 2001 From: QingqingYuan2 <43078227+QingqingYuan2@users.noreply.github.com> Date: Tue, 8 Sep 2020 23:40:17 -0700 Subject: [PATCH 020/164] add required fields for sku object (#10623) * add required fields for sku object * fix prettier * fix lint errors * fix prettier * fix lint errors * Fix lint errors * fix sdk eorror * add default response * Fix checknameavailability response * fix prettier * add default result for operations * Remove proxy resource definition * supress the provider name check * Remove duplicate Resource definition * removed duplicate tracked resource definition --- .../preview/2018-06-01-preview/mariadb.json | 102 +++-------- .../PrivateEndpointConnections.json | 34 +--- .../PrivateLinkResources.json | 34 +--- .../2018-06-01-privatepreview/mariadb.json | 138 +++++--------- .../DataEncryptionKeys.json | 23 +-- .../stable/2018-06-01/mariadb.json | 173 ++++++++++++++++-- .../mariadb/resource-manager/readme.md | 1 - .../preview/2017-12-01-preview/mysql.json | 104 ++++------- .../PrivateEndpointConnections.json | 34 +--- .../PrivateLinkResources.json | 34 +--- .../2018-06-01-privatepreview/mysql.json | 140 +++++--------- .../DataEncryptionKeys.json | 23 +-- .../stable/2017-12-01/mysql.json | 41 +++-- .../2017-12-01-preview/postgresql.json | 104 ++++------- .../PrivateEndpointConnections.json | 34 +--- .../PrivateLinkResources.json | 34 +--- .../DataEncryptionKeys.json | 23 +-- .../2020-02-14-privatepreview/postgresql.json | 4 + .../stable/2017-12-01/postgresql.json | 67 +++---- 19 files changed, 399 insertions(+), 748 deletions(-) diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/mariadb.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/mariadb.json index bedcb77ea9d4..ab42b506a658 100644 --- a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/mariadb.json +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/mariadb.json @@ -34,7 +34,7 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}": { "put": { "tags": [ "Servers" @@ -217,7 +217,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers": { "get": { "tags": [ "Servers" @@ -253,7 +253,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/servers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/servers": { "get": { "tags": [ "Servers" @@ -286,7 +286,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/restart": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/restart": { "post": { "tags": [ "ServerRestart" @@ -329,7 +329,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/replicas": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/replicas": { "get": { "tags": [ "Replicas" @@ -368,7 +368,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/firewallRules/{firewallRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/firewallRules/{firewallRuleName}": { "put": { "tags": [ "FirewallRules" @@ -504,7 +504,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/firewallRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/firewallRules": { "get": { "tags": [ "FirewallRules" @@ -543,7 +543,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { "get": { "tags": [ "VirtualNetworkRules" @@ -688,7 +688,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/virtualNetworkRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/virtualNetworkRules": { "get": { "tags": [ "VirtualNetworkRules" @@ -730,7 +730,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/databases/{databaseName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/databases/{databaseName}": { "put": { "tags": [ "Databases" @@ -866,7 +866,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/databases": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/databases": { "get": { "tags": [ "Databases" @@ -905,7 +905,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/configurations/{configurationName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/configurations/{configurationName}": { "put": { "tags": [ "Configurations" @@ -994,7 +994,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/configurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/configurations": { "get": { "tags": [ "Configurations" @@ -1033,7 +1033,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/logFiles": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/logFiles": { "get": { "tags": [ "LogFiles" @@ -1072,7 +1072,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/locations/{locationName}/performanceTiers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/locations/{locationName}/performanceTiers": { "get": { "tags": [ "LocationBasedPerformanceTier" @@ -1108,7 +1108,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/checkNameAvailability": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/checkNameAvailability": { "post": { "tags": [ "CheckNameAvailability" @@ -1147,7 +1147,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { "get": { "tags": [ "ServerSecurityAlertPolicies" @@ -1267,7 +1267,7 @@ } } }, - "/providers/Microsoft.DBforMariaDB/operations": { + "/providers/Microsoft.DBForMariaDB/operations": { "get": { "tags": [ "Operations" @@ -1320,55 +1320,6 @@ "modelAsString": false } }, - "ProxyResource": { - "description": "Resource properties.", - "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." - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "Resource properties including location and tags for track resources.", - "properties": { - "location": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "The location the resource resides in." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Application-specific metadata in the form of key-value pairs." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "required": [ - "location" - ] - }, "ServerProperties": { "properties": { "administratorLogin": { @@ -1617,6 +1568,9 @@ "description": "The family of hardware." } }, + "required": [ + "name" + ], "description": "Billing information related properties of a server." }, "ResourceIdentity": { @@ -1666,7 +1620,7 @@ }, "allOf": [ { - "$ref": "#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" } ], "description": "Represents a server." @@ -1784,7 +1738,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "required": [ @@ -1842,7 +1796,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -1895,7 +1849,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a Database." @@ -1955,7 +1909,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a Configuration." @@ -2093,7 +2047,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a log file." @@ -2267,7 +2221,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json index bbebc6ce6786..5677f4ba6c98 100644 --- a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json @@ -346,44 +346,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "PrivateEndpointConnection": { "description": "A private endpoint connection", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/PrivateLinkResources.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/PrivateLinkResources.json index 9e40fcfd7a25..15ba0297e005 100644 --- a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/PrivateLinkResources.json +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/PrivateLinkResources.json @@ -168,44 +168,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "PrivateLinkResource": { "description": "A private link resource", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/mariadb.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/mariadb.json index 786f1c580abb..ab4d06779f92 100644 --- a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/mariadb.json +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/mariadb.json @@ -34,7 +34,7 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}": { "put": { "tags": [ "Servers" @@ -217,7 +217,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers": { "get": { "tags": [ "Servers" @@ -253,7 +253,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/servers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/servers": { "get": { "tags": [ "Servers" @@ -286,7 +286,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/restart": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/restart": { "post": { "tags": [ "ServerRestart" @@ -329,7 +329,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/replicas": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/replicas": { "get": { "tags": [ "Replicas" @@ -368,7 +368,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/firewallRules/{firewallRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/firewallRules/{firewallRuleName}": { "put": { "tags": [ "FirewallRules" @@ -504,7 +504,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/firewallRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/firewallRules": { "get": { "tags": [ "FirewallRules" @@ -543,7 +543,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { "get": { "tags": [ "VirtualNetworkRules" @@ -688,7 +688,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/virtualNetworkRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/virtualNetworkRules": { "get": { "tags": [ "VirtualNetworkRules" @@ -730,7 +730,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/databases/{databaseName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/databases/{databaseName}": { "put": { "tags": [ "Databases" @@ -866,7 +866,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/databases": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/databases": { "get": { "tags": [ "Databases" @@ -905,7 +905,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/configurations/{configurationName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/configurations/{configurationName}": { "put": { "tags": [ "Configurations" @@ -994,7 +994,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/configurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/configurations": { "get": { "tags": [ "Configurations" @@ -1033,7 +1033,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/logFiles": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/logFiles": { "get": { "tags": [ "LogFiles" @@ -1072,7 +1072,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/locations/{locationName}/performanceTiers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/locations/{locationName}/performanceTiers": { "get": { "tags": [ "LocationBasedPerformanceTier" @@ -1108,7 +1108,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/checkNameAvailability": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/checkNameAvailability": { "post": { "tags": [ "CheckNameAvailability" @@ -1147,7 +1147,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { "get": { "tags": [ "ServerSecurityAlertPolicies" @@ -1267,7 +1267,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/queryTexts/{queryId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/queryTexts/{queryId}": { "get": { "tags": [ "QueryTexts" @@ -1306,7 +1306,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/queryTexts": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/queryTexts": { "get": { "tags": [ "QueryTexts" @@ -1356,7 +1356,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/topQueryStatistics/{queryStatisticId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/topQueryStatistics/{queryStatisticId}": { "get": { "tags": [ "TopQueryStatistics" @@ -1395,7 +1395,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/topQueryStatistics": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/topQueryStatistics": { "get": { "tags": [ "TopQueryStatistics" @@ -1443,7 +1443,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/waitStatistics/{waitStatisticsId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/waitStatistics/{waitStatisticsId}": { "get": { "tags": [ "WaitStatistics" @@ -1482,7 +1482,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/waitStatistics": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/waitStatistics": { "get": { "tags": [ "WaitStatistics" @@ -1530,7 +1530,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/advisors/{advisorName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/advisors/{advisorName}": { "get": { "tags": [ "Advisors" @@ -1569,7 +1569,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/advisors": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/advisors": { "get": { "tags": [ "Advisors" @@ -1608,7 +1608,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/advisors/{advisorName}/createRecommendedActionSession": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/advisors/{advisorName}/createRecommendedActionSession": { "post": { "tags": [ "RecommendedActionSessions" @@ -1655,7 +1655,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/advisors/{advisorName}/recommendedActions/{recommendedActionName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/advisors/{advisorName}/recommendedActions/{recommendedActionName}": { "get": { "tags": [ "RecommendedActions" @@ -1697,7 +1697,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/advisors/{advisorName}/recommendedActions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/advisors/{advisorName}/recommendedActions": { "get": { "tags": [ "RecommendedActions" @@ -1746,7 +1746,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/locations/{locationName}/recommendedActionSessionsAzureAsyncOperation/{operationId}": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/locations/{locationName}/recommendedActionSessionsAzureAsyncOperation/{operationId}": { "get": { "tags": [ "LocationBasedRecommendedActionSessionsOperationStatus" @@ -1782,7 +1782,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/locations/{locationName}/recommendedActionSessionsOperationResults/{operationId}": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/locations/{locationName}/recommendedActionSessionsOperationResults/{operationId}": { "get": { "tags": [ "LocationBasedRecommendedActionSessionsResult" @@ -1827,7 +1827,7 @@ } } }, - "/providers/Microsoft.DBforMariaDB/operations": { + "/providers/Microsoft.DBForMariaDB/operations": { "get": { "tags": [ "Operations" @@ -1880,55 +1880,6 @@ "modelAsString": false } }, - "ProxyResource": { - "description": "Resource properties.", - "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." - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "Resource properties including location and tags for track resources.", - "properties": { - "location": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "The location the resource resides in." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Application-specific metadata in the form of key-value pairs." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "required": [ - "location" - ] - }, "ServerProperties": { "properties": { "administratorLogin": { @@ -2177,6 +2128,9 @@ "description": "The family of hardware." } }, + "required": [ + "name" + ], "description": "Billing information related properties of a server." }, "ResourceIdentity": { @@ -2226,7 +2180,7 @@ }, "allOf": [ { - "$ref": "#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" } ], "description": "Represents a server." @@ -2344,7 +2298,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "required": [ @@ -2402,7 +2356,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -2455,7 +2409,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a Database." @@ -2515,7 +2469,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a Configuration." @@ -2653,7 +2607,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a log file." @@ -2827,7 +2781,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -2895,7 +2849,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a Query Text." @@ -3034,7 +2988,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a Query Statistic." @@ -3152,7 +3106,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a Wait Statistic." @@ -3190,7 +3144,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a recommendation action advisor." @@ -3267,7 +3221,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a Recommendation Action." diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2020-01-01-privatepreview/DataEncryptionKeys.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2020-01-01-privatepreview/DataEncryptionKeys.json index 1d83304cfc21..59bda202b839 100644 --- a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2020-01-01-privatepreview/DataEncryptionKeys.json +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2020-01-01-privatepreview/DataEncryptionKeys.json @@ -223,27 +223,6 @@ } }, "definitions": { - "ProxyResource": { - "description": "Resource properties.", - "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." - } - }, - "x-ms-azure-resource": true - }, "ServerKeyListResult": { "description": "A list of MariaDB Server keys.", "type": "object", @@ -298,7 +277,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/mariadb.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/mariadb.json index 67c9a6fc75b9..efb2c9abf984 100644 --- a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/mariadb.json +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/mariadb.json @@ -34,7 +34,7 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}": { "put": { "tags": [ "Servers" @@ -93,6 +93,12 @@ }, "202": { "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true @@ -140,6 +146,12 @@ }, "202": { "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true @@ -178,6 +190,12 @@ }, "204": { "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true @@ -213,11 +231,17 @@ "schema": { "$ref": "#/definitions/Server" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers": { "get": { "tags": [ "Servers" @@ -246,6 +270,12 @@ "schema": { "$ref": "#/definitions/ServerListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-pageable": { @@ -253,7 +283,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/servers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/servers": { "get": { "tags": [ "Servers" @@ -279,6 +309,12 @@ "schema": { "$ref": "#/definitions/ServerListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-pageable": { @@ -286,7 +322,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/restart": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/restart": { "post": { "tags": [ "ServerRestart" @@ -329,7 +365,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/replicas": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/replicas": { "get": { "tags": [ "Replicas" @@ -361,6 +397,12 @@ "schema": { "$ref": "#/definitions/ServerListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-pageable": { @@ -368,7 +410,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/firewallRules/{firewallRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/firewallRules/{firewallRuleName}": { "put": { "tags": [ "FirewallRules" @@ -421,6 +463,12 @@ }, "202": { "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true @@ -462,6 +510,12 @@ }, "204": { "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true @@ -500,11 +554,17 @@ "schema": { "$ref": "#/definitions/FirewallRule" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/firewallRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/firewallRules": { "get": { "tags": [ "FirewallRules" @@ -536,6 +596,12 @@ "schema": { "$ref": "#/definitions/FirewallRuleListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-pageable": { @@ -543,7 +609,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { "get": { "tags": [ "VirtualNetworkRules" @@ -688,7 +754,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/virtualNetworkRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/virtualNetworkRules": { "get": { "tags": [ "VirtualNetworkRules" @@ -730,7 +796,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/databases/{databaseName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/databases/{databaseName}": { "put": { "tags": [ "Databases" @@ -783,6 +849,12 @@ }, "202": { "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true @@ -824,6 +896,12 @@ }, "204": { "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true @@ -862,11 +940,17 @@ "schema": { "$ref": "#/definitions/Database" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/databases": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/databases": { "get": { "tags": [ "Databases" @@ -898,6 +982,12 @@ "schema": { "$ref": "#/definitions/DatabaseListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-pageable": { @@ -905,7 +995,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/configurations/{configurationName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/configurations/{configurationName}": { "put": { "tags": [ "Configurations" @@ -952,6 +1042,12 @@ }, "202": { "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true @@ -990,11 +1086,17 @@ "schema": { "$ref": "#/definitions/Configuration" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/configurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/configurations": { "get": { "tags": [ "Configurations" @@ -1026,6 +1128,12 @@ "schema": { "$ref": "#/definitions/ConfigurationListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-pageable": { @@ -1033,7 +1141,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/logFiles": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMariaDB/servers/{serverName}/logFiles": { "get": { "tags": [ "LogFiles" @@ -1065,6 +1173,12 @@ "schema": { "$ref": "#/definitions/LogFileListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-pageable": { @@ -1072,7 +1186,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/locations/{locationName}/performanceTiers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/locations/{locationName}/performanceTiers": { "get": { "tags": [ "LocationBasedPerformanceTier" @@ -1101,6 +1215,12 @@ "schema": { "$ref": "#/definitions/PerformanceTierListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-pageable": { @@ -1108,7 +1228,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/checkNameAvailability": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMariaDB/checkNameAvailability": { "post": { "tags": [ "CheckNameAvailability" @@ -1143,11 +1263,17 @@ "schema": { "$ref": "#/definitions/NameAvailability" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } } } }, - "/providers/Microsoft.DBforMariaDB/operations": { + "/providers/Microsoft.DBForMariaDB/operations": { "get": { "tags": [ "Operations" @@ -1170,6 +1296,12 @@ "schema": { "$ref": "#/definitions/OperationListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } } } @@ -1380,6 +1512,7 @@ "properties": { "backupRetentionDays": { "type": "integer", + "format": "int32", "description": "Backup retention days for the server." }, "geoRedundantBackup": { @@ -1571,6 +1704,9 @@ "description": "The family of hardware." } }, + "required": [ + "name" + ], "description": "Billing information related properties of a server." }, "Server": { @@ -2047,6 +2183,7 @@ }, "vCore": { "type": "integer", + "format": "int32", "description": "vCore associated with the service level objective" }, "hardwareGeneration": { @@ -2055,10 +2192,12 @@ }, "maxBackupRetentionDays": { "type": "integer", + "format": "int32", "description": "Maximum Backup retention in days for the performance tier edition" }, "minBackupRetentionDays": { "type": "integer", + "format": "int32", "description": "Minimum Backup retention in days for the performance tier edition" }, "maxStorageMB": { diff --git a/specification/mariadb/resource-manager/readme.md b/specification/mariadb/resource-manager/readme.md index 1c4777c3362d..b857b1dd4b6b 100644 --- a/specification/mariadb/resource-manager/readme.md +++ b/specification/mariadb/resource-manager/readme.md @@ -93,7 +93,6 @@ input-file: ``` yaml directive: - suppress: PathResourceProviderNamePascalCase - from: Servers.json reason: The name of the provider is Microsoft.DBforMariaDB ``` diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/mysql.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/mysql.json index 930457495d0e..e0dcd9a26329 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/mysql.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/mysql.json @@ -34,7 +34,7 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}": { "put": { "tags": [ "Servers" @@ -217,7 +217,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers": { "get": { "tags": [ "Servers" @@ -253,7 +253,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/servers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/servers": { "get": { "tags": [ "Servers" @@ -286,7 +286,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/restart": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/restart": { "post": { "tags": [ "ServerRestart" @@ -329,7 +329,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/replicas": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/replicas": { "get": { "tags": [ "Replicas" @@ -368,7 +368,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/firewallRules/{firewallRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/firewallRules/{firewallRuleName}": { "put": { "tags": [ "FirewallRules" @@ -504,7 +504,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/firewallRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/firewallRules": { "get": { "tags": [ "FirewallRules" @@ -543,7 +543,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { "get": { "tags": [ "VirtualNetworkRules" @@ -688,7 +688,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/virtualNetworkRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/virtualNetworkRules": { "get": { "tags": [ "VirtualNetworkRules" @@ -730,7 +730,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/databases/{databaseName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/databases/{databaseName}": { "put": { "tags": [ "Databases" @@ -866,7 +866,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/databases": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/databases": { "get": { "tags": [ "Databases" @@ -905,7 +905,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/configurations/{configurationName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/configurations/{configurationName}": { "put": { "tags": [ "Configurations" @@ -994,7 +994,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/configurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/configurations": { "get": { "tags": [ "Configurations" @@ -1033,7 +1033,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/logFiles": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/logFiles": { "get": { "tags": [ "LogFiles" @@ -1072,7 +1072,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/Administrators/activeDirectory": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/Administrators/activeDirectory": { "get": { "tags": [ "ServerAdministrators" @@ -1214,7 +1214,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/administrators": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/administrators": { "get": { "tags": [ "ServerAdministrators" @@ -1259,7 +1259,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/performanceTiers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/locations/{locationName}/performanceTiers": { "get": { "tags": [ "LocationBasedPerformanceTier" @@ -1295,7 +1295,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/checkNameAvailability": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/checkNameAvailability": { "post": { "tags": [ "CheckNameAvailability" @@ -1334,7 +1334,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { "get": { "tags": [ "ServerSecurityAlertPolicies" @@ -1454,7 +1454,7 @@ } } }, - "/providers/Microsoft.DBforMySQL/operations": { + "/providers/Microsoft.DBForMySQL/operations": { "get": { "tags": [ "Operations" @@ -1617,51 +1617,6 @@ } } }, - "ProxyResource": { - "description": "Resource properties.", - "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." - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "Resource properties including location and tags for track resources.", - "properties": { - "location": { - "type": "string", - "description": "The location the resource resides in." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Application-specific metadata in the form of key-value pairs." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "required": [ - "location" - ] - }, "ServerProperties": { "properties": { "administratorLogin": { @@ -1956,6 +1911,9 @@ "description": "The family of hardware." } }, + "required": [ + "name" + ], "description": "Billing information related properties of a server." }, "ResourceIdentity": { @@ -2005,7 +1963,7 @@ }, "allOf": [ { - "$ref": "#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" } ], "description": "Represents a server." @@ -2127,7 +2085,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "required": [ @@ -2185,7 +2143,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -2238,7 +2196,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a Database." @@ -2298,7 +2256,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a Configuration." @@ -2434,7 +2392,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a log file." @@ -2608,7 +2566,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -2699,7 +2657,7 @@ "description": "Represents a and external administrator to be created.", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ] }, diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json index af9601bf9324..57933912da9f 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json @@ -346,44 +346,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "PrivateEndpointConnection": { "description": "A private endpoint connection", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/PrivateLinkResources.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/PrivateLinkResources.json index 9773e4440b37..a9b356bc2e74 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/PrivateLinkResources.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/PrivateLinkResources.json @@ -168,44 +168,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "PrivateLinkResource": { "description": "A private link resource", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/mysql.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/mysql.json index 8addd2520a3d..79e8e6e25313 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/mysql.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/mysql.json @@ -34,7 +34,7 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}": { "put": { "tags": [ "Servers" @@ -217,7 +217,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers": { "get": { "tags": [ "Servers" @@ -253,7 +253,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/servers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/servers": { "get": { "tags": [ "Servers" @@ -286,7 +286,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/restart": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/restart": { "post": { "tags": [ "ServerRestart" @@ -329,7 +329,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/replicas": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/replicas": { "get": { "tags": [ "Replicas" @@ -368,7 +368,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/firewallRules/{firewallRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/firewallRules/{firewallRuleName}": { "put": { "tags": [ "FirewallRules" @@ -504,7 +504,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/firewallRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/firewallRules": { "get": { "tags": [ "FirewallRules" @@ -543,7 +543,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { "get": { "tags": [ "VirtualNetworkRules" @@ -688,7 +688,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/virtualNetworkRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/virtualNetworkRules": { "get": { "tags": [ "VirtualNetworkRules" @@ -730,7 +730,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/databases/{databaseName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/databases/{databaseName}": { "put": { "tags": [ "Databases" @@ -866,7 +866,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/databases": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/databases": { "get": { "tags": [ "Databases" @@ -905,7 +905,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/configurations/{configurationName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/configurations/{configurationName}": { "put": { "tags": [ "Configurations" @@ -994,7 +994,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/configurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/configurations": { "get": { "tags": [ "Configurations" @@ -1033,7 +1033,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/logFiles": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/logFiles": { "get": { "tags": [ "LogFiles" @@ -1072,7 +1072,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/Administrators/activeDirectory": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/Administrators/activeDirectory": { "get": { "tags": [ "ServerAdministrators" @@ -1214,7 +1214,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/administrators": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/administrators": { "get": { "tags": [ "ServerAdministrators" @@ -1259,7 +1259,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/performanceTiers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/locations/{locationName}/performanceTiers": { "get": { "tags": [ "LocationBasedPerformanceTier" @@ -1295,7 +1295,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/checkNameAvailability": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/checkNameAvailability": { "post": { "tags": [ "CheckNameAvailability" @@ -1334,7 +1334,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { "get": { "tags": [ "ServerSecurityAlertPolicies" @@ -1454,7 +1454,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/queryTexts/{queryId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/queryTexts/{queryId}": { "get": { "tags": [ "QueryTexts" @@ -1493,7 +1493,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/queryTexts": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/queryTexts": { "get": { "tags": [ "QueryTexts" @@ -1543,7 +1543,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/topQueryStatistics/{queryStatisticId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/topQueryStatistics/{queryStatisticId}": { "get": { "tags": [ "TopQueryStatistics" @@ -1582,7 +1582,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/topQueryStatistics": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/topQueryStatistics": { "get": { "tags": [ "TopQueryStatistics" @@ -1630,7 +1630,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/waitStatistics/{waitStatisticsId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/waitStatistics/{waitStatisticsId}": { "get": { "tags": [ "WaitStatistics" @@ -1669,7 +1669,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/waitStatistics": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/waitStatistics": { "get": { "tags": [ "WaitStatistics" @@ -1717,7 +1717,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/advisors/{advisorName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/advisors/{advisorName}": { "get": { "tags": [ "Advisors" @@ -1756,7 +1756,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/advisors": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/advisors": { "get": { "tags": [ "Advisors" @@ -1795,7 +1795,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/advisors/{advisorName}/createRecommendedActionSession": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/advisors/{advisorName}/createRecommendedActionSession": { "post": { "tags": [ "RecommendedActionSessions" @@ -1842,7 +1842,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/advisors/{advisorName}/recommendedActions/{recommendedActionName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/advisors/{advisorName}/recommendedActions/{recommendedActionName}": { "get": { "tags": [ "RecommendedActions" @@ -1884,7 +1884,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/advisors/{advisorName}/recommendedActions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/advisors/{advisorName}/recommendedActions": { "get": { "tags": [ "RecommendedActions" @@ -1933,7 +1933,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/recommendedActionSessionsAzureAsyncOperation/{operationId}": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/locations/{locationName}/recommendedActionSessionsAzureAsyncOperation/{operationId}": { "get": { "tags": [ "LocationBasedRecommendedActionSessionsOperationStatus" @@ -1969,7 +1969,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/recommendedActionSessionsOperationResults/{operationId}": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/locations/{locationName}/recommendedActionSessionsOperationResults/{operationId}": { "get": { "tags": [ "LocationBasedRecommendedActionSessionsResult" @@ -2014,7 +2014,7 @@ } } }, - "/providers/Microsoft.DBforMySQL/operations": { + "/providers/Microsoft.DBForMySQL/operations": { "get": { "tags": [ "Operations" @@ -2176,51 +2176,6 @@ } } }, - "ProxyResource": { - "description": "Resource properties.", - "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." - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "Resource properties including location and tags for track resources.", - "properties": { - "location": { - "type": "string", - "description": "The location the resource resides in." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Application-specific metadata in the form of key-value pairs." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "required": [ - "location" - ] - }, "ServerProperties": { "properties": { "administratorLogin": { @@ -2511,6 +2466,9 @@ "description": "The family of hardware." } }, + "required": [ + "name" + ], "description": "Billing information related properties of a server." }, "ResourceIdentity": { @@ -2560,7 +2518,7 @@ }, "allOf": [ { - "$ref": "#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" } ], "description": "Represents a server." @@ -2682,7 +2640,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "required": [ @@ -2740,7 +2698,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -2793,7 +2751,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a Database." @@ -2853,7 +2811,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a Configuration." @@ -2989,7 +2947,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a log file." @@ -3163,7 +3121,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -3254,7 +3212,7 @@ "description": "Represents a and external administrator to be created.", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ] }, @@ -3293,7 +3251,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a Query Text." @@ -3432,7 +3390,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a Query Statistic." @@ -3550,7 +3508,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a Wait Statistic." @@ -3588,7 +3546,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a recommendation action advisor." @@ -3665,7 +3623,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a Recommendation Action." diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-01-01-privatepreview/DataEncryptionKeys.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-01-01-privatepreview/DataEncryptionKeys.json index 68a43fcfc34a..e562c0bb5b0f 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-01-01-privatepreview/DataEncryptionKeys.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-01-01-privatepreview/DataEncryptionKeys.json @@ -223,27 +223,6 @@ } }, "definitions": { - "ProxyResource": { - "description": "Resource properties.", - "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." - } - }, - "x-ms-azure-resource": true - }, "ServerKeyListResult": { "description": "A list of MySQL Server keys.", "type": "object", @@ -298,7 +277,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json index 7e3f30764a48..9a9febae0725 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json @@ -34,7 +34,7 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}": { "put": { "tags": [ "Servers" @@ -217,7 +217,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers": { "get": { "tags": [ "Servers" @@ -253,7 +253,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/servers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/servers": { "get": { "tags": [ "Servers" @@ -286,7 +286,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/restart": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/restart": { "post": { "tags": [ "ServerRestart" @@ -329,7 +329,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/replicas": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/replicas": { "get": { "tags": [ "Replicas" @@ -368,7 +368,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/firewallRules/{firewallRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/firewallRules/{firewallRuleName}": { "put": { "tags": [ "FirewallRules" @@ -504,7 +504,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/firewallRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/firewallRules": { "get": { "tags": [ "FirewallRules" @@ -543,7 +543,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { "get": { "tags": [ "VirtualNetworkRules" @@ -688,7 +688,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/virtualNetworkRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/virtualNetworkRules": { "get": { "tags": [ "VirtualNetworkRules" @@ -730,7 +730,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/databases/{databaseName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/databases/{databaseName}": { "put": { "tags": [ "Databases" @@ -866,7 +866,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/databases": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/databases": { "get": { "tags": [ "Databases" @@ -905,7 +905,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/configurations/{configurationName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/configurations/{configurationName}": { "put": { "tags": [ "Configurations" @@ -994,7 +994,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/configurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/configurations": { "get": { "tags": [ "Configurations" @@ -1033,7 +1033,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/logFiles": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/logFiles": { "get": { "tags": [ "LogFiles" @@ -1072,7 +1072,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/Administrators/activeDirectory": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/Administrators/activeDirectory": { "get": { "tags": [ "ServerAdministrators" @@ -1214,7 +1214,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/administrators": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySQL/servers/{serverName}/administrators": { "get": { "tags": [ "ServerAdministrators" @@ -1259,7 +1259,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/performanceTiers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/locations/{locationName}/performanceTiers": { "get": { "tags": [ "LocationBasedPerformanceTier" @@ -1295,7 +1295,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/checkNameAvailability": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySQL/checkNameAvailability": { "post": { "tags": [ "CheckNameAvailability" @@ -1334,7 +1334,7 @@ } } }, - "/providers/Microsoft.DBforMySQL/operations": { + "/providers/Microsoft.DBForMySQL/operations": { "get": { "tags": [ "Operations" @@ -1817,6 +1817,9 @@ "description": "The family of hardware." } }, + "required": [ + "name" + ], "description": "Billing information related properties of a server." }, "ResourceIdentity": { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json index 1df614dff54b..743d4ec6e6de 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json @@ -34,7 +34,7 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}": { "put": { "tags": [ "Servers" @@ -217,7 +217,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers": { "get": { "tags": [ "Servers" @@ -253,7 +253,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/servers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSQL/servers": { "get": { "tags": [ "Servers" @@ -286,7 +286,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/Replicas": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/Replicas": { "get": { "tags": [ "Replicas" @@ -325,7 +325,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/restart": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/restart": { "post": { "tags": [ "ServerRestart" @@ -368,7 +368,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/firewallRules/{firewallRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/firewallRules/{firewallRuleName}": { "put": { "tags": [ "FirewallRules" @@ -504,7 +504,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/firewallRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/firewallRules": { "get": { "tags": [ "FirewallRules" @@ -543,7 +543,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { "get": { "tags": [ "VirtualNetworkRules" @@ -688,7 +688,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/virtualNetworkRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/virtualNetworkRules": { "get": { "tags": [ "VirtualNetworkRules" @@ -730,7 +730,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/databases/{databaseName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/databases/{databaseName}": { "put": { "tags": [ "Databases" @@ -866,7 +866,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/databases": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/databases": { "get": { "tags": [ "Databases" @@ -905,7 +905,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/configurations/{configurationName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/configurations/{configurationName}": { "put": { "tags": [ "Configurations" @@ -994,7 +994,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/configurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/configurations": { "get": { "tags": [ "Configurations" @@ -1033,7 +1033,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/logFiles": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/logFiles": { "get": { "tags": [ "LogFiles" @@ -1072,7 +1072,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/Administrators/activeDirectory": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/Administrators/activeDirectory": { "get": { "tags": [ "ServerAdministrators" @@ -1214,7 +1214,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/administrators": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/administrators": { "get": { "tags": [ "ServerAdministrators" @@ -1259,7 +1259,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/performanceTiers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSQL/locations/{locationName}/performanceTiers": { "get": { "tags": [ "LocationBasedPerformanceTier" @@ -1295,7 +1295,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/checkNameAvailability": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSQL/checkNameAvailability": { "post": { "tags": [ "CheckNameAvailability" @@ -1334,7 +1334,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { "get": { "tags": [ "ServerSecurityAlertPolicies" @@ -1454,7 +1454,7 @@ } } }, - "/providers/Microsoft.DBforPostgreSQL/operations": { + "/providers/Microsoft.DBForPostgreSQL/operations": { "get": { "tags": [ "Operations" @@ -1620,51 +1620,6 @@ } } }, - "ProxyResource": { - "description": "Resource properties.", - "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." - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "Resource properties including location and tags for track resources.", - "properties": { - "location": { - "type": "string", - "description": "The location the resource resides in." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Application-specific metadata in the form of key-value pairs." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "required": [ - "location" - ] - }, "ServerProperties": { "properties": { "administratorLogin": { @@ -1959,6 +1914,9 @@ "description": "The family of hardware." } }, + "required": [ + "name" + ], "description": "Billing information related properties of a server." }, "ResourceIdentity": { @@ -2008,7 +1966,7 @@ }, "allOf": [ { - "$ref": "#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" } ], "description": "Represents a server." @@ -2130,7 +2088,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "required": [ @@ -2188,7 +2146,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -2241,7 +2199,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a Database." @@ -2301,7 +2259,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a Configuration." @@ -2437,7 +2395,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "Represents a log file." @@ -2611,7 +2569,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -2702,7 +2660,7 @@ "description": "Represents a and external administrator to be created.", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ] }, diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json index 9b5722ef689e..2570b091eae6 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json @@ -346,44 +346,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "PrivateEndpointConnection": { "description": "A private endpoint connection", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2018-06-01-privatepreview/PrivateLinkResources.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2018-06-01-privatepreview/PrivateLinkResources.json index f0691e3b6d1c..2a6e3fbe419b 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2018-06-01-privatepreview/PrivateLinkResources.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2018-06-01-privatepreview/PrivateLinkResources.json @@ -168,44 +168,12 @@ } } }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, "PrivateLinkResource": { "description": "A private link resource", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-01-01-privatepreview/DataEncryptionKeys.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-01-01-privatepreview/DataEncryptionKeys.json index 38bef52ea2e5..741c1867a60e 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-01-01-privatepreview/DataEncryptionKeys.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-01-01-privatepreview/DataEncryptionKeys.json @@ -223,27 +223,6 @@ } }, "definitions": { - "ProxyResource": { - "description": "Resource properties.", - "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." - } - }, - "x-ms-azure-resource": true - }, "ServerKeyListResult": { "description": "A list of PostgreSQL Server keys.", "type": "object", @@ -298,7 +277,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/postgresql.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/postgresql.json index 047b068c01e8..f64a25a4b225 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/postgresql.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/postgresql.json @@ -1350,6 +1350,10 @@ } } }, + "required": [ + "name", + "tier" + ], "description": "Sku information related properties of a server." }, "FirewallRuleProperties": { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json index fe4e44f77321..1ff32eaa3e4a 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json @@ -34,7 +34,7 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}": { "put": { "tags": [ "Servers" @@ -217,7 +217,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers": { "get": { "tags": [ "Servers" @@ -253,7 +253,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/servers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSQL/servers": { "get": { "tags": [ "Servers" @@ -286,7 +286,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/Replicas": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/Replicas": { "get": { "tags": [ "Replicas" @@ -325,7 +325,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/restart": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/restart": { "post": { "tags": [ "ServerRestart" @@ -368,7 +368,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/firewallRules/{firewallRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/firewallRules/{firewallRuleName}": { "put": { "tags": [ "FirewallRules" @@ -504,7 +504,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/firewallRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/firewallRules": { "get": { "tags": [ "FirewallRules" @@ -543,7 +543,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { "get": { "tags": [ "VirtualNetworkRules" @@ -688,7 +688,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/virtualNetworkRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/virtualNetworkRules": { "get": { "tags": [ "VirtualNetworkRules" @@ -730,7 +730,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/databases/{databaseName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/databases/{databaseName}": { "put": { "tags": [ "Databases" @@ -866,7 +866,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/databases": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/databases": { "get": { "tags": [ "Databases" @@ -905,7 +905,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/configurations/{configurationName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/configurations/{configurationName}": { "put": { "tags": [ "Configurations" @@ -994,7 +994,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/configurations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/configurations": { "get": { "tags": [ "Configurations" @@ -1033,7 +1033,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/logFiles": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/logFiles": { "get": { "tags": [ "LogFiles" @@ -1072,7 +1072,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/Administrators/activeDirectory": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/Administrators/activeDirectory": { "get": { "tags": [ "ServerAdministrators" @@ -1214,7 +1214,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/administrators": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSQL/servers/{serverName}/administrators": { "get": { "tags": [ "ServerAdministrators" @@ -1259,7 +1259,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/performanceTiers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSQL/locations/{locationName}/performanceTiers": { "get": { "tags": [ "LocationBasedPerformanceTier" @@ -1295,7 +1295,7 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/checkNameAvailability": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSQL/checkNameAvailability": { "post": { "tags": [ "CheckNameAvailability" @@ -1334,7 +1334,7 @@ } } }, - "/providers/Microsoft.DBforPostgreSQL/operations": { + "/providers/Microsoft.DBForPostgreSQL/operations": { "get": { "tags": [ "Operations" @@ -1534,30 +1534,6 @@ } } }, - "TrackedResource": { - "description": "Resource properties including location and tags for track resources.", - "properties": { - "location": { - "type": "string", - "description": "The location the resource resides in." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Application-specific metadata in the form of key-value pairs." - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" - } - ], - "required": [ - "location" - ] - }, "ServerProperties": { "properties": { "administratorLogin": { @@ -1844,6 +1820,9 @@ "description": "The family of hardware." } }, + "required": [ + "name" + ], "description": "Billing information related properties of a server." }, "ResourceIdentity": { @@ -1893,7 +1872,7 @@ }, "allOf": [ { - "$ref": "#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" } ], "description": "Represents a server." From a53cc8e23c38d03d8747cc8ac3c68278d0b75b2c Mon Sep 17 00:00:00 2001 From: Tom Harvey Date: Wed, 9 Sep 2020 10:38:14 +0200 Subject: [PATCH 021/164] network/2020-05-01: adding the missing web application firewall files (#10384) * network/2020-05-01: adding the missing web application firewall files * linking the file * adding examples * code review fixes * ignoring the linter because apparently the networking api's don't follow it.. --- .../examples/WafListAllPolicies.json | 102 +++ .../2020-05-01/examples/WafListPolicies.json | 103 +++ .../examples/WafPolicyCreateOrUpdate.json | 258 ++++++ .../2020-05-01/examples/WafPolicyDelete.json | 13 + .../2020-05-01/examples/WafPolicyGet.json | 140 ++++ .../2020-05-01/webapplicationfirewall.json | 743 ++++++++++++++++++ .../network/resource-manager/readme.md | 3 +- 7 files changed, 1361 insertions(+), 1 deletion(-) create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListAllPolicies.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListPolicies.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyCreateOrUpdate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListAllPolicies.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListAllPolicies.json new file mode 100644 index 000000000000..32158faaedfd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListAllPolicies.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "state": "Enabled", + "mode": "Prevention", + "maxRequestBodySizeInKb": 128, + "fileUploadLimitInMb": 750, + "requestBodyCheck": true + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeader", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + } + ], + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.0" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListPolicies.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListPolicies.json new file mode 100644 index 000000000000..0faa1a7f616f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListPolicies.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "state": "Enabled", + "mode": "Detection", + "maxRequestBodySizeInKb": 128, + "fileUploadLimitInMb": 750, + "requestBodyCheck": true + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.0" + } + ] + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeader", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyCreateOrUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyCreateOrUpdate.json new file mode 100644 index 000000000000..63ec90cd9645 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyCreateOrUpdate.json @@ -0,0 +1,258 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1", + "parameters": { + "location": "WestUs", + "properties": { + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.0" + } + ] + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "ruleType": "MatchRule", + "action": "Block", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ] + }, + { + "name": "Rule2", + "priority": 2, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeaders", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "state": "Enabled", + "mode": "Detection", + "maxRequestBodySizeInKb": 128, + "fileUploadLimitInMb": 750, + "requestBodyCheck": true + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.0" + } + ] + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeader", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + } + ] + } + } + }, + "201": { + "body": { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "state": "Enabled", + "mode": "Detection", + "maxRequestBodySizeInKb": 128, + "fileUploadLimitInMb": 750, + "requestBodyCheck": true + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.0" + } + ] + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeader", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyDelete.json new file mode 100644 index 000000000000..c887714443bf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyGet.json new file mode 100644 index 000000000000..50555ffcb9ad --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyGet.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1" + }, + "responses": { + "200": { + "body": { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "state": "Enabled", + "mode": "Prevention", + "maxRequestBodySizeInKb": 128, + "fileUploadLimitInMb": 750, + "requestBodyCheck": true + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeader", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + } + ], + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "REQUEST-942-APPLICATION-ATTACK-SQLI", + "rules": [ + { + "ruleId": "942130", + "state": "Disabled" + }, + { + "ruleId": "942110", + "state": "Disabled" + } + ] + }, + { + "ruleGroupName": "REQUEST-920-PROTOCOL-ENFORCEMENT", + "rules": [ + { + "ruleId": "920100", + "state": "Disabled" + }, + { + "ruleId": "920120", + "state": "Disabled" + } + ] + } + ] + } + ], + "exclusions": [ + { + "matchVariable": "RequestHeaderNames", + "selectorMatchOperator": "Equals", + "selector": "testHeader1" + }, + { + "matchVariable": "RequestHeaderNames", + "selectorMatchOperator": "StartsWith", + "selector": "testHeader2" + } + ] + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json new file mode 100644 index 000000000000..111927abcdca --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json @@ -0,0 +1,743 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-05-01", + "title": "WebApplicationFirewallManagement", + "description": "APIs to manage web application firewall rules." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Lists all of the protection policies within a resource group.", + "operationId": "WebApplicationFirewallPolicies_List", + "x-ms-examples": { + "Lists all WAF policies in a resource group": { + "$ref": "./examples/WafListPolicies.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Gets all the WAF policies in a subscription.", + "operationId": "WebApplicationFirewallPolicies_ListAll", + "x-ms-examples": { + "Lists all WAF policies in a subscription": { + "$ref": "./examples/WafListAllPolicies.json" + } + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/{policyName}": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Retrieve protection policy with specified name within a resource group.", + "operationId": "WebApplicationFirewallPolicies_Get", + "x-ms-examples": { + "Gets a WAF policy within a resource group": { + "$ref": "./examples/WafPolicyGet.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "policyName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 128, + "description": "The name of the policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Creates or update policy with specified rule set name within a resource group.", + "operationId": "WebApplicationFirewallPolicies_CreateOrUpdate", + "x-ms-examples": { + "Creates or updates a WAF policy within a resource group": { + "$ref": "./examples/WafPolicyCreateOrUpdate.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "policyName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 128, + "description": "The name of the policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "description": "Policy to be created.", + "in": "body", + "name": "parameters", + "required": true, + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new protection policy has been created.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Deletes Policy.", + "operationId": "WebApplicationFirewallPolicies_Delete", + "x-ms-examples": { + "Deletes a WAF policy within a resource group": { + "$ref": "./examples/WafPolicyDelete.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "policyName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 128, + "description": "The name of the policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "204": { + "description": "No Content. The request has been accepted but the policy was not found." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "WebApplicationFirewallPolicy": { + "description": "Defines web application firewall policy.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebApplicationFirewallPolicyPropertiesFormat", + "description": "Properties of the web application firewall policy." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "WebApplicationFirewallPolicyPropertiesFormat": { + "description": "Defines web application firewall policy properties.", + "required": [ + "managedRules" + ], + "properties": { + "policySettings": { + "description": "The PolicySettings for policy.", + "$ref": "#/definitions/PolicySettings" + }, + "customRules": { + "description": "The custom rules inside the policy.", + "type": "array", + "items": { + "$ref": "#/definitions/WebApplicationFirewallCustomRule" + } + }, + "applicationGateways": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./applicationGateway.json#/definitions/ApplicationGateway" + }, + "description": "A collection of references to application gateways." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the web application firewall policy resource." + }, + "resourceState": { + "title": "Resource status of the policy.", + "readOnly": true, + "type": "string", + "description": "Resource status of the policy.", + "enum": [ + "Creating", + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Deleting" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallPolicyResourceState", + "modelAsString": true + } + }, + "managedRules": { + "description": "Describes the managedRules structure.", + "$ref": "#/definitions/ManagedRulesDefinition" + }, + "httpListeners": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "A collection of references to application gateway http listeners." + }, + "pathBasedRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "A collection of references to application gateway path rules." + } + } + }, + "WebApplicationFirewallPolicyListResult": { + "description": "Result of the request to list WebApplicationFirewallPolicies. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + }, + "description": "List of WebApplicationFirewallPolicies within a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of WebApplicationFirewallPolicy objects if there are any." + } + } + }, + "ManagedRulesDefinition": { + "description": "Allow to exclude some variable satisfy the condition for the WAF check.", + "required": [ + "managedRuleSets" + ], + "properties": { + "exclusions": { + "type": "array", + "items": { + "$ref": "#/definitions/OwaspCrsExclusionEntry" + }, + "description": "The Exclusions that are applied on the policy." + }, + "managedRuleSets": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleSet" + }, + "description": "The managed rule sets that are associated with the policy." + } + } + }, + "PolicySettings": { + "description": "Defines contents of a web application firewall global configuration.", + "properties": { + "state": { + "description": "The state of the policy.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallEnabledState", + "modelAsString": true + } + }, + "mode": { + "description": "The mode of the policy.", + "type": "string", + "enum": [ + "Prevention", + "Detection" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallMode", + "modelAsString": true + } + }, + "requestBodyCheck": { + "type": "boolean", + "description": "Whether to allow WAF to check request Body." + }, + "maxRequestBodySizeInKb": { + "type": "integer", + "format": "int32", + "maximum": 128, + "exclusiveMaximum": false, + "minimum": 8, + "exclusiveMinimum": false, + "description": "Maximum request body size in Kb for WAF." + }, + "fileUploadLimitInMb": { + "type": "integer", + "format": "int32", + "minimum": 0, + "exclusiveMinimum": false, + "description": "Maximum file upload size in Mb for WAF." + } + } + }, + "WebApplicationFirewallCustomRule": { + "description": "Defines contents of a web application rule.", + "required": [ + "priority", + "ruleType", + "matchConditions", + "action" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the resource that is unique within a policy. This name can be used to access the resource.", + "maxLength": 128 + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "priority": { + "description": "Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.", + "type": "integer" + }, + "ruleType": { + "description": "The rule type.", + "type": "string", + "enum": [ + "MatchRule", + "Invalid" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallRuleType", + "modelAsString": true + } + }, + "matchConditions": { + "description": "List of match conditions.", + "type": "array", + "items": { + "$ref": "#/definitions/MatchCondition" + } + }, + "action": { + "description": "Type of Actions.", + "type": "string", + "enum": [ + "Allow", + "Block", + "Log" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallAction", + "modelAsString": true + } + } + } + }, + "Transform": { + "description": "Transforms applied before matching.", + "type": "string", + "enum": [ + "Lowercase", + "Trim", + "UrlDecode", + "UrlEncode", + "RemoveNulls", + "HtmlEntityDecode" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallTransform", + "modelAsString": true + } + }, + "MatchVariable": { + "description": "Define match variables.", + "required": [ + "variableName" + ], + "properties": { + "variableName": { + "description": "Match Variable.", + "type": "string", + "enum": [ + "RemoteAddr", + "RequestMethod", + "QueryString", + "PostArgs", + "RequestUri", + "RequestHeaders", + "RequestBody", + "RequestCookies" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallMatchVariable", + "modelAsString": true + } + }, + "selector": { + "description": "The selector of match variable.", + "type": "string" + } + } + }, + "MatchCondition": { + "description": "Define match conditions.", + "required": [ + "matchVariables", + "operator", + "matchValues" + ], + "properties": { + "matchVariables": { + "description": "List of match variables.", + "type": "array", + "items": { + "$ref": "#/definitions/MatchVariable" + } + }, + "operator": { + "description": "The operator to be matched.", + "type": "string", + "enum": [ + "IPMatch", + "Equal", + "Contains", + "LessThan", + "GreaterThan", + "LessThanOrEqual", + "GreaterThanOrEqual", + "BeginsWith", + "EndsWith", + "Regex", + "GeoMatch" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallOperator", + "modelAsString": true + } + }, + "negationConditon": { + "description": "Whether this is negate condition or not.", + "type": "boolean" + }, + "matchValues": { + "description": "Match value.", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms.", + "type": "array", + "items": { + "$ref": "#/definitions/Transform" + } + } + } + }, + "ManagedRuleSet": { + "type": "object", + "description": "Defines a managed rule set.", + "required": [ + "ruleSetType", + "ruleSetVersion" + ], + "properties": { + "ruleSetType": { + "description": "Defines the rule set type to use.", + "type": "string" + }, + "ruleSetVersion": { + "description": "Defines the version of the rule set to use.", + "type": "string" + }, + "ruleGroupOverrides": { + "description": "Defines the rule group overrides to apply to the rule set.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleGroupOverride" + } + } + } + }, + "ManagedRuleGroupOverride": { + "description": "Defines a managed rule group override setting.", + "required": [ + "ruleGroupName" + ], + "properties": { + "ruleGroupName": { + "description": "The managed rule group to override.", + "type": "string" + }, + "rules": { + "description": "List of rules that will be disabled. If none specified, all rules in the group will be disabled.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleOverride" + } + } + } + }, + "ManagedRuleOverride": { + "description": "Defines a managed rule group override setting.", + "required": [ + "ruleId" + ], + "properties": { + "ruleId": { + "description": "Identifier for the managed rule.", + "type": "string" + }, + "state": { + "description": "The state of the managed rule. Defaults to Disabled if not specified.", + "type": "string", + "enum": [ + "Disabled" + ], + "x-ms-enum": { + "name": "ManagedRuleEnabledState", + "modelAsString": true + } + } + } + }, + "OwaspCrsExclusionEntry": { + "required": [ + "matchVariable", + "selectorMatchOperator", + "selector" + ], + "description": "Allow to exclude some variable satisfy the condition for the WAF check.", + "properties": { + "matchVariable": { + "type": "string", + "enum": [ + "RequestHeaderNames", + "RequestCookieNames", + "RequestArgNames" + ], + "description": "The variable to be excluded.", + "x-ms-enum": { + "name": "OwaspCrsExclusionEntryMatchVariable", + "modelAsString": true + } + }, + "selectorMatchOperator": { + "type": "string", + "enum": [ + "Equals", + "Contains", + "StartsWith", + "EndsWith", + "EqualsAny" + ], + "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.", + "x-ms-enum": { + "name": "OwaspCrsExclusionEntrySelectorMatchOperator", + "modelAsString": true + } + }, + "selector": { + "type": "string", + "description": "When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to." + } + } + } + } +} diff --git a/specification/network/resource-manager/readme.md b/specification/network/resource-manager/readme.md index 3ce8f18354df..5211d0e3ddac 100644 --- a/specification/network/resource-manager/readme.md +++ b/specification/network/resource-manager/readme.md @@ -136,6 +136,7 @@ input-file: - Microsoft.Network/stable/2020-05-01/virtualWan.json - Microsoft.Network/stable/2020-05-01/vmssNetworkInterface.json - Microsoft.Network/stable/2020-05-01/vmssPublicIpAddress.json + - Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json ``` ### Tag: package-2020-04 @@ -2626,6 +2627,6 @@ If there are files that should not be in the `all-api-versions` set, uncomment the `exclude-file` section below and add the file paths. ``` yaml $(tag) == 'all-api-versions' -#exclude-file: +#exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json ``` From af2f59b4c3a1308d79652fdbc2a84d7785c79230 Mon Sep 17 00:00:00 2001 From: Abhinav Ghai Date: Wed, 9 Sep 2020 03:07:26 -0700 Subject: [PATCH 022/164] Update Readmes for Python for Automanage (#10708) * Add list and get software to GuestConfiguration * Use newer API version for software * Revert software Swagger spec since these are private preview only * Add Automanage resource provider * Address validation tool errors * spelling add antimalware * Address lint errors * Fix error response * Fix newline * Fix Operations API Lint * Fix operations example * Fix prettier and lint * Address lint and prettier errors * Use common definitions and correct pref enum * Fix parameter * Address comments * Fix update examples * Prettier fix * Fix python md Co-authored-by: Abhinav Ghai Co-authored-by: Feng Zhou <55177366+fengzhou-msft@users.noreply.github.com> --- custom-words.txt | 2 +- .../common/v1/definitions.json | 213 -------------- .../2020-06-30-preview/automanage.json | 266 ++++++++++++------ .../examples/createOrUpdateAccount.json | 1 + ...rUpdateConfigurationProfilePreference.json | 1 + .../automanage/resource-manager/readme.md | 4 +- .../resource-manager/readme.python.md | 17 +- 7 files changed, 208 insertions(+), 296 deletions(-) delete mode 100644 specification/automanage/resource-manager/Microsoft.Automanage/common/v1/definitions.json diff --git a/custom-words.txt b/custom-words.txt index 05207827ee02..d921807d036e 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1879,4 +1879,4 @@ Stix STIX Mibps ntfs -shamir_share \ No newline at end of file +shamir_share diff --git a/specification/automanage/resource-manager/Microsoft.Automanage/common/v1/definitions.json b/specification/automanage/resource-manager/Microsoft.Automanage/common/v1/definitions.json deleted file mode 100644 index ee4b85738929..000000000000 --- a/specification/automanage/resource-manager/Microsoft.Automanage/common/v1/definitions.json +++ /dev/null @@ -1,213 +0,0 @@ -{ - "swagger": "2.0", - "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" - } - } - }, - "info": { - "version": "v1", - "title": "Common types" - }, - "paths": {}, - "definitions": { - "ErrorResponse": { - "description": "ARM error response body.", - "type": "object", - "properties": { - "error": { - "$ref": "#/definitions/ErrorResponseBody", - "description": "Details about the error." - } - } - }, - "ErrorResponseBody": { - "properties": { - "code": { - "type": "string", - "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." - }, - "message": { - "type": "string", - "description": "A message describing the error, intended to be suitable for display in a user interface." - }, - "target": { - "type": "string", - "description": "The target of the particular error. For example, the name of the property in error." - } - }, - "description": "An error response from the Automanage service." - }, - "Resource": { - "description": "The core properties of ARM resources", - "type": "object", - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "ARM resource id of the Automanage assignment." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Name of the Automanage assignment." - }, - "location": { - "type": "string", - "readOnly": true, - "description": "Region where the VM is located." - }, - "type": { - "readOnly": true, - "type": "string", - "description": "The type of the resource." - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "The resource model definition for a ARM tracked top level resource", - "type": "object", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags." - }, - "location": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "The Azure Region where the resource lives" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, - "Operation": { - "description": "Automanage REST API operation", - "type": "object", - "properties": { - "name": { - "description": "Operation name: For ex. providers/Microsoft.Automanage/configurationProfileAssignments/write or read", - "type": "string" - }, - "isDataAction": { - "description": "Indicates whether the operation is a data action", - "type": "string" - }, - "display": { - "properties": { - "provider": { - "description": "Service provider: Microsoft.Automanage", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed: For ex. ", - "type": "string" - }, - "operation": { - "description": "Operation type: Read, write, delete, etc.", - "type": "string" - }, - "description": { - "description": "Description about operation.", - "type": "string" - } - }, - "description": "Provider, Resource, Operation and description values." - }, - "properties": { - "properties": { - "statusCode": { - "description": "Service provider: Microsoft.Automanage", - "type": "string" - } - }, - "x-ms-client-flatten": true, - "description": "Provider, Resource, Operation and description values." - } - } - }, - "OperationList": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "description": "List of Automanage operations supported by the Automanage resource provider." - } - }, - "description": "The response model for the list of Automanage operations" - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Subscription ID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version." - }, - "VmNameParameter": { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine.", - "x-ms-parameter-location": "method" - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._]+$", - "description": "The resource group name.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/automanage.json b/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/automanage.json index 8e353783e848..d82d8023bd7f 100644 --- a/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/automanage.json +++ b/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/automanage.json @@ -48,13 +48,13 @@ "description": "Name of the Automanage account." }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "name": "parameters", @@ -82,7 +82,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -114,13 +114,13 @@ "description": "The Automanage account name." }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -133,7 +133,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -157,7 +157,7 @@ }, "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "accountName", @@ -167,10 +167,10 @@ "description": "Name of the Automanage account" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -183,7 +183,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -215,20 +215,20 @@ "description": "Name of the Automanage account." }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/Account" + "$ref": "#/definitions/AccountUpdate" }, "description": "Parameters supplied to update Automanage account." } @@ -243,7 +243,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -270,13 +270,13 @@ }, "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -289,7 +289,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -318,10 +318,10 @@ }, "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -334,7 +334,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -379,16 +379,16 @@ "description": "Parameters supplied to the create or update configuration profile assignment." }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + "$ref": "#/parameters/VmNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -407,7 +407,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -432,7 +432,7 @@ }, "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "configurationProfileAssignmentName", @@ -442,13 +442,13 @@ "description": "The configuration profile assignment name." }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + "$ref": "#/parameters/VmNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -461,7 +461,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -485,7 +485,7 @@ }, "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "configurationProfileAssignmentName", @@ -495,13 +495,13 @@ "description": "Name of the configuration profile assignment" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + "$ref": "#/parameters/VmNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -514,7 +514,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -541,13 +541,13 @@ }, "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -560,7 +560,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -589,10 +589,10 @@ }, "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -605,7 +605,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -641,13 +641,13 @@ "description": "Name of the configuration profile preference." }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "name": "parameters", @@ -675,7 +675,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -707,13 +707,13 @@ "description": "The configuration profile preference name." }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -726,7 +726,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -750,7 +750,7 @@ }, "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "configurationProfilePreferenceName", @@ -760,10 +760,10 @@ "description": "Name of the configuration profile preference" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -776,7 +776,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -808,20 +808,20 @@ "description": "Name of the configuration profile preference." }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/ConfigurationProfilePreference" + "$ref": "#/definitions/ConfigurationProfilePreferenceUpdate" }, "description": "Parameters supplied to create or update configuration profile preference." } @@ -836,7 +836,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -863,13 +863,13 @@ }, "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -882,7 +882,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -911,10 +911,10 @@ }, "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -927,7 +927,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -956,20 +956,20 @@ "operationId": "Operations_List", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/OperationList" + "$ref": "#/definitions/OperationList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, @@ -995,7 +995,21 @@ }, "allOf": [ { - "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "description": "Definition of the Automanage account." + }, + "AccountUpdate": { + "properties": { + "identity": { + "$ref": "#/definitions/AccountIdentity", + "description": "The identity of the Automanage account." + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" } ], "description": "Definition of the Automanage account." @@ -1061,7 +1075,7 @@ }, "allOf": [ { - "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ], "description": "Configuration profile assignment is an association between a VM and automanage profile configuration." @@ -1076,8 +1090,8 @@ "modelAsString": true }, "enum": [ - "Azure Best Practices - TestDev", - "Azure Best Practices - Prod" + "Azure virtual machine best practices – Dev/Test", + "Azure virtual machine best practices – Production" ] }, "targetId": { @@ -1144,7 +1158,22 @@ }, "allOf": [ { - "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "description": "Definition of the configuration profile preference." + }, + "ConfigurationProfilePreferenceUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/ConfigurationProfilePreferenceProperties", + "description": "Properties of the configuration profile preference." + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" } ], "description": "Definition of the configuration profile preference." @@ -1257,7 +1286,86 @@ } }, "description": "The response of the list ConfigurationProfilePreference operation." + }, + "Operation": { + "description": "Automanage REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: For ex. providers/Microsoft.Automanage/configurationProfileAssignments/write or read", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "string" + }, + "display": { + "properties": { + "provider": { + "description": "Service provider: Microsoft.Automanage", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed: For ex. ", + "type": "string" + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description about operation.", + "type": "string" + } + }, + "description": "Provider, Resource, Operation and description values." + }, + "properties": { + "properties": { + "statusCode": { + "description": "Service provider: Microsoft.Automanage", + "type": "string" + } + }, + "x-ms-client-flatten": true, + "description": "Provider, Resource, Operation and description values." + } + } + }, + "OperationList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Automanage operations supported by the Automanage resource provider." + } + }, + "description": "The response model for the list of Automanage operations" + }, + "UpdateResource": { + "description": "Represents an update resource", + "type": "object", + "properties": { + "tags": { + "description": "The tags of the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } } }, - "parameters": {} + "parameters": { + "VmNameParameter": { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine.", + "x-ms-parameter-location": "method" + } + } } diff --git a/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/createOrUpdateAccount.json b/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/createOrUpdateAccount.json index 47507f2c18db..5924745ee5a0 100644 --- a/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/createOrUpdateAccount.json +++ b/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/createOrUpdateAccount.json @@ -5,6 +5,7 @@ "api-version": "2020-06-30-preview", "accountName": "account", "parameters": { + "location": "East US", "tags": { "Organization": "Administration" }, diff --git a/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/createOrUpdateConfigurationProfilePreference.json b/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/createOrUpdateConfigurationProfilePreference.json index 77aabf66d83a..845e5c65ab72 100644 --- a/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/createOrUpdateConfigurationProfilePreference.json +++ b/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/createOrUpdateConfigurationProfilePreference.json @@ -5,6 +5,7 @@ "configurationProfilePreferenceName": "defaultProfilePreference", "api-version": "2020-06-30-preview", "parameters": { + "location": "East US", "tags": { "Organization": "Administration" }, diff --git a/specification/automanage/resource-manager/readme.md b/specification/automanage/resource-manager/readme.md index e0a7bcd21a2c..c6f1780bd6da 100644 --- a/specification/automanage/resource-manager/readme.md +++ b/specification/automanage/resource-manager/readme.md @@ -61,6 +61,7 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-net - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-go - repo: azure-sdk-for-js - repo: azure-sdk-for-node @@ -96,7 +97,7 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: - $(this-folder)/Microsoft.Automanage/preview/2020-06-30-preview/automanage.json - + ``` If there are files that should not be in the `all-api-versions` set, @@ -106,4 +107,3 @@ uncomment the `exclude-file` section below and add the file paths. #exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json ``` - diff --git a/specification/automanage/resource-manager/readme.python.md b/specification/automanage/resource-manager/readme.python.md index aa46cfb65e86..66953bf45ec5 100644 --- a/specification/automanage/resource-manager/readme.python.md +++ b/specification/automanage/resource-manager/readme.python.md @@ -4,7 +4,7 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) +``` yaml $(python) && !$(track2) python-mode: create python: azure-arm: true @@ -15,13 +15,28 @@ python: package-version: 0.1.0 clear-output-folder: true ``` + +```yaml $(python) && $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-automanage +package-version: 0.1.0-preview +clear-output-folder: true +no-namespace-folders: true +``` + ``` yaml $(python) && $(python-mode) == 'update' python: no-namespace-folders: true output-folder: $(python-sdks-folder)/automanage/azure-mgmt-automanage/azure/mgmt/automanage +no-namespace-folders: true +output-folder: $(python-sdks-folder)/automanage/azure-mgmt-automanage/azure/mgmt/automanage ``` + ``` yaml $(python) && $(python-mode) == 'create' python: basic-setup-py: true output-folder: $(python-sdks-folder)/automanage/azure-mgmt-automanage +basic-setup-py: true +output-folder: $(python-sdks-folder)/automanage/azure-mgmt-automanage ``` From ff5a5ea9c0eafa289525fe2607266e358ed00b59 Mon Sep 17 00:00:00 2001 From: Himanshu Chandel Date: Wed, 9 Sep 2020 16:36:54 -0700 Subject: [PATCH 023/164] [Hub Generated] Review request for Microsoft.Portal to add version preview/2020-09-01-preview (#10706) * Adds base for updating Microsoft.Portal from version preview/2019-01-01-preview to version 2020-09-01-preview * Updates readme * Updates API version in new specs and examples * Microsoft.Portal dashboards 2020-09-01-preview RP version * Adding tenant api * Fixing readme * prettier error fix * fixing path * fixing api version Co-authored-by: Himanshu Chandel --- .../CreateOrUpdateTenantConfiguration.json | 33 + .../DeleteTenantConfiguration.json | 10 + .../GetListOfTenantConfigurations.json | 21 + .../GetTenantConfiguration.json | 18 + .../examples/createOrUpdateDashboard.json | 152 ++++ .../examples/deleteDashboard.json | 12 + .../examples/getDashboard.json | 59 ++ .../listDashboardsByResourceGroup.json | 109 +++ .../listDashboardsBySubscription.json | 108 +++ .../examples/operationsList.json | 53 ++ .../examples/updateDashboard.json | 65 ++ .../preview/2020-09-01-preview/portal.json | 761 ++++++++++++++++++ .../tenantConfiguration.json | 256 ++++++ .../portal/resource-manager/readme.md | 12 +- 14 files changed, 1668 insertions(+), 1 deletion(-) create mode 100644 specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/CreateOrUpdateTenantConfiguration.json create mode 100644 specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/DeleteTenantConfiguration.json create mode 100644 specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetListOfTenantConfigurations.json create mode 100644 specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetTenantConfiguration.json create mode 100644 specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/createOrUpdateDashboard.json create mode 100644 specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/deleteDashboard.json create mode 100644 specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/getDashboard.json create mode 100644 specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/listDashboardsByResourceGroup.json create mode 100644 specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/listDashboardsBySubscription.json create mode 100644 specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/operationsList.json create mode 100644 specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/updateDashboard.json create mode 100644 specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/portal.json create mode 100644 specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/tenantConfiguration.json diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/CreateOrUpdateTenantConfiguration.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/CreateOrUpdateTenantConfiguration.json new file mode 100644 index 000000000000..804d967b678c --- /dev/null +++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/CreateOrUpdateTenantConfiguration.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "configurationName": "default", + "api-version": "2019-01-01-preview", + "tenantConfiguration": { + "properties": { + "enforcePrivateMarkdownStorage": true + } + } + }, + "responses": { + "201": { + "body": { + "id": "/providers/Microsoft.Portal/tenantConfigurations/default", + "name": "default", + "type": "Microsoft.Portal/tenantConfiguration", + "properties": { + "enforcePrivateMarkdownStorage": true + } + } + }, + "200": { + "body": { + "id": "/providers/Microsoft.Portal/tenantConfigurations/default", + "name": "default", + "type": "Microsoft.Portal/tenantConfiguration", + "properties": { + "enforcePrivateMarkdownStorage": true + } + } + } + } +} diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/DeleteTenantConfiguration.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/DeleteTenantConfiguration.json new file mode 100644 index 000000000000..640025727bc7 --- /dev/null +++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/DeleteTenantConfiguration.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "configurationName": "default", + "api-version": "2019-01-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetListOfTenantConfigurations.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetListOfTenantConfigurations.json new file mode 100644 index 000000000000..bbb7cfefdb1f --- /dev/null +++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetListOfTenantConfigurations.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Portal/tenantConfigurations", + "name": "default", + "type": "Microsoft.Portal/tenantConfiguration", + "properties": { + "enforcePrivateMarkdownStorage": true + } + } + ] + } + } + } +} diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetTenantConfiguration.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetTenantConfiguration.json new file mode 100644 index 000000000000..b945a54fcc08 --- /dev/null +++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/TenantConfiguration/GetTenantConfiguration.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "configurationName": "default", + "api-version": "2019-01-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Portal/tenantConfigurations/default", + "name": "default", + "type": "Microsoft.Portal/tenantConfiguration", + "properties": { + "enforcePrivateMarkdownStorage": true + } + } + } + } +} diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/createOrUpdateDashboard.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/createOrUpdateDashboard.json new file mode 100644 index 000000000000..751774a6bde9 --- /dev/null +++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/createOrUpdateDashboard.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "dashboardName": "testDashboard", + "resourceGroupName": "testRG", + "api-version": "2020-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "dashboard": { + "properties": { + "lenses": [ + { + "order": 1, + "parts": [ + { + "position": { + "x": 1, + "y": 2, + "rowSpan": 4, + "colSpan": 3 + } + }, + { + "position": { + "x": 5, + "y": 5, + "rowSpan": 6, + "colSpan": 6 + } + } + ] + }, + { + "order": 2, + "parts": [] + } + ], + "metadata": { + "metadata": { + "X": 4, + "Y": 3, + "RowSpan": 1, + "ColSpan": 2 + } + } + }, + "location": "eastus", + "tags": { + "aKey": "aValue", + "anotherKey": "anotherValue" + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "lenses": [ + { + "order": 1, + "parts": [ + { + "position": { + "x": 1, + "y": 2, + "rowSpan": 4, + "colSpan": 3 + } + }, + { + "position": { + "x": 5, + "y": 5, + "rowSpan": 6, + "colSpan": 6 + } + } + ] + }, + { + "order": 2, + "parts": [] + } + ], + "metadata": { + "metadata": { + "X": 4, + "Y": 3, + "RowSpan": 1, + "ColSpan": 2 + } + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard", + "name": "testDashboard", + "type": "Microsoft.Portal/dashboards", + "location": "eastus", + "tags": { + "aKey": "aValue", + "anotherKey": "anotherValue" + } + } + }, + "200": { + "body": { + "properties": { + "lenses": [ + { + "order": 1, + "parts": [ + { + "position": { + "x": 1, + "y": 2, + "rowSpan": 4, + "colSpan": 3 + } + }, + { + "position": { + "x": 5, + "y": 5, + "rowSpan": 6, + "colSpan": 6 + } + } + ] + }, + { + "order": 2, + "parts": [] + } + ], + "metadata": { + "metadata": { + "X": 4, + "Y": 3, + "RowSpan": 1, + "ColSpan": 2 + } + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard", + "name": "testDashboard", + "type": "Microsoft.Portal/dashboards", + "location": "eastus", + "tags": { + "aKey": "aValue", + "anotherKey": "anotherValue" + } + } + } + } +} diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/deleteDashboard.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/deleteDashboard.json new file mode 100644 index 000000000000..10e7488cbe00 --- /dev/null +++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/deleteDashboard.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "dashboardName": "testDashboard", + "resourceGroupName": "testRG", + "api-version": "2020-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/getDashboard.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/getDashboard.json new file mode 100644 index 000000000000..8245989bfe7f --- /dev/null +++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/getDashboard.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "dashboardName": "testDashboard", + "resourceGroupName": "testRG", + "api-version": "2020-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "properties": { + "lenses": [ + { + "order": 1, + "parts": [ + { + "position": { + "x": 1, + "y": 2, + "rowSpan": 4, + "colSpan": 3 + } + }, + { + "position": { + "x": 5, + "y": 5, + "rowSpan": 6, + "colSpan": 6 + } + } + ] + }, + { + "order": 2, + "parts": [] + } + ], + "metadata": { + "metadata": { + "X": 4, + "Y": 3, + "RowSpan": 1, + "ColSpan": 2 + } + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard", + "name": "testDashboard", + "type": "Microsoft.Portal/dashboards", + "location": "eastus", + "tags": { + "aKey": "aValue", + "anotherKey": "anotherValue" + } + } + } + } +} diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/listDashboardsByResourceGroup.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/listDashboardsByResourceGroup.json new file mode 100644 index 000000000000..75ec89637b75 --- /dev/null +++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/listDashboardsByResourceGroup.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "resourceGroupName": "testRG", + "api-version": "2020-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "lenses": [ + { + "order": 1, + "parts": [ + { + "position": { + "x": 1, + "y": 2, + "rowSpan": 4, + "colSpan": 3 + } + }, + { + "position": { + "x": 5, + "y": 5, + "rowSpan": 6, + "colSpan": 6 + } + } + ] + }, + { + "order": 2, + "parts": [] + } + ], + "metadata": { + "metadata": { + "X": 4, + "Y": 3, + "RowSpan": 1, + "ColSpan": 2 + } + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard", + "name": "testDashboard", + "type": "Microsoft.Portal/dashboards", + "location": "eastus", + "tags": { + "aKey": "aValue", + "anotherKey": "anotherValue" + } + }, + { + "properties": { + "lenses": [ + { + "order": 1, + "parts": [ + { + "position": { + "x": 1, + "y": 2, + "rowSpan": 4, + "colSpan": 3 + } + }, + { + "position": { + "x": 5, + "y": 5, + "rowSpan": 6, + "colSpan": 6 + } + } + ] + }, + { + "order": 2, + "parts": [] + } + ], + "metadata": { + "metadata": { + "X": 4, + "Y": 3, + "RowSpan": 1, + "ColSpan": 2 + } + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard2", + "name": "testDashboard2", + "type": "Microsoft.Portal/dashboards", + "location": "eastus", + "tags": { + "aKey": "aValue", + "anotherKey": "anotherValue" + } + } + ] + } + } + } +} diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/listDashboardsBySubscription.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/listDashboardsBySubscription.json new file mode 100644 index 000000000000..96a8e65508b1 --- /dev/null +++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/listDashboardsBySubscription.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2020-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "lenses": [ + { + "order": 1, + "parts": [ + { + "position": { + "x": 1, + "y": 2, + "rowSpan": 4, + "colSpan": 3 + } + }, + { + "position": { + "x": 5, + "y": 5, + "rowSpan": 6, + "colSpan": 6 + } + } + ] + }, + { + "order": 2, + "parts": [] + } + ], + "metadata": { + "metadata": { + "X": 4, + "Y": 3, + "RowSpan": 1, + "ColSpan": 2 + } + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard", + "name": "testDashboard", + "type": "Microsoft.Portal/dashboards", + "location": "eastus", + "tags": { + "aKey": "aValue", + "anotherKey": "anotherValue" + } + }, + { + "properties": { + "lenses": [ + { + "order": 1, + "parts": [ + { + "position": { + "x": 1, + "y": 2, + "rowSpan": 4, + "colSpan": 3 + } + }, + { + "position": { + "x": 5, + "y": 5, + "rowSpan": 6, + "colSpan": 6 + } + } + ] + }, + { + "order": 2, + "parts": [] + } + ], + "metadata": { + "metadata": { + "X": 4, + "Y": 3, + "RowSpan": 1, + "ColSpan": 2 + } + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard2", + "name": "testDashboard2", + "type": "Microsoft.Portal/dashboards", + "location": "eastus", + "tags": { + "aKey": "aValue", + "anotherKey": "anotherValue" + } + } + ] + } + } + } +} diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/operationsList.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/operationsList.json new file mode 100644 index 000000000000..089068e1fb6d --- /dev/null +++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/operationsList.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2020-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Portal/dashboards/read", + "isDataAction": "false", + "display": { + "provider": "Microsoft Portal", + "resource": "Dashboards", + "operation": "Get Dashboard", + "description": "Reads the dashboards for the subscription." + } + }, + { + "name": "Microsoft.Portal/dashboards/write", + "isDataAction": "false", + "display": { + "provider": "Microsoft Portal", + "resource": "Dashboards", + "operation": "Set Dashboard", + "description": "Add or modify dashboard to a subscription." + } + }, + { + "name": "Microsoft.Portal/dashboards/delete", + "isDataAction": "false", + "display": { + "provider": "Microsoft Portal", + "resource": "Dashboards", + "operation": "Delete Dashboard", + "description": "Removes the dashboard from the subscription." + } + }, + { + "name": "Microsoft.Portal/register/action", + "isDataAction": "false", + "display": { + "provider": "Microsoft Portal", + "resource": "Portal Resource Provider", + "operation": "Registers the Portal Resource Provider", + "description": "Registers the subscription for the portal resource provider and enables shared dashboards." + } + } + ] + } + } + } +} diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/updateDashboard.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/updateDashboard.json new file mode 100644 index 000000000000..e0c901c6d277 --- /dev/null +++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/examples/updateDashboard.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "dashboardName": "testDashboard", + "resourceGroupName": "testRG", + "api-version": "2020-09-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "dashboard": { + "tags": { + "aKey": "bValue", + "anotherKey": "anotherValue2" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "lenses": [ + { + "order": 1, + "parts": [ + { + "position": { + "x": 1, + "y": 2, + "rowSpan": 4, + "colSpan": 3 + } + }, + { + "position": { + "x": 5, + "y": 5, + "rowSpan": 6, + "colSpan": 6 + } + } + ] + }, + { + "order": 2, + "parts": [] + } + ], + "metadata": { + "metadata": { + "X": 4, + "Y": 3, + "RowSpan": 1, + "ColSpan": 2 + } + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Portal/dashboards/testDashboard", + "name": "testDashboard", + "type": "Microsoft.Portal/dashboards", + "location": "eastus", + "tags": { + "aKey": "bValue", + "anotherKey": "anotherValue2" + } + } + } + } +} diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/portal.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/portal.json new file mode 100644 index 000000000000..c2531031f2bb --- /dev/null +++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/portal.json @@ -0,0 +1,761 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-09-01-preview", + "title": "portal", + "description": "Allows creation and deletion of Azure Shared Dashboards.", + "x-ms-code-generation-settings": { + "name": "portalClient" + } + }, + "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.Portal/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "List the portal operations": { + "$ref": "examples/operationsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "description": "The Microsoft Portal operations API.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/ResourceProviderOperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}": { + "put": { + "tags": [ + "Dashboard" + ], + "operationId": "Dashboards_CreateOrUpdate", + "x-ms-examples": { + "Create or update a Dashboard": { + "$ref": "examples/createOrUpdateDashboard.json" + } + }, + "description": "Creates or updates a Dashboard.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DashboardNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "dashboard", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Dashboard" + }, + "description": "The parameters required to create or update a dashboard." + } + ], + "responses": { + "201": { + "description": "Created response definition. Resource has been created", + "schema": { + "$ref": "#/definitions/Dashboard" + } + }, + "200": { + "description": "Resource already exists.", + "schema": { + "$ref": "#/definitions/Dashboard" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "Dashboard" + ], + "operationId": "Dashboards_Delete", + "x-ms-examples": { + "Delete a Dashboard": { + "$ref": "examples/deleteDashboard.json" + } + }, + "description": "Deletes the Dashboard.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DashboardNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK response definition." + }, + "204": { + "description": "OK resource was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "Dashboard" + ], + "operationId": "Dashboards_Get", + "x-ms-examples": { + "Get a Dashboard": { + "$ref": "examples/getDashboard.json" + } + }, + "description": "Gets the Dashboard.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DashboardNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/Dashboard" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "patch": { + "tags": [ + "Dashboard" + ], + "operationId": "Dashboards_Update", + "x-ms-examples": { + "Update a Dashboard": { + "$ref": "examples/updateDashboard.json" + } + }, + "description": "Updates an existing Dashboard.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DashboardNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "dashboard", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PatchableDashboard" + }, + "description": "The updatable fields of a Dashboard." + } + ], + "responses": { + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/Dashboard" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards": { + "get": { + "tags": [ + "Dashboard" + ], + "operationId": "Dashboards_ListByResourceGroup", + "x-ms-examples": { + "List all custom resource providers on the resourceGroup": { + "$ref": "examples/listDashboardsByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "description": "Gets all the Dashboards within a resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of Dashboards.", + "schema": { + "$ref": "#/definitions/DashboardListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Portal/dashboards": { + "get": { + "tags": [ + "Dashboard" + ], + "operationId": "Dashboards_ListBySubscription", + "x-ms-examples": { + "List all custom resource providers on the subscription": { + "$ref": "examples/listDashboardsBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "description": "Gets all the dashboards within a subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of dashboards.", + "schema": { + "$ref": "#/definitions/DashboardListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "DashboardListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Dashboard" + }, + "description": "The array of custom resource provider manifests." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of dashboards." + }, + "DashboardParts": { + "type": "object", + "description": "A dashboard part.", + "required": [ + "position" + ], + "properties": { + "position": { + "type": "object", + "required": [ + "x", + "y", + "rowSpan", + "colSpan" + ], + "description": "The dashboard's part position.", + "properties": { + "x": { + "type": "integer", + "description": "The dashboard's part x coordinate." + }, + "y": { + "type": "integer", + "description": "The dashboard's part y coordinate." + }, + "rowSpan": { + "type": "integer", + "description": "The dashboard's part row span." + }, + "colSpan": { + "type": "integer", + "description": "The dashboard's part column span." + }, + "metadata": { + "description": "The dashboard part's metadata.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "metadata": { + "description": "The dashboard part's metadata.", + "type": "object", + "$ref": "#/definitions/DashboardPartMetadata" + } + } + }, + "DashboardPartMetadata": { + "type": "object", + "required": [ + "type" + ], + "description": "A dashboard part metadata.", + "properties": { + "type": { + "type": "string", + "description": "The type of dashboard part." + } + }, + "discriminator": "type" + }, + "MarkdownPartMetadata": { + "type": "object", + "description": "Markdown part metadata.", + "x-ms-discriminator-value": "Extension/HubsExtension/PartType/MarkdownPart", + "allOf": [ + { + "$ref": "#/definitions/DashboardPartMetadata" + } + ], + "properties": { + "inputs": { + "type": "array", + "description": "Input to dashboard part.", + "items": { + "type": "object" + } + }, + "settings": { + "type": "object", + "description": "Markdown part settings.", + "properties": { + "content": { + "type": "object", + "description": "The content of markdown part.", + "properties": { + "settings": { + "type": "object", + "description": "The setting of the content of markdown part.", + "properties": { + "content": { + "type": "string", + "description": "The content of the markdown part." + }, + "title": { + "type": "string", + "description": "The title of the markdown part." + }, + "subtitle": { + "type": "string", + "description": "The subtitle of the markdown part." + }, + "markdownSource": { + "type": "object", + "description": "The source of the content of the markdown part." + }, + "markdownUri": { + "type": "string", + "description": "The uri of markdown content." + } + } + } + } + } + } + } + } + }, + "DashboardLens": { + "type": "object", + "description": "A dashboard lens.", + "required": [ + "order", + "parts" + ], + "properties": { + "order": { + "type": "integer", + "description": "The lens order." + }, + "parts": { + "type": "array", + "description": "The dashboard parts.", + "additionalProperties": { + "$ref": "#/definitions/DashboardParts" + }, + "items": { + "type": "object" + } + }, + "metadata": { + "description": "The dashboard len's metadata.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "DashboardProperties": { + "type": "object", + "description": "The shared dashboard properties.", + "properties": { + "lenses": { + "type": "array", + "description": "The dashboard lenses.", + "additionalProperties": { + "$ref": "#/definitions/DashboardLens" + }, + "items": { + "type": "object" + } + }, + "metadata": { + "description": "The dashboard metadata.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "Dashboard": { + "type": "object", + "description": "The shared dashboard resource definition.", + "x-ms-azure-resource": true, + "x-ms-client-flatten": true, + "required": [ + "location" + ], + "properties": { + "properties": { + "description": "The shared dashboard properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DashboardProperties" + }, + "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", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + } + }, + "PatchableDashboard": { + "type": "object", + "description": "The shared dashboard resource definition.", + "x-ms-azure-resource": true, + "x-ms-client-flatten": true, + "properties": { + "properties": { + "description": "The shared dashboard properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DashboardProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + } + }, + "ResourceProviderOperationList": { + "type": "object", + "description": "Results of the request to list operations.", + "readOnly": true, + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderOperation" + }, + "description": "List of operations supported by this resource provider." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + } + }, + "ResourceProviderOperation": { + "type": "object", + "description": "Supported operations of this resource provider.", + "readOnly": true, + "properties": { + "name": { + "description": "Operation name, in format of {provider}/{resource}/{operation}", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation applies to data-plane.", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Resource provider: Microsoft Custom Providers.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of this operation.", + "type": "string" + } + } + } + } + }, + "ErrorResponse": { + "type": "object", + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDefinition", + "description": "The error details." + } + } + }, + "ErrorDefinition": { + "type": "object", + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Internal error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDefinition" + }, + "readOnly": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "DashboardNameParameter": { + "name": "dashboardName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dashboard.", + "minLength": 3, + "maxLength": 64, + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to be used with the HTTP request." + } + } +} diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/tenantConfiguration.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/tenantConfiguration.json new file mode 100644 index 000000000000..c9acf88d1a48 --- /dev/null +++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/tenantConfiguration.json @@ -0,0 +1,256 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-09-01-preview", + "title": "portal", + "description": "Manage tenant configuration.", + "x-ms-code-generation-settings": { + "name": "portalClient" + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/providers/Microsoft.Portal/tenantConfigurations": { + "get": { + "tags": [ + "tenantConfiguration" + ], + "operationId": "TenantConfigurations_List", + "description": "Gets list of the tenant configurations.", + "parameters": [ + { + "$ref": "portal.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Returns the list of tenant configurations.", + "schema": { + "$ref": "#/definitions/ConfigurationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "portal.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get list of Tenant configurations": { + "$ref": "examples/TenantConfiguration/GetListOfTenantConfigurations.json" + } + } + } + }, + "/providers/Microsoft.Portal/tenantConfigurations/{configurationName}": { + "get": { + "tags": [ + "tenantConfiguration" + ], + "operationId": "TenantConfigurations_Get", + "description": "Gets the tenant configuration.", + "parameters": [ + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "portal.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Returns the tenant configuration.", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "portal.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Tenant configuration": { + "$ref": "examples/TenantConfiguration/GetTenantConfiguration.json" + } + } + }, + "put": { + "tags": [ + "tenantConfiguration" + ], + "operationId": "TenantConfigurations_Create", + "description": "Create the tenant configuration. If configuration already exists - update it. User has to be a Tenant Admin for this operation.", + "parameters": [ + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "portal.json#/parameters/ApiVersionParameter" + }, + { + "name": "tenantConfiguration", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Configuration" + }, + "description": "The parameters required to create or update tenant configuration." + } + ], + "responses": { + "201": { + "description": "Created. New configuration was created", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "200": { + "description": "OK. Existing configuration updated.", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "portal.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update Tenant configuration": { + "$ref": "examples/TenantConfiguration/CreateOrUpdateTenantConfiguration.json" + } + } + }, + "delete": { + "tags": [ + "tenantConfiguration" + ], + "operationId": "TenantConfigurations_Delete", + "description": "Delete the tenant configuration. User has to be a Tenant Admin for this operation.", + "parameters": [ + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "portal.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Configuration was deleted." + }, + "204": { + "description": "No content. Configuration was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "portal.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Tenant configuration": { + "$ref": "examples/TenantConfiguration/DeleteTenantConfiguration.json" + } + } + } + } + }, + "parameters": { + "ConfigurationNameParameter": { + "name": "configurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The configuration name. Value must be 'default'", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "configurationName", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "ConfigurationList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Configuration" + }, + "description": "The array of custom resource provider manifests." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of tenant configurations." + }, + "Configuration": { + "type": "object", + "description": "Tenant configuration.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConfigurationProperties", + "description": "Tenant configuration properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "ConfigurationProperties": { + "type": "object", + "description": "Tenant configuration properties.", + "x-ms-azure-resource": true, + "properties": { + "enforcePrivateMarkdownStorage": { + "type": "boolean", + "description": "When flag is set to true Markdown tile will require external storage configuration (URI). The inline content configuration will be prohibited." + } + } + } + }, + "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" + } + } + } +} diff --git a/specification/portal/resource-manager/readme.md b/specification/portal/resource-manager/readme.md index 389c00a6bfd6..1feda99144f3 100644 --- a/specification/portal/resource-manager/readme.md +++ b/specification/portal/resource-manager/readme.md @@ -26,9 +26,19 @@ These are the global settings for the portal. ``` yaml openapi-type: arm -tag: package-2019-01-01-preview +tag: package-2020-09-01-preview ``` + +### Tag: package-2020-09-01-preview + +These settings apply only when `--tag=package-2020-09-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2020-09-01-preview' +input-file: + - Microsoft.Portal/preview/2020-09-01-preview/portal.json + - Microsoft.Portal/preview/2020-09-01-preview/tenantConfiguration.json +``` ### Tag: package-2019-01-01-preview These settings apply only when `--tag=package-2019-01-01-preview` is specified on the command line. From f348535652dfa19050c903528130c55eb9ff4095 Mon Sep 17 00:00:00 2001 From: Suna Liu Date: Thu, 10 Sep 2020 07:38:29 +0800 Subject: [PATCH 024/164] Set publicNetworkAccess to read only in MySQL Flexible Server swagger (#10738) --- .../2020-07-01-privatepreview/examples/ServerCreate.json | 1 - .../2020-07-01-privatepreview/examples/ServerGet.json | 2 +- .../examples/ServerGetWithVnet.json | 2 +- .../2020-07-01-privatepreview/examples/ServerUpdate.json | 7 +++---- .../ServerUpdateWithCustomerMaintenanceWindow.json | 4 ++-- .../preview/2020-07-01-privatepreview/mysql.json | 9 ++++----- 6 files changed, 11 insertions(+), 14 deletions(-) diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerCreate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerCreate.json index 66901e5f2c54..428b56c8f4bf 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerCreate.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerCreate.json @@ -10,7 +10,6 @@ "administratorLogin": "cloudsa", "administratorLoginPassword": "pass$w0rd", "sslEnforcement": "Enabled", - "publicNetworkAccess": "Enabled", "storageProfile": { "storageMB": 128000, "storageIops": 200, diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerGet.json index 70ce494f9d78..7cbb5a26261b 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerGet.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerGet.json @@ -31,7 +31,7 @@ "haEnabled": "Enabled", "haState": "Healthy", "availabilityZone": "1", - "standByAvailabilityZone": "2", + "standbyAvailabilityZone": "2", "maintenanceWindow": { "dayOfWeek": 0, "startHour": 0, diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerGetWithVnet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerGetWithVnet.json index 728e6eb631cf..389a8dd0ee29 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerGetWithVnet.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerGetWithVnet.json @@ -26,7 +26,7 @@ "replicationRole": "None", "sourceServerId": "", "replicaCapacity": 5, - "publicNetworkAccess": "Enabled", + "publicNetworkAccess": "Disabled", "haEnabled": "Disabled", "delegatedSubnetArguments": { "subnetArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet" diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerUpdate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerUpdate.json index 5ce35b2dce59..5fc1612264ac 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerUpdate.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerUpdate.json @@ -7,8 +7,7 @@ "parameters": { "properties": { "administratorLoginPassword": "newpa$$w0rd", - "sslEnforcement": "Disabled", - "publicNetworkAccess": "Disabled" + "sslEnforcement": "Disabled" } } }, @@ -27,13 +26,13 @@ }, "version": "5.7", "sslEnforcement": "Disabled", - "publicNetworkAccess": "Disabled", + "publicNetworkAccess": "Enabled", "state": "Ready", "fullyQualifiedDomainName": "mysqltestsvc4.mysql.database.azure.com", "haEnabled": "Enabled", "haState": "Healthy", "availabilityZone": "1", - "standByAvailabilityZone": "2", + "standbyAvailabilityZone": "2", "maintenanceWindow": { "dayOfWeek": 0, "startHour": 0, diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerUpdateWithCustomerMaintenanceWindow.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerUpdateWithCustomerMaintenanceWindow.json index 3ee6ab2d831d..417d0843ccfb 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerUpdateWithCustomerMaintenanceWindow.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/examples/ServerUpdateWithCustomerMaintenanceWindow.json @@ -30,13 +30,13 @@ }, "version": "5.7", "sslEnforcement": "Disabled", - "publicNetworkAccess": "Disabled", + "publicNetworkAccess": "Enabled", "state": "Ready", "fullyQualifiedDomainName": "mysqltestsvc4.mysql.database.azure.com", "haEnabled": "Disabled", "haState": "NotEnabled", "availabilityZone": "1", - "standByAvailabilityZone": null, + "standbyAvailabilityZone": null, "maintenanceWindow": { "dayOfWeek": 0, "startHour": 8, diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json index 6b2d9e2a5270..d7e237cea7cb 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json @@ -1645,6 +1645,7 @@ "earliestRestoreDate": { "type": "string", "format": "date-time", + "readOnly": true, "description": "Earliest restore point creation time (ISO8601 format)" }, "storageProfile": { @@ -1659,10 +1660,12 @@ "type": "integer", "format": "int32", "minimum": 0, + "readOnly": true, "description": "The maximum number of replicas that a primary server can have." }, "publicNetworkAccess": { "$ref": "#/definitions/PublicNetworkAccess", + "readOnly": true, "description": "Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'" }, "maintenanceWindow": { @@ -1689,7 +1692,7 @@ "type": "string", "description": "availability Zone information of the server." }, - "standByAvailabilityZone": { + "standbyAvailabilityZone": { "type": "string", "description": "availability Zone information of the server.", "readOnly": true @@ -1776,10 +1779,6 @@ "$ref": "#/definitions/HaEnabled", "description": "Enable HA or not for a server." }, - "publicNetworkAccess": { - "$ref": "#/definitions/PublicNetworkAccess", - "description": "Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'" - }, "maintenanceWindow": { "$ref": "#/definitions/MaintenanceWindow", "description": "Maintenance window of a server." From dd2c281777dfbff57df212145766a4de662bfbe9 Mon Sep 17 00:00:00 2001 From: Chuang <54572251+xccc-msft@users.noreply.github.com> Date: Thu, 10 Sep 2020 10:09:40 +0800 Subject: [PATCH 025/164] update readme.java.md (#10682) --- specification/network/resource-manager/readme.java.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/specification/network/resource-manager/readme.java.md b/specification/network/resource-manager/readme.java.md index 482e85834e4b..19eb6c7ecd1a 100644 --- a/specification/network/resource-manager/readme.java.md +++ b/specification/network/resource-manager/readme.java.md @@ -20,6 +20,9 @@ directive: - rename-operation: from: VirtualHubBgpConnection_Delete to: VirtualHubBgpConnections_Delete + - rename-operation: + from: InboundSecurityRule_CreateOrUpdate + to: InboundSecurityRuleOperation_CreateOrUpdate ``` ### Java multi-api From 2890fbf3300522e89aeb6032917d5984195e04d4 Mon Sep 17 00:00:00 2001 From: Ruoxuan Wang <52271048+ruowan@users.noreply.github.com> Date: Thu, 10 Sep 2020 11:33:06 +0800 Subject: [PATCH 026/164] Update pull_request_assignment.yml (#10724) --- .github/pull_request_assignment.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/pull_request_assignment.yml b/.github/pull_request_assignment.yml index 9a63ac27ff5b..6f86ab255279 100644 --- a/.github/pull_request_assignment.yml +++ b/.github/pull_request_assignment.yml @@ -14,6 +14,7 @@ - "specification/network/**" reviewers: - MyronFanQiu + - lirenhe - rule: paths: From 1a6985b0227a0b9d9b72b3725416c536066750aa Mon Sep 17 00:00:00 2001 From: Siddique Juman Date: Wed, 9 Sep 2020 22:04:48 -0700 Subject: [PATCH 027/164] 2020-09-01-hybrid profile for AzureStack (#10295) * Rough draft of new profile for ignite * Addressing the review comments by updating the api versions * Fixing issues in Eventhub specs paths Co-authored-by: bganapa --- profile/2020-09-01-hybrid.json | 612 +++++++++++++++++++++++++++++++++ 1 file changed, 612 insertions(+) create mode 100644 profile/2020-09-01-hybrid.json diff --git a/profile/2020-09-01-hybrid.json b/profile/2020-09-01-hybrid.json new file mode 100644 index 000000000000..9e91801fb7f8 --- /dev/null +++ b/profile/2020-09-01-hybrid.json @@ -0,0 +1,612 @@ +{ + "info": { + "name": "2020-09-01-hybrid", + "description": "Profile definition targeted for hybrid applications that could run on azure stack general availability version and azure cloud for 2010." + }, + "resource-manager": { + "microsoft.authorization": { + "2016-09-01": [ + { + "resourceType": "locks", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/locks.json" + } + ], + "2016-12-01": [ + { + "resourceType": "policyAssignments", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Authorization/stable/2016-12-01/policyAssignments.json" + }, + { + "resourceType": "policyDefinitions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Authorization/stable/2016-12-01/policyDefinitions.json" + } + ], + "2015-07-01": [ + { + "resourceType": "permissions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/authorization/resource-manager/Microsoft.Authorization/stable/2015-07-01/authorization.json" + }, + { + "resourceType": "roleAssignments", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/authorization/resource-manager/Microsoft.Authorization/stable/2015-07-01/authorization.json" + }, + { + "resourceType": "roleDefinitions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/authorization/resource-manager/Microsoft.Authorization/stable/2015-07-01/authorization.json" + }, + { + "resourceType": "providerOperations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/authorization/resource-manager/Microsoft.Authorization/stable/2015-07-01/authorization.json" + } + ] + }, + "microsoft.commerce": { + "2015-06-01-preview":[ + { + "resourceType": "estimateResourceSpend", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json" + }, + { + "resourceType": "operations", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json" + }, + { + "resourceType": "subscriberUsageAggregates", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json" + }, + { + "resourceType": "usageAggregates", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json" + } + ] + }, + "microsoft.compute": { + "2020-06-01": [ + { + "resourceType": "availabilitySets", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json" + }, + { + "resourceType": "images", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json" + }, + { + "resourceType": "locations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json" + }, + { + "resourceType": "locations/publishers", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json" + }, + { + "resourceType": "locations/operations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json" + }, + { + "resourceType": "locations/usages", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json" + }, + { + "resourceType": "locations/vmSizes", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json" + }, + { + "resourceType": "operations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json" + }, + { + "resourceType": "virtualMachines", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json" + }, + { + "resourceType": "virtualMachines/extensions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json" + }, + { + "resourceType": "virtualMachineScaleSets", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json" + }, + { + "resourceType": "virtualMachineScaleSets/extensions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json" + }, + { + "resourceType": "virtualmachineScaleSets/networkInterfaces", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json" + }, + { + "resourceType": "virtualMachineScaleSets/virtualMachines", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json" + }, + { + "resourceType": "virtualMachineScaleSets/virtualMachines/networkInterfaces", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json" + } + ], + "2019-07-01": [ + { + "resourceType": "disks", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/disk.json" + }, + { + "resourceType": "snapshots", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/disk.json" + } + ] + }, + "microsoft.databoxedge":{ + "2019-08-01": [ + { + "resourceType": "dataBoxEdgeDevices", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2019-08-01/databoxedge.json" + }, + { + "resourceType": "dataBoxEdgeDevices/checkNameAvailability", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2019-08-01/databoxedge.json" + }, + { + "resourceType": "operations", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/stable/2019-08-01/databoxedge.json" + } + ] + }, + "microsoft.devices": { + "2019-07-01-preview":[ + { + "resourceType": "usages", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-07-01-preview/iothub.json" + }, + { + "resourceType": "locations", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-07-01-preview/iothub.json" + }, + { + "resourceType": "locations/quotas", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-07-01-preview/iothub.json" + }, + { + "resourceType": "locations/skus", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-07-01-preview/iothub.json" + }, + { + "resourceType": "checkNameAvailability", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-07-01-preview/iothub.json" + }, + { + "resourceType": "operations", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-07-01-preview/iothub.json" + }, + { + "resourceType": "operationResults", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-07-01-preview/iothub.json" + }, + { + "resourceType": "IotHubs", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-07-01-preview/iothub.json" + }, + { + "resourceType": "backupProviders", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-07-01-preview/iothub.json" + }, + { + "resourceType": "backupProviders/operationResults", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/iothub/resource-manager/Microsoft.Devices/preview/2019-07-01-preview/iothub.json" + } + ] + }, + "microsoft.eventhubs": { + "2018-01-01-preview": [ + { + "resourceType": "availableClusterRegions", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/AvailableClusterRegions-preview.json" + }, + { + "resourceType": "clusters", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json" + }, + { + "resourceType": "namespaces", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/namespaces-preview.json" + } + ], + "2017-04-01": [ + { + "resourceType": "checkNameAvailability", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json" + }, + { + "resourceType": "namespaces/authorizationRules", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json" + }, + { + "resourceType": "namespaces/eventhubs", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json" + }, + { + "resourceType": "namespaces/eventhubs/authorizationRules", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json" + }, + { + "resourceType": "namespaces/eventhubs/consumerGroups", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json" + }, + { + "resourceType": "operations", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json" + }, + { + "resourceType": "sku", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json" + } + ], + "2015-08-01": [ + { + "resourceType": "checkNamespaceAvailability", + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/EventHub.json" + } + ] + }, + "microsoft.insights": { + "2018-01-01": [ + { + "resourceType": "metricDefinitions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json" + }, + { + "resourceType": "metrics", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metrics_API.json" + } + ], + "2017-05-01-preview": [ + { + "resourceType": "diagnosticSettings", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json" + }, + { + "resourceType": "diagnosticSettingCategories", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json" + } + ], + "2015-04-01": [ + { + "resourceType": "eventCategories", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/eventCategories_API.json" + }, + { + "resourceType": "operations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json" + } + ] + }, + "microsoft.keyvault": { + "2019-09-01": [ + { + "resourceType": "operations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/providers.json" + }, + { + "resourceType": "vaults", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/keyvault.json" + }, + { + "resourceType": "vaults/accessPolicies", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/keyvault.json" + }, + { + "resourceType": "vaults/secrets", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2019-09-01/secrets.json" + } + ] + }, + "microsoft.network": { + "2018-11-01": [ + { + "resourceType": "connections", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/virtualNetworkGateway.json" + }, + { + "resourceType": "loadBalancers", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/loadBalancer.json" + }, + { + "resourceType": "localNetworkGateways", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/virtualNetworkGateway.json" + }, + { + "resourceType": "locations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/network.json" + }, + { + "resourceType": "locations/operationResults", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/network.json" + }, + { + "resourceType": "locations/operations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/network.json" + }, + { + "resourceType": "locations/usages", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/network.json" + }, + { + "resourceType": "networkInterfaces", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/networkInterface.json" + }, + { + "resourceType": "networkSecurityGroups", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/networkSecurityGroup.json" + }, + { + "resourceType": "operations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/operation.json" + }, + { + "resourceType": "publicIpAddresses", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/publicIpAddress.json" + }, + { + "resourceType": "routeTables", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/routeTable.json" + }, + { + "resourceType": "virtualNetworkGateways", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/virtualNetworkGateway.json" + }, + { + "resourceType": "virtualNetworks", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/virtualNetwork.json" + } + ], + "2016-04-01": [ + { + "resourceType": "dnsZones", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/dns/resource-manager/Microsoft.Network/stable/2016-04-01/dns.json" + } + ] + }, + "microsoft.resources": { + "2019-10-01": [ + { + "resourceType": "subscriptions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-06-01/subscriptions.json" + }, + { + "resourceType": "subscriptions/locations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-06-01/subscriptions.json" + }, + { + "resourceType": "tenants", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-06-01/subscriptions.json" + } + ], + "2018-05-01": [ + { + "resourceType": "deployments", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "deployments/operations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "links", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "locations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "operations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "providers", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "resourceGroups", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "resources", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "subscriptions/operationresults", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "subscriptions/providers", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "subscriptions/resourceGroups", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "subscriptions/resourceGroups/resources", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "subscriptions/resources", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "subscriptions/tagNames", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + }, + { + "resourceType": "subscriptions/tagNames/tagValues", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + } + ] + }, + "microsoft.storage": { + "2019-06-01": [ + { + "resourceType": "checkNameAvailability", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json" + }, + { + "resourceType": "locations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json" + }, + { + "resourceType": "locations/quotas", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json" + }, + { + "resourceType": "operations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json" + }, + { + "resourceType": "storageAccounts", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json" + }, + { + "resourceType": "storageAccounts/blobServices", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json" + }, + { + "resourceType": "storageAccounts/queueServices", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json" + }, + { + "resourceType": "storageAccounts/tableServices", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json" + }, + { + "resourceType": "usages", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json" + } + ] + }, + "microsoft.web": { + "2018-02-01": [ + { + "resourceType": "certificates", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Certificates.json" + }, + { + "resourceType": "operations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "checknameavailability", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/ResourceProvider.json" + }, + { + "resourceType": "metadata", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "sites", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "sites/domainOwnershipIdentifiers", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "sites/extensions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "sites/hostNameBindings", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "sites/instances", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "sites/instances/extensions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "sites/slots", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "sites/slots/hostNameBindings", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "sites/slots/instances", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "sites/slots/instances/extensions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + }, + { + "resourceType": "serverFarms", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json" + } + ], + "2016-09-01": [ + { + "resourceType": "serverFarms/metricDefinitions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-09-01/AppServicePlans.json" + }, + { + "resourceType": "serverFarms/metrics", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-09-01/AppServicePlans.json" + }, + { + "resourceType": "serverFarms/usages", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-09-01/AppServicePlans.json" + } + ], + "2016-03-01": [ + { + "resourceType": "availableStacks", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/Provider.json" + }, + { + "resourceType": "deploymentLocations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceProvider.json" + }, + { + "resourceType": "georegions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceProvider.json" + }, + { + "resourceType": "listSitesAssignedToHostName", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceProvider.json" + }, + { + "resourceType": "publishingUsers", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceProvider.json" + }, + { + "resourceType": "recommendations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/Recommendations.json" + }, + { + "resourceType": "sourceControls", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceProvider.json" + }, + { + "resourceType": "validate", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceProvider.json" + } + ] + } + }, + "data-plane": { + "microsoft.keyvault": { + "2016-10-01": [ + { + "resourceType": "*", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2016-10-01/keyvault.json" + } + ] + }, + "microsoft.storage": { + "resourceType": "*", + "2019-07-07": [] + } + } +} \ No newline at end of file From 81e598c10240b921307f2faf2dd953c45e90a9af Mon Sep 17 00:00:00 2001 From: Xuyang Cao Date: Thu, 10 Sep 2020 13:28:33 +0800 Subject: [PATCH 028/164] Update swagger for outbound public ip feature (#10713) * update swagger for outbound public ip feature * Update samples * prettier all the files * fix typo for 'outboundIPs' & 'publicIPs' properties Co-authored-by: Xuyang Cao --- .../2019-05-01-preview/appplatform.json | 15 ++++++++++ .../examples/Services_CreateOrUpdate.json | 20 +++++++++++-- ...Services_CreateOrUpdate_VNetInjection.json | 14 +++++++-- .../examples/Services_Get.json | 10 ++++++- .../examples/Services_List.json | 10 ++++++- .../examples/Services_ListBySubscription.json | 10 ++++++- .../examples/Services_Update.json | 20 +++++++++++-- .../stable/2020-07-01/appplatform.json | 15 ++++++++++ .../examples/Services_CreateOrUpdate.json | 30 +++++++++++++++++-- ...Services_CreateOrUpdate_VNetInjection.json | 21 +++++++++++-- .../2020-07-01/examples/Services_Get.json | 10 ++++++- .../2020-07-01/examples/Services_List.json | 10 ++++++- .../examples/Services_ListBySubscription.json | 10 ++++++- .../2020-07-01/examples/Services_Update.json | 20 +++++++++++-- 14 files changed, 195 insertions(+), 20 deletions(-) diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json index d456aa7594ed..f09b74a8b617 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json @@ -2479,6 +2479,21 @@ "appNetworkResourceGroup": { "description": "Name of the resource group containing network resources of Azure Spring Cloud Apps", "type": "string" + }, + "outboundIPs": { + "description": "Desired outbound IP resources for Azure Spring Cloud instance.", + "type": "object", + "readOnly": true, + "properties": { + "publicIPs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "A list of public IP addresses." + } + } } } }, diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_CreateOrUpdate.json index 025ca3152466..136def1b9f26 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_CreateOrUpdate.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_CreateOrUpdate.json @@ -54,7 +54,15 @@ "enabled": true, "appInsightInstrumentationKey": "00000000-0000-0000-0000-000000000000" }, - "serviceId": "12345678abcd1234abcd12345678abcd" + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + } + } }, "type": "Microsoft.AppPlatform/Spring", "sku": { @@ -90,7 +98,15 @@ "enabled": true, "appInsightInstrumentationKey": "00000000-0000-0000-0000-000000000000" }, - "serviceId": "12345678abcd1234abcd12345678abcd" + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + } + } }, "type": "Microsoft.AppPlatform/Spring", "sku": { diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_CreateOrUpdate_VNetInjection.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_CreateOrUpdate_VNetInjection.json index 282f4e0d1dc3..6df578357701 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_CreateOrUpdate_VNetInjection.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_CreateOrUpdate_VNetInjection.json @@ -34,7 +34,12 @@ "appSubnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/apps", "serviceCidr": "10.8.0.0/16,10.244.0.0/16,10.245.0.1/16", "serviceRuntimeNetworkResourceGroup": "my-service-runtime-network-rg", - "appNetworkResourceGroup": "my-app-network-rg" + "appNetworkResourceGroup": "my-app-network-rg", + "outboundIPs": { + "publicIPs": [ + "40.64.67.13" + ] + } }, "serviceId": "12345678abcd1234abcd12345678abcd" }, @@ -60,7 +65,12 @@ "appSubnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/apps", "serviceCidr": "10.8.0.0/16,10.244.0.0/16,10.245.0.1/16", "serviceRuntimeNetworkResourceGroup": "my-service-runtime-network-rg", - "appNetworkResourceGroup": "my-app-network-rg" + "appNetworkResourceGroup": "my-app-network-rg", + "outboundIPs": { + "publicIPs": [ + "40.64.67.13" + ] + } }, "serviceId": "12345678abcd1234abcd12345678abcd" }, diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_Get.json index 533a76844cc0..7d8d1007219c 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_Get.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_Get.json @@ -27,7 +27,15 @@ "enabled": true, "appInsightInstrumentationKey": "00000000-0000-0000-0000-000000000000" }, - "serviceId": "12345678abcd1234abcd12345678abcd" + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + } + } }, "type": "Microsoft.AppPlatform/Spring", "sku": { diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_List.json index 15723d2c8147..aff184407138 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_List.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_List.json @@ -28,7 +28,15 @@ "enabled": true, "appInsightInstrumentationKey": "00000000-0000-0000-0000-000000000000" }, - "serviceId": "12345678abcd1234abcd12345678abcd" + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + } + } }, "type": "Microsoft.AppPlatform/Spring", "sku": { diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_ListBySubscription.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_ListBySubscription.json index 3d07b6937972..daeaac0d14a6 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_ListBySubscription.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_ListBySubscription.json @@ -27,7 +27,15 @@ "enabled": true, "appInsightInstrumentationKey": "00000000-0000-0000-0000-000000000000" }, - "serviceId": "12345678abcd1234abcd12345678abcd" + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + } + } }, "type": "Microsoft.AppPlatform/Spring", "sku": { diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_Update.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_Update.json index 066d495c9f61..fcf36b043ad1 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_Update.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_Update.json @@ -54,7 +54,15 @@ "enabled": true, "appInsightInstrumentationKey": "00000000-0000-0000-0000-000000000000" }, - "serviceId": "12345678abcd1234abcd12345678abcd" + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + } + } }, "type": "Microsoft.AppPlatform/Spring", "sku": { @@ -90,7 +98,15 @@ "enabled": true, "appInsightInstrumentationKey": "00000000-0000-0000-0000-000000000000" }, - "serviceId": "12345678abcd1234abcd12345678abcd" + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + } + } }, "type": "Microsoft.AppPlatform/Spring", "sku": { diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/appplatform.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/appplatform.json index 17b94274d77c..655b3cbed58b 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/appplatform.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/appplatform.json @@ -2951,6 +2951,21 @@ "appNetworkResourceGroup": { "description": "Name of the resource group containing network resources of Azure Spring Cloud Apps", "type": "string" + }, + "outboundIPs": { + "description": "Desired outbound IP resources for Azure Spring Cloud instance.", + "type": "object", + "readOnly": true, + "properties": { + "publicIPs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "A list of public IP addresses." + } + } } } }, diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_CreateOrUpdate.json index 4d2b831c9689..6837e4ff3174 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_CreateOrUpdate.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_CreateOrUpdate.json @@ -21,7 +21,15 @@ "body": { "properties": { "provisioningState": "Creating", - "serviceId": "12345678abcd1234abcd12345678abcd" + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + } + } }, "type": "Microsoft.AppPlatform/Spring", "sku": { @@ -40,7 +48,15 @@ "body": { "properties": { "provisioningState": "Succeeded", - "serviceId": "12345678abcd1234abcd12345678abcd" + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + } + } }, "type": "Microsoft.AppPlatform/Spring", "sku": { @@ -59,7 +75,15 @@ "body": { "properties": { "provisioningState": "Updating", - "serviceId": "12345678abcd1234abcd12345678abcd" + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + } + } }, "type": "Microsoft.AppPlatform/Spring", "sku": { diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_CreateOrUpdate_VNetInjection.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_CreateOrUpdate_VNetInjection.json index c50a5afd6b74..b5e932ff99b3 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_CreateOrUpdate_VNetInjection.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_CreateOrUpdate_VNetInjection.json @@ -34,7 +34,12 @@ "appSubnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/apps", "serviceCidr": "10.8.0.0/16,10.244.0.0/16,10.245.0.1/16", "serviceRuntimeNetworkResourceGroup": "my-service-runtime-network-rg", - "appNetworkResourceGroup": "my-app-network-rg" + "appNetworkResourceGroup": "my-app-network-rg", + "outboundIPs": { + "publicIPs": [ + "40.64.67.13" + ] + } }, "serviceId": "12345678abcd1234abcd12345678abcd" }, @@ -60,7 +65,12 @@ "appSubnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/apps", "serviceCidr": "10.8.0.0/16,10.244.0.0/16,10.245.0.1/16", "serviceRuntimeNetworkResourceGroup": "my-service-runtime-network-rg", - "appNetworkResourceGroup": "my-app-network-rg" + "appNetworkResourceGroup": "my-app-network-rg", + "outboundIPs": { + "publicIPs": [ + "40.64.67.13" + ] + } }, "serviceId": "12345678abcd1234abcd12345678abcd" }, @@ -86,7 +96,12 @@ "appSubnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/apps", "serviceCidr": "10.8.0.0/16,10.244.0.0/16,10.245.0.1/16", "serviceRuntimeNetworkResourceGroup": "my-service-runtime-network-rg", - "appNetworkResourceGroup": "my-app-network-rg" + "appNetworkResourceGroup": "my-app-network-rg", + "outboundIPs": { + "publicIPs": [ + "40.64.67.13" + ] + } }, "serviceId": "12345678abcd1234abcd12345678abcd" }, diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_Get.json index e975ad624349..0af48fc29a7b 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_Get.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_Get.json @@ -10,7 +10,15 @@ "body": { "properties": { "provisioningState": "Succeeded", - "serviceId": "12345678abcd1234abcd12345678abcd" + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + } + } }, "type": "Microsoft.AppPlatform/Spring", "sku": { diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_List.json index 363548779800..0e6a9a8d02ed 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_List.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_List.json @@ -11,7 +11,15 @@ { "properties": { "provisioningState": "Succeeded", - "serviceId": "12345678abcd1234abcd12345678abcd" + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + } + } }, "type": "Microsoft.AppPlatform/Spring", "sku": { diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_ListBySubscription.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_ListBySubscription.json index 34b1eeca26f5..c8bfadb985b7 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_ListBySubscription.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_ListBySubscription.json @@ -10,7 +10,15 @@ { "properties": { "provisioningState": "Succeeded", - "serviceId": "12345678abcd1234abcd12345678abcd" + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + } + } }, "type": "Microsoft.AppPlatform/Spring", "sku": { diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_Update.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_Update.json index fd1e457c308d..0404e9a95e93 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_Update.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/examples/Services_Update.json @@ -21,7 +21,15 @@ "body": { "properties": { "provisioningState": "Updating", - "serviceId": "12345678abcd1234abcd12345678abcd" + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + } + } }, "type": "Microsoft.AppPlatform/Spring", "sku": { @@ -40,7 +48,15 @@ "body": { "properties": { "provisioningState": "Succeeded", - "serviceId": "12345678abcd1234abcd12345678abcd" + "serviceId": "12345678abcd1234abcd12345678abcd", + "networkProfile": { + "outboundIPs": { + "publicIPs": [ + "20.39.3.173", + "40.64.67.13" + ] + } + } }, "type": "Microsoft.AppPlatform/Spring", "sku": { From c064af9bcc606b6615ca7dc3945c986d8ad69da1 Mon Sep 17 00:00:00 2001 From: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com> Date: Thu, 10 Sep 2020 14:16:01 +0800 Subject: [PATCH 029/164] codegen onboard df for cli (#8531) --- .../datafactory/resource-manager/readme.az.md | 86 +++++++++++ .../resource-manager/readme.cli.md | 141 ++++++++---------- .../datafactory/resource-manager/readme.md | 28 +--- .../resource-manager/readme.python.md | 26 ++++ 4 files changed, 173 insertions(+), 108 deletions(-) create mode 100644 specification/datafactory/resource-manager/readme.az.md create mode 100644 specification/datafactory/resource-manager/readme.python.md diff --git a/specification/datafactory/resource-manager/readme.az.md b/specification/datafactory/resource-manager/readme.az.md new file mode 100644 index 000000000000..c66b104e4430 --- /dev/null +++ b/specification/datafactory/resource-manager/readme.az.md @@ -0,0 +1,86 @@ +## AZ + +These settings apply only when `--az` is specified on the command line. + +``` yaml $(az) +az: + extensions: datafactory + namespace: azure.mgmt.datafactory + package-name: azure-mgmt-datafactory + disable-checks: true + randomize-names: true +az-output-folder: $(azure-cli-extension-folder)/src/datafactory +python-sdk-output-folder: "$(az-output-folder)/azext_datafactory/vendored_sdks/datafactory" + +input-file: +- Microsoft.DataFactory/stable/2018-06-01/entityTypes/DataFlow.json +- Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json +- Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json +- Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +- Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +- Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json + +directive: + - from: swagger-document + where: $.definitions.JsonFormatFilePattern + transform: > + $['type'] = 'string'; + - from: swagger-document + where: $.definitions.CompressionLevel + transform: > + $['type'] = 'string'; + - from: swagger-document + where: $.definitions.DynamicsLinkedServiceTypeProperties.properties.servicePrincipalCredentialType + transform: > + $['type'] = 'string'; + - from: swagger-document + where: $.definitions.ScriptAction.properties.roles + transform: > + $['type'] = 'string'; + - where: + command: datafactory integration-runtime create-linked-integration-runtime + set: + command: datafactory integration-runtime linked-integration-runtime create + +cli: + cli-directive: + # directive on operationGroup + - where: + group: Pipelines + op: CreateOrUpdate$|CreateOrUpdate#Create + parameter: pipeline + json: true + - where: + group: IntegrationRuntimes + op: CreateOrUpdate + param: properties + poly-resource: true + - where: + group: IntegrationRuntimes + op: CreateOrUpdate#* + param: properties + poly-resource: true + - where: + group: ExposureControl|IntegrationRuntimeObjectMetadata|DataFlows|DataFlowDebugSession|ManagedVirtualNetworks|ManagedPrivateEndpoints + hidden: true + - where: + group: Factories + op: ConfigureFactoryRepo + param: locationId + name: location + - where: + group: IntegrationRuntimes + op: CreateLinkedIntegrationRuntime + param: dataFactoryLocation + name: location + - where: + group: Triggers|LinkedServices|Datasets + op: CreateOrUpdate#Update + param: properties + cli-flatten: true + - where: + group: Pipelines + op: CreateOrUpdate#Update + param: pipeline + cli-flatten: true +``` diff --git a/specification/datafactory/resource-manager/readme.cli.md b/specification/datafactory/resource-manager/readme.cli.md index 67b563417786..d50517ab5ce0 100644 --- a/specification/datafactory/resource-manager/readme.cli.md +++ b/specification/datafactory/resource-manager/readme.cli.md @@ -5,87 +5,66 @@ These settings apply only when `--cli` is specified on the command line. ``` yaml $(cli) cli: namespace: azure.mgmt.datafactory - flatten-all: true test-scenario: - name: Factories_CreateOrUpdate - #- name: Datasets_Create - #- name: Datasets_Update - #- name: Triggers_Update - #- name: Triggers_Create - #- name: DataFlows_Update - #- name: Pipelines_Create - #- name: DataFlows_Create - #- name: Pipelines_Update - #- name: LinkedServices_Create - #- name: LinkedServices_Update - #- name: IntegrationRuntimes_Create - #- name: RerunTriggers_Create - #- name: IntegrationRuntimeNodes_Get - #- name: IntegrationRuntimes_Get - #- name: RerunTriggers_ListByTrigger - #- name: LinkedServices_Get - #- name: PipelineRuns_Get - #- name: Pipelines_Get - #- name: DataFlows_Get - #- name: Datasets_Get - #- name: Triggers_Get - #- name: IntegrationRuntimes_ListByFactory - #- name: LinkedServices_ListByFactory - #- name: DataFlows_ListByFactory - #- name: Pipelines_ListByFactory - #- name: Triggers_ListByFactory - #- name: Datasets_ListByFactory - #- name: Factories_Get - #- name: Factories_ListByResourceGroup - #- name: Factories_List - #- name: Operations_List - #- name: IntegrationRuntimeNodes_GetIpAddress - #- name: IntegrationRuntimes_CreateLinkedIntegrationRuntime - #- name: RerunTriggers_Cancel - #- name: RerunTriggers_Start - #- name: IntegrationRuntimeNodes_Update - #- name: IntegrationRuntimeObjectMetadata_Refresh - #- name: RerunTriggers_Stop - #- name: IntegrationRuntimes_RegenerateAuthKey - #- name: Triggers_Rerun - #- name: IntegrationRuntimeObjectMetadata_Get - #- name: IntegrationRuntimes_GetConnectionInfo - #- name: IntegrationRuntimes_SyncCredentials - #- name: IntegrationRuntimes_GetMonitoringData - #- name: IntegrationRuntimes_ListAuthKeys - #- name: IntegrationRuntimes_Upgrade - #- name: IntegrationRuntimes_GetStatus - #- name: IntegrationRuntimes_Upgrade - #- name: IntegrationRuntimes_Start - #- name: IntegrationRuntimes_Stop - #- name: Triggers_GetEventSubscriptionStatus - #- name: ActivityRuns_QueryByPipelineRun - #- name: IntegrationRuntimes_Update - #- name: Triggers_UnsubscribeFromEvents - #- name: Triggers_SubscribeToEvents - #- name: PipelineRuns_Cancel - #- name: Pipelines_CreateRun - #- name: Triggers_Start - #- name: Triggers_Stop - #- name: DataFlowDebugSession_ExecuteCommand - #- name: DataFlowDebugSession_Delete - #- name: DataFlowDebugSession_Create - #- name: DataFlowDebugSession_QueryByFactory - #- name: DataFlowDebugSession_AddDataFlow - #- name: Factories_GetGitHubAccessToken - #- name: Factories_GetDataPlaneAccess - #- name: PipelineRuns_QueryByFactory - #- name: TriggerRuns_QueryByFactory - #- name: ExposureControl_GetFeatureValueByFactory - #- name: Factories_Update - #- name: Factories_ConfigureFactoryRepo - #- name: ExposureControl_GetFeatureValue - #- name: IntegrationRuntimesNodes_Delete - #- name: IntegrationRuntimes_Delete - #- name: LinkedServices_Delete - #- name: Pipelines_Delete - #- name: DataFlows_Delete - #- name: Datasets_Delete - #- name: Triggers_Delete - #- name: Factories_Delete + - name: Factories_Update + - name: LinkedServices_Create + - name: LinkedServices_Update + - name: Datasets_Create + - name: Datasets_Update + - name: Pipelines_Create + - name: Pipelines_Update + - name: Triggers_Create + - name: Triggers_Update + - name: IntegrationRuntimes_Create + - name: IntegrationRuntimes_Update + - name: IntegrationRuntimes_CreateLinkedIntegrationRuntime + - name: Pipelines_CreateRun + - name: IntegrationRuntimes_Get + - name: RerunTriggers_ListByTrigger + - name: LinkedServices_Get + - name: PipelineRuns_Get + - name: Pipelines_Get + - name: Datasets_Get + - name: Triggers_Get + - name: IntegrationRuntimes_ListByFactory + - name: LinkedServices_ListByFactory + - name: Pipelines_ListByFactory + - name: Triggers_ListByFactory + - name: Datasets_ListByFactory + - name: Factories_Get + - name: Factories_ListByResourceGroup + - name: Factories_List + - name: Operations_List + - name: RerunTriggers_Cancel + - name: RerunTriggers_Start + - name: RerunTriggers_Stop + - name: IntegrationRuntimes_RegenerateAuthKey + - name: TriggerRuns_Rerun + - name: IntegrationRuntimes_GetConnectionInfo + - name: IntegrationRuntimes_SyncCredentials + - name: IntegrationRuntimes_GetMonitoringData + - name: IntegrationRuntimes_ListAuthKeys + - name: IntegrationRuntimes_Upgrade + - name: IntegrationRuntimes_GetStatus + - name: IntegrationRuntimes_Start + - name: IntegrationRuntimes_Stop + - name: Triggers_GetEventSubscriptionStatus + - name: ActivityRuns_QueryByPipelineRun + - name: Triggers_UnsubscribeFromEvents + - name: Triggers_SubscribeToEvents + - name: Triggers_Start + - name: Triggers_Stop + - name: Factories_GetGitHubAccessToken + - name: Factories_GetDataPlaneAccess + - name: PipelineRuns_QueryByFactory + - name: PipelineRuns_Cancel + - name: TriggerRuns_QueryByFactory + - name: Factories_ConfigureFactoryRepo + - name: IntegrationRuntimes_Delete + - name: Triggers_Delete + - name: Pipelines_Delete + - name: Datasets_Delete + - name: LinkedServices_Delete + - name: Factories_Delete ``` diff --git a/specification/datafactory/resource-manager/readme.md b/specification/datafactory/resource-manager/readme.md index 8a68e4481768..73ba78baf313 100644 --- a/specification/datafactory/resource-manager/readme.md +++ b/specification/datafactory/resource-manager/readme.md @@ -65,6 +65,7 @@ swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-js - repo: azure-sdk-for-node + - repo: azure-cli-extensions - repo: azure-resource-manager-schemas after_scripts: - node sdkauto_afterscript.js datafactory/resource-manager @@ -85,33 +86,6 @@ csharp: clear-output-folder: true ``` -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.datafactory - package-name: azure-mgmt-datafactory - package-version: 1.0.0 - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/datafactory/azure-mgmt-datafactory/azure/mgmt/datafactory -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/datafactory/azure-mgmt-datafactory -``` ## Go diff --git a/specification/datafactory/resource-manager/readme.python.md b/specification/datafactory/resource-manager/readme.python.md new file mode 100644 index 000000000000..56d82b37fb7a --- /dev/null +++ b/specification/datafactory/resource-manager/readme.python.md @@ -0,0 +1,26 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: azure.mgmt.datafactory + package-name: azure-mgmt-datafactory + package-version: 1.0.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/datafactory/azure-mgmt-datafactory/azure/mgmt/datafactory +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/datafactory/azure-mgmt-datafactory +``` From b813f80c7058b9ee180161f6eeb9ce45f2c7e197 Mon Sep 17 00:00:00 2001 From: Ajit Navasare Date: Thu, 10 Sep 2020 00:27:04 -0700 Subject: [PATCH 030/164] Eventhub: Added PrivateEndpointConnection API (#10635) * Added PrivateEndpointConnection API * fix * updated description * lint fix * update * update * updated examples * reverted the erorrresonse changes * testing supperssion lintdiff errorresponse * suppres lintdiff * lintdiff fixes * correted the typo in readme Co-authored-by: v-ajnava --- .../AvailableClusterRegions-preview.json | 6 +- .../2018-01-01-preview/Clusters-preview.json | 60 +-- .../PrivateEndPointConnectionCreate.json | 57 +++ .../PrivateEndPointConnectionDelete.json | 14 + .../PrivateEndPointConnectionGet.json | 28 ++ .../PrivateEndPointConnectionList.json | 31 ++ .../NameSpaces/PrivateLinkResourcesGet.json | 30 ++ .../ipfilterrules-preview.json | 48 +- .../namespaces-preview.json | 461 ++++++++++++++++-- .../networkrulessets-preview.json | 22 +- .../operations-preview.json | 4 +- .../quotaConfiguration-preview.json | 20 +- .../virtualnetworkrules-preview.json | 48 +- .../stable/2017-04-01/AuthorizationRules.json | 194 ++++---- .../2017-04-01/CheckNameAvailability.json | 6 +- .../stable/2017-04-01/consumergroups.json | 60 +-- .../2017-04-01/disasterRecoveryConfigs.json | 82 ++-- .../stable/2017-04-01/eventhubs.json | 52 +- .../stable/2017-04-01/namespaces.json | 68 +-- .../stable/2017-04-01/networkRuleSets.json | 32 +- .../stable/2017-04-01/operations.json | 4 +- .../stable/2017-04-01/sku.json | 10 +- .../common/v1/definitions.json | 10 +- .../eventhub/resource-manager/readme.md | 7 + 24 files changed, 967 insertions(+), 387 deletions(-) create mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionCreate.json create mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionDelete.json create mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionGet.json create mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionList.json create mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/PrivateLinkResourcesGet.json rename specification/eventhub/resource-manager/{Microsoft.EventHub => }/common/v1/definitions.json (95%) diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/AvailableClusterRegions-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/AvailableClusterRegions-preview.json index 4c22e44c12d0..74ec2f20ba61 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/AvailableClusterRegions-preview.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/AvailableClusterRegions-preview.json @@ -48,10 +48,10 @@ "description": "List the quantity of available pre-provisioned Event Hubs Clusters, indexed by Azure region.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -64,7 +64,7 @@ "default": { "description": "Error response describing why available clusters could not be successfully listed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json index 548a7852cd5f..9300b0e7a82a 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json @@ -48,13 +48,13 @@ "description": "Lists the available Event Hubs Clusters within an ARM resource group", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -67,7 +67,7 @@ "default": { "description": "Event Hub Cluster error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -90,16 +90,16 @@ "description": "Gets the resource description of the specified Event Hubs Cluster.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ClusterNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ClusterNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -112,7 +112,7 @@ "default": { "description": "Event Hubs Cluster error response describing why the cluster description get operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -130,13 +130,13 @@ "description": "Creates or updates an instance of an Event Hubs Cluster.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ClusterNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ClusterNameParameter" }, { "name": "parameters", @@ -151,7 +151,7 @@ "description": "Parameters for creating a eventhub cluster resource." }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -173,7 +173,7 @@ "default": { "description": "Event Hubs error response detailing why the Event Hubs Cluster create or update operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -192,16 +192,16 @@ "description": "Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ClusterNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ClusterNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "name": "parameters", @@ -232,7 +232,7 @@ "default": { "description": "Event Hubs error response detailing why the Event Hubs Cluster update operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -251,16 +251,16 @@ "description": "Deletes an existing Event Hubs Cluster. This operation is idempotent.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ClusterNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ClusterNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -276,7 +276,7 @@ "default": { "description": "Event Hubs error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -291,16 +291,16 @@ "operationId": "Clusters_ListNamespaces", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ClusterNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ClusterNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "description": "List all Event Hubs Namespace IDs in an Event Hubs Dedicated Cluster.", @@ -319,7 +319,7 @@ "default": { "description": "Event Hubs Cluster error response detailing why this operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -362,7 +362,7 @@ }, "allOf": [ { - "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + "$ref": "../../../common/v1/definitions.json#/definitions/TrackedResource" } ], "description": "Single Event Hubs Cluster resource in List or Get operations." diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionCreate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionCreate.json new file mode 100644 index 000000000000..c485ea28d9f8 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionCreate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2924", + "resourceGroupName": "ArunMonocle", + "api-version": "2018-01-01-preview", + "subscriptionId": "subID", + "privateEndpointConnectionName": "privateEndpointConnectionName", + "parameters": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-8396/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-2847" + }, + "privateLinkServiceConnectionState": { + "status": "Rejected", + "description": "testing" + }, + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionDelete.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionDelete.json new file mode 100644 index 000000000000..68fd4f7ca8ae --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3285", + "resourceGroupName": "ArunMonocle", + "privateEndpointConnectionName": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "api-version": "2018-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionGet.json new file mode 100644 index 000000000000..801342ade57b --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5828", + "resourceGroupName": "SDK-EventHub-4794", + "privateEndpointConnectionName": "privateEndpointConnectionName", + "api-version": "2018-01-01-preview", + "subscriptionId": "subID" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateEndpointConnections/privateEndpointConnectionName", + "name": "privateEndpointConnectionName", + "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionList.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionList.json new file mode 100644 index 000000000000..4095c639f900 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5828", + "resourceGroupName": "SDK-EventHub-4794", + "api-version": "2018-01-01-preview", + "subscriptionId": "subID" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-7182/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5705-new/privateEndpointConnections/5dc668b3-70e4-437f-b61c-a3c1e594be7a", + "name": "5dc668b3-70e4-437f-b61c-a3c1e594be7a", + "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-EventHub-7182/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5705-new" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + ] + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/PrivateLinkResourcesGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/PrivateLinkResourcesGet.json new file mode 100644 index 000000000000..c71adb869dde --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/PrivateLinkResourcesGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2924", + "resourceGroupName": "ArunMonocle", + "api-version": "2018-01-01-preview", + "subscriptionId": "subID" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/subID/resourceGroups/SDK-EventHub-4794/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5828/privateLinkResources/namespace", + "name": "namespace", + "type": "Microsoft.EventHub/namespaces/privateLinkResources", + "properties": { + "groupId": "namespace", + "requiredMembers": [ + "namespace" + ], + "requiredZoneNames": [ + "privatelink.EventHub.windows.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/ipfilterrules-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/ipfilterrules-preview.json index 7382364c2424..2ce68eb88f9f 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/ipfilterrules-preview.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/ipfilterrules-preview.json @@ -48,16 +48,16 @@ "description": "Gets a list of IP Filter rules for a Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -70,7 +70,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -93,13 +93,13 @@ "description": "Creates or updates an IpFilterRule for a Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/IpFilterRuleNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/IpFilterRuleNameParameter" }, { "name": "parameters", @@ -111,10 +111,10 @@ "description": "The Namespace IpFilterRule." }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -127,7 +127,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -145,19 +145,19 @@ "description": "Deletes an IpFilterRule for a Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/IpFilterRuleNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/IpFilterRuleNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -170,7 +170,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -188,19 +188,19 @@ "description": "Gets an IpFilterRule for a Namespace by rule name.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/IpFilterRuleNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/IpFilterRuleNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -213,7 +213,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -252,7 +252,7 @@ }, "allOf": [ { - "$ref": "../../common/v1/definitions.json#/definitions/Resource" + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" } ], "description": "Single item in a List or Get IpFilterRules operation" diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/namespaces-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/namespaces-preview.json index 0f2174cfb648..02608d7b5225 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/namespaces-preview.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/namespaces-preview.json @@ -48,10 +48,10 @@ "description": "Lists all the available Namespaces within a subscription, irrespective of the resource groups.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -64,7 +64,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -87,13 +87,13 @@ "description": "Lists the available Namespaces within a resource group.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -106,7 +106,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -129,10 +129,10 @@ "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "name": "parameters", @@ -147,10 +147,10 @@ "description": "Parameters for creating a namespace resource." }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -172,7 +172,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -191,16 +191,16 @@ "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -216,7 +216,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -235,16 +235,16 @@ "description": "Gets the description of the specified namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -263,7 +263,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -281,10 +281,10 @@ "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "name": "parameters", @@ -296,10 +296,10 @@ "description": "Parameters for updating a namespace resource." }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -321,7 +321,259 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections": { + "get": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "x-ms-examples": { + "NameSpaceCreate": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionList.json" + } + }, + "description": "Gets the available PrivateEndpointConnections within a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "PrivateEndpointConnections successfully returned.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "EventHubEventHub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "put": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "x-ms-examples": { + "NameSpacePrivateEndPointConnectionCreate": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionCreate.json" + } + }, + "description": "Creates or updates PrivateEndpointConnections of service namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "Parameters supplied to update Status of PrivateEndPoint Connection to namespace resource." + } + ], + "responses": { + "200": { + "description": "Status of PrivateEndPoint Connection Created successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Request to update Status of PrivateEndPoint Connection accepted.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "x-ms-examples": { + "NameSpacePrivateEndPointConnectionDelete": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionDelete.json" + } + }, + "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "Private Endpoint Connection successfully deleted." + }, + "202": { + "description": "Private Endpoint Connection delete request accepted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "x-ms-examples": { + "NameSpacePrivateEndPointConnectionGet": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionGet.json" + } + }, + "description": "Gets a description for the specified Private Endpoint Connection name.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Private Endpoint Connection successfully returned.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/privateLinkResources": { + "get": { + "tags": [ + "Namespaces PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_Get", + "x-ms-examples": { + "NameSpacePrivateLinkResourcesGet": { + "$ref": "./examples/NameSpaces/PrivateLinkResourcesGet.json" + } + }, + "description": "Gets lists of resources that supports Privatelinks.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Private Link resource List", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -418,7 +670,7 @@ }, "allOf": [ { - "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + "$ref": "../../../common/v1/definitions.json#/definitions/TrackedResource" } ], "description": "Single Namespace item in List or Get Operation" @@ -534,6 +786,159 @@ } }, "description": "Properties to configure keyVault Properties" + }, + "PrivateEndpointConnection": { + "description": "Properties of the PrivateEndpointConnection.", + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Properties of the PrivateEndpointConnection.", + "x-ms-client-flatten": true + } + } + }, + "PrivateEndpointConnectionProperties": { + "description": "Properties of the private endpoint connection resource.", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The Private Endpoint resource for this Connection." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/ConnectionState", + "description": "Details about the state of the connection." + }, + "provisioningState": { + "description": "Provisioning state of the Private Endpoint Connection.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "EndPointProvisioningState", + "modelAsString": true + } + } + } + }, + "PrivateEndpoint": { + "description": "PrivateEndpoint information.", + "properties": { + "id": { + "description": "The ARM identifier for Private Endpoint.", + "type": "string" + } + } + }, + "ConnectionState": { + "description": "ConnectionState information.", + "properties": { + "status": { + "description": "Status of the connection.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkConnectionStatus", + "modelAsString": true + } + }, + "description": { + "description": "Description of the connection state.", + "type": "string" + } + } + }, + "PrivateEndpointConnectionListResult": { + "description": "Result of the list of all private endpoint connections operation.", + "properties": { + "value": { + "description": "A collection of private endpoint connection resources.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "description": "A link for the next page of private endpoint connection resources.", + "type": "string" + } + } + }, + "PrivateLinkResource": { + "description": "Information of the private link resource.", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Properties of the private link resource.", + "x-ms-client-flatten": true + }, + "id": { + "description": "Fully qualified identifier of the resource.", + "type": "string" + }, + "name": { + "description": "Name of the resource", + "type": "string" + }, + "type": { + "description": "Type of the resource", + "type": "string" + } + } + }, + "PrivateLinkResourceProperties": { + "description": "Properties of PrivateLinkResource", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string" + }, + "requiredMembers": { + "type": "array", + "description": "The private link resource required member names.", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "type": "array", + "description": "The private link resource Private link DNS zone name.", + "items": { + "type": "string" + } + } + } + }, + "PrivateLinkResourcesListResult": { + "description": "Result of the List private link resources operation.", + "properties": { + "value": { + "description": "A collection of private link resources", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "description": "A link for the next page of private link resources.", + "type": "string" + } + } } }, "parameters": {} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/networkrulessets-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/networkrulessets-preview.json index bf62ec9aa4a3..8d3a1c5da7b5 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/networkrulessets-preview.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/networkrulessets-preview.json @@ -48,16 +48,16 @@ "description": "Create or update NetworkRuleSet for a Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { "name": "parameters", @@ -79,7 +79,7 @@ "default": { "description": "ServiceBus error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -97,16 +97,16 @@ "description": "Gets NetworkRuleSet for a Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -119,7 +119,7 @@ "default": { "description": "ServiceBus error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -212,7 +212,7 @@ }, "allOf": [ { - "$ref": "../../common/v1/definitions.json#/definitions/Resource" + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" } ], "description": "Description of topic resource." diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/operations-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/operations-preview.json index 38b1a7b797f1..62e20b653170 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/operations-preview.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/operations-preview.json @@ -48,7 +48,7 @@ "description": "Lists all of the available Event Hub REST API operations.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -61,7 +61,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/quotaConfiguration-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/quotaConfiguration-preview.json index bbadf4caec7d..4ad879168429 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/quotaConfiguration-preview.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/quotaConfiguration-preview.json @@ -42,16 +42,16 @@ "operationId": "Configuration_Patch", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ClusterNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ClusterNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { "name": "parameters", @@ -91,7 +91,7 @@ "default": { "description": "Event Hubs Cluster error response describing why the get cluster quotas and settings operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -103,16 +103,16 @@ "operationId": "Configuration_Get", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ClusterNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ClusterNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "x-ms-examples": { @@ -131,7 +131,7 @@ "default": { "description": "Event Hubs Cluster error response describing why the get cluster quotas and settings operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/virtualnetworkrules-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/virtualnetworkrules-preview.json index fc417f5a93f5..e4936125742c 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/virtualnetworkrules-preview.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/virtualnetworkrules-preview.json @@ -48,16 +48,16 @@ "description": "Gets a list of VirtualNetwork rules for a Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -70,7 +70,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -93,19 +93,19 @@ "description": "Creates or updates an VirtualNetworkRule for a Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/VirtualNetworkRuleNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/VirtualNetworkRuleNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { "name": "parameters", @@ -127,7 +127,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -145,19 +145,19 @@ "description": "Deletes an VirtualNetworkRule for a Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/VirtualNetworkRuleNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/VirtualNetworkRuleNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -170,7 +170,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -188,19 +188,19 @@ "description": "Gets an VirtualNetworkRule for a Namespace by rule name.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/VirtualNetworkRuleNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/VirtualNetworkRuleNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -213,7 +213,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -236,7 +236,7 @@ }, "allOf": [ { - "$ref": "../../common/v1/definitions.json#/definitions/Resource" + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" } ], "description": "Single item in a List or Get VirtualNetworkRules operation" diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/AuthorizationRules.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/AuthorizationRules.json index 28d3422cedb3..b738f5d8b82e 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/AuthorizationRules.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/AuthorizationRules.json @@ -48,16 +48,16 @@ "description": "Gets a list of authorization rules for a Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -70,7 +70,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -93,13 +93,13 @@ "description": "Creates or updates an AuthorizationRule for a Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" }, { "name": "parameters", @@ -111,10 +111,10 @@ "description": "The shared access AuthorizationRule." }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -127,7 +127,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -145,19 +145,19 @@ "description": "Deletes an AuthorizationRule for a Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -170,7 +170,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -188,19 +188,19 @@ "description": "Gets an AuthorizationRule for a Namespace by rule name.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -213,7 +213,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -233,19 +233,19 @@ "description": "Gets the primary and secondary connection strings for the Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -258,7 +258,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -278,13 +278,13 @@ "description": "Regenerates the primary or secondary connection strings for the specified Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" }, { "name": "parameters", @@ -296,10 +296,10 @@ "description": "Parameters required to regenerate the connection string." }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -312,7 +312,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -332,19 +332,19 @@ "description": "Gets a list of authorization rules for a Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/AliasNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -357,7 +357,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -380,22 +380,22 @@ "description": "Gets an AuthorizationRule for a Namespace by rule name.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/AliasNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -408,7 +408,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -428,22 +428,22 @@ "description": "Gets the primary and secondary connection strings for the Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/AliasNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -456,7 +456,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -476,19 +476,19 @@ "description": "Gets the authorization rules for an Event Hub.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -501,7 +501,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -524,16 +524,16 @@ "description": "Creates or updates an AuthorizationRule for the specified Event Hub. Creation/update of the AuthorizationRule will take a few seconds to take effect.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" }, { "name": "parameters", @@ -545,10 +545,10 @@ "description": "The shared access AuthorizationRule." }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -561,7 +561,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -579,22 +579,22 @@ "description": "Gets an AuthorizationRule for an Event Hub by rule name.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -607,7 +607,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -625,22 +625,22 @@ "description": "Deletes an Event Hub AuthorizationRule.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -653,7 +653,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -673,22 +673,22 @@ "description": "Gets the ACS and SAS connection strings for the Event Hub.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -701,7 +701,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -721,16 +721,16 @@ "description": "Regenerates the ACS and SAS connection strings for the Event Hub.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" }, { "name": "parameters", @@ -742,10 +742,10 @@ "description": "Parameters supplied to regenerate the AuthorizationRule Keys (PrimaryKey/SecondaryKey)." }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -758,7 +758,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -812,7 +812,7 @@ }, "allOf": [ { - "$ref": "../../common/v1/definitions.json#/definitions/Resource" + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" } ], "description": "Single item in a List or Get AuthorizationRule operation" diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/CheckNameAvailability.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/CheckNameAvailability.json index d8b451acdd39..6ca247347f90 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/CheckNameAvailability.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/CheckNameAvailability.json @@ -48,10 +48,10 @@ "description": "Check the give Namespace name availability.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { "name": "parameters", @@ -73,7 +73,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/consumergroups.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/consumergroups.json index 3f9cf49a0dec..b74f5c4d0881 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/consumergroups.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/consumergroups.json @@ -48,16 +48,16 @@ "description": "Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ConsumerGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ConsumerGroupNameParameter" }, { "name": "parameters", @@ -69,10 +69,10 @@ "description": "Parameters supplied to create or update a consumer group resource." }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -85,7 +85,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -103,22 +103,22 @@ "description": "Deletes a consumer group from the specified Event Hub and resource group.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ConsumerGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ConsumerGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -131,7 +131,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -149,22 +149,22 @@ "description": "Gets a description for the specified consumer group.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ConsumerGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ConsumerGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -177,7 +177,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -197,25 +197,25 @@ "description": "Gets all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SkipParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/TopParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/TopParameter" } ], "responses": { @@ -228,7 +228,7 @@ "default": { "description": "Eventhub error response describing why the operation failed", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -266,7 +266,7 @@ }, "allOf": [ { - "$ref": "../../common/v1/definitions.json#/definitions/Resource" + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" } ], "description": "Single item in List or Get Consumer group operation" diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/disasterRecoveryConfigs.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/disasterRecoveryConfigs.json index 68c26c6f4bba..9b32c93c837a 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/disasterRecoveryConfigs.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/disasterRecoveryConfigs.json @@ -48,16 +48,16 @@ "description": "Check the give Namespace name availability.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "name": "parameters", @@ -79,7 +79,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -99,16 +99,16 @@ "description": "Gets all Alias(Disaster Recovery configurations)", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -121,7 +121,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -144,13 +144,13 @@ "description": "Creates or updates a new Alias(Disaster Recovery configuration)", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/AliasNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" }, { "name": "parameters", @@ -162,10 +162,10 @@ "description": "Parameters required to create an Alias(Disaster Recovery configuration)" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -181,7 +181,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -199,19 +199,19 @@ "description": "Deletes an Alias(Disaster Recovery configuration)", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/AliasNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -221,7 +221,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -239,19 +239,19 @@ "description": "Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/AliasNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -264,7 +264,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -284,19 +284,19 @@ "description": "This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/AliasNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -306,7 +306,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -326,19 +326,19 @@ "description": "Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/AliasNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -348,7 +348,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -455,7 +455,7 @@ }, "allOf": [ { - "$ref": "../../common/v1/definitions.json#/definitions/Resource" + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" } ], "description": "Single item in List or Get Alias(Disaster Recovery configuration) operation" diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/eventhubs.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/eventhubs.json index 7018d4b01cf6..6a0c933a21cf 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/eventhubs.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/eventhubs.json @@ -48,22 +48,22 @@ "description": "Gets all the Event Hubs in a Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SkipParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/TopParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/TopParameter" } ], "responses": { @@ -76,7 +76,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -99,13 +99,13 @@ "description": "Creates or updates a new Event Hub as a nested resource within a Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" }, { "name": "parameters", @@ -117,10 +117,10 @@ "description": "Parameters supplied to create an Event Hub resource." }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -133,7 +133,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -151,19 +151,19 @@ "description": "Deletes an Event Hub from the specified Namespace and resource group.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -176,7 +176,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -194,19 +194,19 @@ "description": "Gets an Event Hubs description for the specified Event Hub.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/EventHubNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/EventHubNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -219,7 +219,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -336,7 +336,7 @@ }, "allOf": [ { - "$ref": "../../common/v1/definitions.json#/definitions/Resource" + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" } ], "description": "Single item in List or Get Event Hub operation" diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/namespaces.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/namespaces.json index b58303be6651..455dbbeea42f 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/namespaces.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/namespaces.json @@ -48,10 +48,10 @@ "description": "Lists all the available Namespaces within a subscription, irrespective of the resource groups.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -64,7 +64,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -87,13 +87,13 @@ "description": "Lists the available Namespaces within a resource group.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -106,7 +106,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -129,10 +129,10 @@ "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "name": "parameters", @@ -147,10 +147,10 @@ "description": "Parameters for creating a namespace resource." }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -172,7 +172,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -191,16 +191,16 @@ "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -216,7 +216,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -235,16 +235,16 @@ "description": "Gets the description of the specified namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -263,7 +263,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -281,10 +281,10 @@ "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { "name": "parameters", @@ -296,10 +296,10 @@ "description": "Parameters for updating a namespace resource." }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -321,7 +321,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -341,16 +341,16 @@ "description": "Gets messaging plan for specified namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -363,7 +363,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -484,7 +484,7 @@ }, "allOf": [ { - "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + "$ref": "../../../common/v1/definitions.json#/definitions/TrackedResource" } ], "description": "Single Namespace item in List or Get Operation" @@ -523,7 +523,7 @@ }, "allOf": [ { - "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + "$ref": "../../../common/v1/definitions.json#/definitions/TrackedResource" } ], "description": "Messaging Plan for the namespace" diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/networkRuleSets.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/networkRuleSets.json index edb72a67288c..ce564ce00c3d 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/networkRuleSets.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/networkRuleSets.json @@ -48,16 +48,16 @@ "description": "Create or update NetworkRuleSet for a Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { "name": "parameters", @@ -79,7 +79,7 @@ "default": { "description": "EventHub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -97,16 +97,16 @@ "description": "Gets NetworkRuleSet for a Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -119,7 +119,7 @@ "default": { "description": "EventHub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } } @@ -139,16 +139,16 @@ "description": "Gets list of NetworkRuleSet for a Namespace.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -161,7 +161,7 @@ "default": { "description": "EventHub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -257,7 +257,7 @@ }, "allOf": [ { - "$ref": "../../common/v1/definitions.json#/definitions/Resource" + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" } ], "description": "Description of NetworkRuleSet resource." diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/operations.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/operations.json index 967a75365837..3766fecc4d77 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/operations.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/operations.json @@ -48,7 +48,7 @@ "description": "Lists all of the available Event Hub REST API operations.", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -61,7 +61,7 @@ "default": { "description": "Eventhub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/sku.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/sku.json index 1d69a375178a..28e64afd14e3 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/sku.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/sku.json @@ -51,13 +51,13 @@ "description": "Gets the available Regions for a given sku", "parameters": [ { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../common/v1/definitions.json#/parameters/SkuNameParameter" + "$ref": "../../../common/v1/definitions.json#/parameters/SkuNameParameter" } ], "responses": { @@ -70,7 +70,7 @@ "default": { "description": "EventHub error response describing why the operation failed.", "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, @@ -101,7 +101,7 @@ }, "allOf": [ { - "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + "$ref": "../../../common/v1/definitions.json#/definitions/TrackedResource" } ], "description": "Messaging Region" diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/common/v1/definitions.json b/specification/eventhub/resource-manager/common/v1/definitions.json similarity index 95% rename from specification/eventhub/resource-manager/Microsoft.EventHub/common/v1/definitions.json rename to specification/eventhub/resource-manager/common/v1/definitions.json index bf8b1144fc18..780fed1348d1 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/common/v1/definitions.json +++ b/specification/eventhub/resource-manager/common/v1/definitions.json @@ -19,7 +19,7 @@ } }, "info": { - "version": "2017-04-01", + "version": "1.0", "title": "Common types" }, "paths": {}, @@ -120,6 +120,14 @@ "x-ms-parameter-location": "method", "description": "The Namespace name" }, + "PrivateEndpointConnectionNameParameter": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The PrivateEndpointConnection name" + }, "EventHubNameParameter": { "name": "eventHubName", "in": "path", diff --git a/specification/eventhub/resource-manager/readme.md b/specification/eventhub/resource-manager/readme.md index 86d8aa64788b..b717c083c289 100644 --- a/specification/eventhub/resource-manager/readme.md +++ b/specification/eventhub/resource-manager/readme.md @@ -29,6 +29,13 @@ openapi-type: arm tag: package-2018-01-preview ``` +## Suppression + +``` yaml +directive: + - suppress: R4007 + reason: DefaultErrorResponseSchema - we will be Implementing in new API version +``` ### Tag: package-2017-04 From 3f4d11b1996c6da78de1e7d2765b7be390a8a38a Mon Sep 17 00:00:00 2001 From: Ajit Navasare Date: Thu, 10 Sep 2020 01:13:27 -0700 Subject: [PATCH 031/164] ServiceBus : Swagger Split and Added PrivateEndPointConnection API (#10071) * Swagger Split and Added PrivateEndPointConnection API * updated custom-words.txt * prettier check fix * updated Readme * removed the ub-referenced file * Operations API * fix avocado * fix for UniqueXmsEnumName * updated description * update * updated resource * fix for modelvalidation * version update in definition * added examples * updated examples * fix for avocado - INCONSISTENT_API_VERSION * updated azureresourceschema.md --- custom-words.txt | 5 +- .../IPFilterRules-preview.json | 278 + .../NetworkRuleSet-preview.json | 218 + .../VirtualNetworkRules-preview.json | 262 + .../PrivateEndPointConnectionCreate.json | 57 + .../PrivateEndPointConnectionDelete.json | 14 + .../PrivateEndPointConnectionGet.json | 28 + .../PrivateEndPointConnectionList.json | 31 + .../NameSpaces/PrivateLinkResourcesGet.json | 30 + .../NameSpaces/SBNameSpaceCreate.json | 2 +- .../NameSpaces/SBNameSpaceDelete.json | 2 +- .../examples/NameSpaces/SBNameSpaceGet.json | 2 +- .../examples/NameSpaces/SBNameSpaceList.json | 2 +- .../SBNameSpaceListByResourceGroup.json | 2 +- .../NameSpaces/SBNameSpaceUpdate.json | 2 +- .../2018-01-01-preview/namespace-preview.json | 968 ++++ .../operationlist-preview.json | 126 + .../servicebus-preview.json | 1437 ----- .../stable/2017-04-01/AuthorizationRules.json | 1095 ++++ .../2017-04-01/CheckNameAvailability.json | 132 + .../2017-04-01/DisasterRecoveryConfig.json | 750 +++ .../2017-04-01/PremiumMessagingRegions.json | 280 + .../stable/2017-04-01/Queue.json | 381 ++ .../stable/2017-04-01/Rules.json | 447 ++ .../stable/2017-04-01/eventhubs.json | 227 + .../stable/2017-04-01/migrate.json | 113 + .../stable/2017-04-01/migrationconfigs.json | 375 ++ .../stable/2017-04-01/namespaces.json | 491 ++ .../stable/2017-04-01/networksets.json | 283 + .../stable/2017-04-01/operations.json | 126 + .../stable/2017-04-01/servicebus.json | 4922 ----------------- .../stable/2017-04-01/sku.json | 145 + .../stable/2017-04-01/subscriptions.json | 374 ++ .../stable/2017-04-01/topics.json | 359 ++ .../common/v1/definitions.json | 359 ++ .../readme.azureresourceschema.md | 22 +- .../servicebus/resource-manager/readme.md | 58 +- 37 files changed, 8031 insertions(+), 6374 deletions(-) create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/IPFilterRules-preview.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/NetworkRuleSet-preview.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/VirtualNetworkRules-preview.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionCreate.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionDelete.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionGet.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionList.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/PrivateLinkResourcesGet.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/namespace-preview.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/operationlist-preview.json delete mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/servicebus-preview.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/AuthorizationRules.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/CheckNameAvailability.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/DisasterRecoveryConfig.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/PremiumMessagingRegions.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/Queue.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/Rules.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/eventhubs.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/migrate.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/migrationconfigs.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/namespaces.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/networksets.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/operations.json delete mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/servicebus.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/sku.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/subscriptions.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/topics.json create mode 100644 specification/servicebus/resource-manager/common/v1/definitions.json diff --git a/custom-words.txt b/custom-words.txt index d921807d036e..a77f70924266 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1879,4 +1879,7 @@ Stix STIX Mibps ntfs -shamir_share +networkrulesets +Setget +Ruleproperties +shamir_share \ No newline at end of file diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/IPFilterRules-preview.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/IPFilterRules-preview.json new file mode 100644 index 000000000000..f02d9ac717c8 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/IPFilterRules-preview.json @@ -0,0 +1,278 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client for managing Namespace, IPFilter Rules, VirtualNetworkRules and Zone Redundant", + "version": "2018-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/ipfilterrules": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListIpFilterRules", + "x-ms-examples": { + "ListIpFilterRules": { + "$ref": "./examples/NameSpaces/IPFilterRule/SBNameSpaceIPFilterRuleListAll.json" + } + }, + "description": "Gets a list of IP Filter rules for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace IpFilterRule successfully returned.", + "schema": { + "$ref": "#/definitions/IpFilterRuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/ipfilterrules/{ipFilterRuleName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdateIpFilterRule", + "x-ms-examples": { + "NameSpaceIpFilterRuleCreate": { + "$ref": "./examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleCreateorUpdate.json" + } + }, + "description": "Creates or updates an IpFilterRule for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/IpFilterRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IpFilterRule" + }, + "description": "The Namespace IpFilterRule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace IpFilterRule created", + "schema": { + "$ref": "#/definitions/IpFilterRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_DeleteIpFilterRule", + "x-ms-examples": { + "NameSpaceIpFilterRuleDelete": { + "$ref": "./examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleDelete.json" + } + }, + "description": "Deletes an IpFilterRule for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/IpFilterRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace IpFilterRule successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_GetIpFilterRule", + "x-ms-examples": { + "NameSpaceIpFilterRuleGet": { + "$ref": "./examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleGet.json" + } + }, + "description": "Gets an IpFilterRule for a Namespace by rule name.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/IpFilterRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace IpFilterRule returned successfully.", + "schema": { + "$ref": "#/definitions/IpFilterRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "IpFilterRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "ipMask": { + "type": "string", + "description": "IP Mask" + }, + "action": { + "type": "string", + "description": "The IP Filter Action", + "enum": [ + "Accept", + "Reject" + ], + "x-ms-enum": { + "name": "IPAction", + "modelAsString": true + } + }, + "filterName": { + "type": "string", + "description": "IP Filter name" + } + }, + "description": "Properties supplied to create or update IpFilterRules" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Single item in a List or Get IpFilterRules operation" + }, + "IpFilterRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IpFilterRule" + }, + "description": "Result of the List IpFilter Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains an incomplete list of IpFilter Rules" + } + }, + "description": "The response from the List namespace operation." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/NetworkRuleSet-preview.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/NetworkRuleSet-preview.json new file mode 100644 index 000000000000..adaa6ddb1ec1 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/NetworkRuleSet-preview.json @@ -0,0 +1,218 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client for managing Namespace, IPFilter Rules, VirtualNetworkRules and Zone Redundant", + "version": "2018-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkrulesets/default": { + "put": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceVirtualNetworkRuleSetCreate": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json" + } + }, + "operationId": "Namespaces_CreateOrUpdateNetworkRuleSet", + "description": "Gets NetworkRuleSet for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + }, + "description": "The Namespace NetworkRuleSet." + } + ], + "responses": { + "200": { + "description": "Namespace NetworkRuleSet successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceVirtualNetworkRuleSetget": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json" + } + }, + "operationId": "Namespaces_GetNetworkRuleSet", + "description": "Gets NetworkRuleSet for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace NetworkRuleSet successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Subnet": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID of Virtual Network Subnet" + } + }, + "description": "Properties supplied for Subnet" + }, + "NWRuleSetIpRules": { + "x-ms-client-flatten": true, + "properties": { + "ipMask": { + "type": "string", + "description": "IP Mask" + }, + "action": { + "type": "string", + "description": "The IP Filter Action", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "NetworkRuleIPAction", + "modelAsString": true + } + } + }, + "description": "The response from the List namespace operation." + }, + "NWRuleSetVirtualNetworkRules": { + "x-ms-client-flatten": true, + "properties": { + "subnet": { + "$ref": "#/definitions/Subnet", + "description": "Subnet properties" + }, + "ignoreMissingVnetServiceEndpoint": { + "type": "boolean", + "description": "Value that indicates whether to ignore missing Vnet Service Endpoint" + } + }, + "description": "The response from the List namespace operation." + }, + "NetworkRuleSet": { + "properties": { + "properties": { + "description": "NetworkRuleSet properties", + "x-ms-client-flatten": true, + "properties": { + "defaultAction": { + "type": "string", + "description": "Default Action for Network Rule Set", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "DefaultAction", + "modelAsString": true + } + }, + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetVirtualNetworkRules" + }, + "description": "List VirtualNetwork Rules" + }, + "ipRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetIpRules" + }, + "description": "List of IpRules" + } + } + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Description of topic resource." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/VirtualNetworkRules-preview.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/VirtualNetworkRules-preview.json new file mode 100644 index 000000000000..317ff3dcc018 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/VirtualNetworkRules-preview.json @@ -0,0 +1,262 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client for managing Namespace, IPFilter Rules, VirtualNetworkRules and Zone Redundant", + "version": "2018-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/virtualnetworkrules": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListVirtualNetworkRules", + "x-ms-examples": { + "ListIpFilterRules": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleListAll.json" + } + }, + "description": "Gets a list of VirtualNetwork rules for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace VirtualNetworkRule successfully returned.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/virtualnetworkrules/{virtualNetworkRuleName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdateVirtualNetworkRule", + "x-ms-examples": { + "NameSpaceVirtualNetworkRuleCreate": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleCreateorUpdate.json" + } + }, + "description": "Creates or updates an VirtualNetworkRule for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/VirtualNetworkRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + }, + "description": "The Namespace VirtualNetworkRule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace VirtualNetworkRule created", + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_DeleteVirtualNetworkRule", + "x-ms-examples": { + "NameSpaceVirtualNetworkRuleDelete": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleDelete.json" + } + }, + "description": "Deletes an VirtualNetworkRule for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/VirtualNetworkRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace VirtualNetworkRule successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_GetVirtualNetworkRule", + "x-ms-examples": { + "NameSpaceVirtualNetworkRuleGet": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleGet.json" + } + }, + "description": "Gets an VirtualNetworkRule for a Namespace by rule name.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/VirtualNetworkRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace VirtualNetworkRule returned successfully.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "VirtualNetworkRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "virtualNetworkSubnetId": { + "type": "string", + "description": "Resource ID of Virtual Network Subnet" + } + }, + "description": "Properties supplied to create or update VirtualNetworkRules" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Single item in a List or Get VirtualNetworkRules operation" + }, + "VirtualNetworkRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + }, + "description": "Result of the List VirtualNetwork Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains an incomplete list of VirtualNetwork Rules" + } + }, + "description": "The response from the List namespace operation." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionCreate.json new file mode 100644 index 000000000000..4de96524d573 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionCreate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2924", + "resourceGroupName": "ArunMonocle", + "api-version": "2018-01-01-preview", + "subscriptionId": "subID", + "privateEndpointConnectionName": "privateEndpointConnectionName", + "parameters": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-8396/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-2847" + }, + "privateLinkServiceConnectionState": { + "status": "Rejected", + "description": "testing" + }, + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "name": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionDelete.json new file mode 100644 index 000000000000..68fd4f7ca8ae --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-3285", + "resourceGroupName": "ArunMonocle", + "privateEndpointConnectionName": "928c44d5-b7c6-423b-b6fa-811e0c27b3e0", + "api-version": "2018-01-01-preview", + "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionGet.json new file mode 100644 index 000000000000..59d91c8508cf --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5828", + "resourceGroupName": "SDK-ServiceBus-4794", + "privateEndpointConnectionName": "privateEndpointConnectionName", + "api-version": "2018-01-01-preview", + "subscriptionId": "subID" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateEndpointConnections/privateEndpointConnectionName", + "name": "privateEndpointConnectionName", + "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5828" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionList.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionList.json new file mode 100644 index 000000000000..3bbc4b026f43 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/PrivateEndPointConnectionList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5828", + "resourceGroupName": "SDK-ServiceBus-4794", + "api-version": "2018-01-01-preview", + "subscriptionId": "subID" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-7182/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5705-new/privateEndpointConnections/5dc668b3-70e4-437f-b61c-a3c1e594be7a", + "name": "5dc668b3-70e4-437f-b61c-a3c1e594be7a", + "type": "Microsoft.ServiceBus/Namespaces/PrivateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/dbedb4e0-40e6-4145-81f3-f1314c150774/resourceGroups/SDK-ServiceBus-7182/providers/Microsoft.Network/privateEndpoints/sdk-Namespace-5705-new" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/PrivateLinkResourcesGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/PrivateLinkResourcesGet.json new file mode 100644 index 000000000000..c1ace47195d3 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/PrivateLinkResourcesGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-2924", + "resourceGroupName": "ArunMonocle", + "api-version": "2018-01-01-preview", + "subscriptionId": "subID" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/subID/resourceGroups/SDK-ServiceBus-4794/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5828/privateLinkResources/namespace", + "name": "namespace", + "type": "Microsoft.ServiceBus/namespaces/privateLinkResources", + "properties": { + "groupId": "namespace", + "requiredMembers": [ + "namespace" + ], + "requiredZoneNames": [ + "privatelink.servicebus.windows.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceCreate.json index 273a70b3260d..951500ff5854 100644 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceCreate.json +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceCreate.json @@ -2,7 +2,7 @@ "parameters": { "namespaceName": "sdk-Namespace2924", "resourceGroupName": "ArunMonocle", - "api-version": "2017-04-01", + "api-version": "2018-01-01-preview", "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", "parameters": { "sku": { diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceDelete.json index 747d0b106269..a458cb82e01a 100644 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceDelete.json +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceDelete.json @@ -2,7 +2,7 @@ "parameters": { "namespaceName": "sdk-Namespace-3285", "resourceGroupName": "ArunMonocle", - "api-version": "2017-04-01", + "api-version": "2018-01-01-preview", "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" }, "responses": { diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceGet.json index 0afe4e79a6b7..6f2d4a002b41 100644 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceGet.json +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceGet.json @@ -2,7 +2,7 @@ "parameters": { "namespaceName": "sdk-Namespace-2924", "resourceGroupName": "ArunMonocle", - "api-version": "2017-04-01", + "api-version": "2018-01-01-preview", "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" }, "responses": { diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceList.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceList.json index 7e3dcb10e2f7..f1391889645d 100644 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceList.json +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2017-04-01", + "api-version": "2018-01-01-preview", "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4" }, "responses": { diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceListByResourceGroup.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceListByResourceGroup.json index 5704dd8f2e78..34a52c6ed57c 100644 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceListByResourceGroup.json +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceListByResourceGroup.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2017-04-01", + "api-version": "2018-01-01-preview", "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", "resourceGroupName": "ArunMonocle" }, diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceUpdate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceUpdate.json index ae587b027e02..51527f927861 100644 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceUpdate.json +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/SBNameSpaceUpdate.json @@ -2,7 +2,7 @@ "parameters": { "namespaceName": "sdk-Namespace-3285", "resourceGroupName": "ArunMonocle", - "api-version": "2017-04-01", + "api-version": "2018-01-01-preview", "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", "parameters": { "location": "South Central US", diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/namespace-preview.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/namespace-preview.json new file mode 100644 index 000000000000..c0c3b8bd4637 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/namespace-preview.json @@ -0,0 +1,968 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client for managing Namespace, IPFilter Rules, VirtualNetworkRules and Zone Redundant", + "version": "2018-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_List", + "x-ms-examples": { + "NameSpaceList": { + "$ref": "./examples/NameSpaces/SBNameSpaceList.json" + } + }, + "description": "Gets all the available namespaces within the subscription, irrespective of the resource groups.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespaces successfully returned.", + "schema": { + "$ref": "#/definitions/SBNamespaceListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListByResourceGroup", + "x-ms-examples": { + "NameSpaceListByResourceGroup": { + "$ref": "./examples/NameSpaces/SBNameSpaceListByResourceGroup.json" + } + }, + "description": "Gets the available namespaces within a resource group.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespaces successfully returned.", + "schema": { + "$ref": "#/definitions/SBNamespaceListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdate", + "x-ms-examples": { + "NameSpaceCreate": { + "$ref": "./examples/NameSpaces/SBNameSpaceCreate.json" + } + }, + "description": "Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBNamespace" + }, + "description": "Parameters supplied to create a namespace resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace created successfully.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "201": { + "description": "Namespace create request accepted.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "202": { + "description": "Namespace create or update request accepted." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Delete", + "x-ms-examples": { + "NameSpaceDelete": { + "$ref": "./examples/NameSpaces/SBNameSpaceDelete.json" + } + }, + "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace successfully deleted." + }, + "202": { + "description": "Namespace delete request accepted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Get", + "x-ms-examples": { + "NameSpaceGet": { + "$ref": "./examples/NameSpaces/SBNameSpaceGet.json" + } + }, + "description": "Gets a description for the specified namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace successfully returned.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Update", + "x-ms-examples": { + "NameSpaceUpdate": { + "$ref": "./examples/NameSpaces/SBNameSpaceUpdate.json" + } + }, + "description": "Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBNamespaceUpdateParameters" + }, + "description": "Parameters supplied to update a namespace resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace updated successfully.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "201": { + "description": "Namespace update request accepted.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "202": { + "description": "Namespace update request accepted." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections": { + "get": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "x-ms-examples": { + "NameSpaceCreate": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionList.json" + } + }, + "description": "Gets the available PrivateEndpointConnections within a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "PrivateEndpointConnections successfully returned.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "put": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "x-ms-examples": { + "NameSpacePrivateEndPointConnectionCreate": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionCreate.json" + } + }, + "description": "Creates or updates PrivateEndpointConnections of service namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "Parameters supplied to update Status of PrivateEndPoint Connection to namespace resource." + } + ], + "responses": { + "200": { + "description": "Status of PrivateEndPoint Connection Created successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Request to update Status of PrivateEndPoint Connection accepted.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "x-ms-examples": { + "NameSpacePrivateEndPointConnectionDelete": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionDelete.json" + } + }, + "description": "Deletes an existing Private Endpoint Connection.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "Private Endpoint Connection successfully deleted." + }, + "202": { + "description": "Private Endpoint Connection delete request accepted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Namespaces PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "x-ms-examples": { + "NameSpacePrivateEndPointConnectionGet": { + "$ref": "./examples/NameSpaces/PrivateEndPointConnectionGet.json" + } + }, + "description": "Gets a description for the specified Private Endpoint Connection.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Description of Private Endpoint Connection returned successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/privateLinkResources": { + "get": { + "tags": [ + "Namespaces PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_Get", + "x-ms-examples": { + "NameSpacePrivateLinkResourcesGet": { + "$ref": "./examples/NameSpaces/PrivateLinkResourcesGet.json" + } + }, + "description": "Gets lists of resources that supports Privatelinks.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Private Link resource List", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ResourceNamespacePatch": { + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "The Resource definition." + }, + "SBNamespaceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBNamespace" + }, + "description": "Result of the List Namespace operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Namespaces." + } + }, + "description": "The response of the List Namespace operation." + }, + "SBNamespace": { + "properties": { + "sku": { + "$ref": "#/definitions/SBSku", + "description": "Properties of SKU" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBNamespaceProperties", + "description": "Properties of the namespace." + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "description": "Description of a namespace resource." + }, + "SBNamespaceUpdateParameters": { + "properties": { + "sku": { + "$ref": "#/definitions/SBSku", + "description": "Properties of SKU" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBNamespaceProperties", + "description": "Properties of the namespace." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Properties of BYOK Identity description" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceNamespacePatch" + } + ], + "description": "Description of a namespace resource." + }, + "SBNamespaceProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the namespace." + }, + "createdAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the namespace was created" + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the namespace was updated." + }, + "serviceBusEndpoint": { + "readOnly": true, + "type": "string", + "description": "Endpoint you can use to perform Service Bus operations." + }, + "metricId": { + "readOnly": true, + "type": "string", + "description": "Identifier for Azure Insights metrics" + }, + "zoneRedundant": { + "type": "boolean", + "description": "Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Properties of BYOK Encryption description" + } + }, + "description": "Properties of the namespace." + }, + "SBSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of this SKU.", + "enum": [ + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": false + } + }, + "tier": { + "type": "string", + "description": "The billing tier of this particular SKU.", + "enum": [ + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": false + } + }, + "capacity": { + "format": "int32", + "type": "integer", + "description": "The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4." + } + }, + "required": [ + "name" + ], + "description": "SKU of the namespace." + }, + "Identity": { + "x-ms-client-flatten": true, + "properties": { + "principalId": { + "type": "string", + "description": "ObjectId from the KeyVault" + }, + "tenantId": { + "type": "string", + "description": "TenantId from the KeyVault" + }, + "type": { + "type": "string", + "description": "Enumerates the possible value Identity type, which currently supports only 'SystemAssigned'", + "default": "SystemAssigned", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": false + } + } + }, + "description": "Properties to configure Identity for Bring your Own Keys" + }, + "Encryption": { + "x-ms-client-flatten": true, + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Properties of KeyVault" + }, + "keySource": { + "type": "string", + "description": "Enumerates the possible value of keySource for Encryption", + "default": "Microsoft.KeyVault", + "enum": [ + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "keySource", + "modelAsString": false + } + } + }, + "description": "Properties to configure Encryption" + }, + "KeyVaultProperties": { + "properties": { + "keyName": { + "type": "string", + "description": "Name of the Key from KeyVault" + }, + "keyVaultUri": { + "type": "string", + "description": "Uri of KeyVault" + } + }, + "description": "Properties to configure keyVault Properties" + }, + "PrivateEndpointConnection": { + "description": "Properties of the PrivateEndpointConnection.", + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Properties of the PrivateEndpointConnection.", + "x-ms-client-flatten": true + } + } + }, + "PrivateEndpointConnectionProperties": { + "description": "Properties of the private endpoint connection resource.", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The Private Endpoint resource for this Connection." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/ConnectionState", + "description": "Details about the state of the connection." + }, + "provisioningState": { + "description": "Provisioning state of the Private Endpoint Connection.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "EndPointProvisioningState", + "modelAsString": true + } + } + } + }, + "PrivateEndpoint": { + "description": "PrivateEndpoint information.", + "properties": { + "id": { + "description": "The ARM identifier for Private Endpoint.", + "type": "string" + } + } + }, + "ConnectionState": { + "description": "ConnectionState information.", + "properties": { + "status": { + "description": "Status of the connection.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkConnectionStatus", + "modelAsString": true + } + }, + "description": { + "description": "Description of the connection state.", + "type": "string" + } + } + }, + "PrivateEndpointConnectionListResult": { + "description": "Result of the list of all private endpoint connections operation.", + "properties": { + "value": { + "description": "A collection of private endpoint connection resources.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "description": "A link for the next page of private endpoint connection resources.", + "type": "string" + } + } + }, + "PrivateLinkResource": { + "description": "Information of the private link resource.", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Properties of the private link resource.", + "x-ms-client-flatten": true + }, + "id": { + "description": "Fully qualified identifier of the resource.", + "type": "string" + }, + "name": { + "description": "Name of the resource", + "type": "string" + }, + "type": { + "description": "Type of the resource", + "type": "string" + } + } + }, + "PrivateLinkResourceProperties": { + "description": "Properties of PrivateLinkResource", + "properties": { + "groupId": { + "type": "string" + }, + "requiredMembers": { + "type": "array", + "description": "Required Members", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "type": "array", + "description": "Required Zone Names", + "items": { + "type": "string" + } + } + } + }, + "PrivateLinkResourcesListResult": { + "description": "Result of the List private link resources operation.", + "properties": { + "value": { + "description": "A collection of private link resources", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "description": "A link for the next page of private link resources.", + "type": "string" + } + } + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/operationlist-preview.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/operationlist-preview.json new file mode 100644 index 000000000000..e5342767dd0b --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/operationlist-preview.json @@ -0,0 +1,126 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client for managing Namespace, IPFilter Rules, VirtualNetworkRules and Zone Redundant", + "version": "2018-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ServiceBus/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/SBOperations_List.json" + } + }, + "description": "Lists all of the available ServiceBus REST API operations.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list ServiceBus operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "description": "List of ServiceBus operations supported by the Microsoft.ServiceBus resource provider.", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "A ServiceBus REST API operation", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{operation}" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft.ServiceBus" + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource on which the operation is performed: Invoice, etc." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Operation type: Read, write, delete, etc." + } + } + } + } + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/servicebus-preview.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/servicebus-preview.json deleted file mode 100644 index c089a7efe2e0..000000000000 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/servicebus-preview.json +++ /dev/null @@ -1,1437 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ServiceBusManagementClient", - "description": "Azure Service Bus client for managing Namespace, IPFilter Rules, VirtualNetworkRules and Zone Redundant", - "version": "2018-01-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.ServiceBus/operations": { - "get": { - "tags": [ - "Operations" - ], - "operationId": "Operations_List", - "x-ms-examples": { - "OperationsList": { - "$ref": "./examples/SBOperations_List.json" - } - }, - "description": "Lists all of the available ServiceBus REST API operations.", - "parameters": [ - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/namespaces": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_List", - "x-ms-examples": { - "NameSpaceList": { - "$ref": "./examples/NameSpaces/SBNameSpaceList.json" - } - }, - "description": "Gets all the available namespaces within the subscription, irrespective of the resource groups.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespaces successfully returned.", - "schema": { - "$ref": "#/definitions/SBNamespaceListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListByResourceGroup", - "x-ms-examples": { - "NameSpaceListByResourceGroup": { - "$ref": "./examples/NameSpaces/SBNameSpaceListByResourceGroup.json" - } - }, - "description": "Gets the available namespaces within a resource group.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespaces successfully returned.", - "schema": { - "$ref": "#/definitions/SBNamespaceListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}": { - "put": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CreateOrUpdate", - "x-ms-examples": { - "NameSpaceCreate": { - "$ref": "./examples/NameSpaces/SBNameSpaceCreate.json" - } - }, - "description": "Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SBNamespace" - }, - "description": "Parameters supplied to create a namespace resource." - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Namespace create request accepted.", - "schema": { - "$ref": "#/definitions/SBNamespace" - } - }, - "200": { - "description": "Namespace created successfully.", - "schema": { - "$ref": "#/definitions/SBNamespace" - } - }, - "202": { - "description": "Namespace create or update request accepted." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Delete", - "x-ms-examples": { - "NameSpaceDelete": { - "$ref": "./examples/NameSpaces/SBNameSpaceDelete.json" - } - }, - "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "200": { - "description": "Namespace successfully deleted." - }, - "202": { - "description": "Namespace delete request accepted." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Get", - "x-ms-examples": { - "NameSpaceGet": { - "$ref": "./examples/NameSpaces/SBNameSpaceGet.json" - } - }, - "description": "Gets a description for the specified namespace.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace successfully returned.", - "schema": { - "$ref": "#/definitions/SBNamespace" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Update", - "x-ms-examples": { - "NameSpaceUpdate": { - "$ref": "./examples/NameSpaces/SBNameSpaceUpdate.json" - } - }, - "description": "Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SBNamespaceUpdateParameters" - }, - "description": "Parameters supplied to update a namespace resource." - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Namespace update request accepted.", - "schema": { - "$ref": "#/definitions/SBNamespace" - } - }, - "200": { - "description": "Namespace updated successfully.", - "schema": { - "$ref": "#/definitions/SBNamespace" - } - }, - "202": { - "description": "Namespace update request accepted." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/ipfilterrules": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListIpFilterRules", - "x-ms-examples": { - "ListIpFilterRules": { - "$ref": "./examples/NameSpaces/IPFilterRule/SBNameSpaceIPFilterRuleListAll.json" - } - }, - "description": "Gets a list of IP Filter rules for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace IpFilterRule successfully returned.", - "schema": { - "$ref": "#/definitions/IpFilterRuleListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/ipfilterrules/{ipFilterRuleName}": { - "put": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CreateOrUpdateIpFilterRule", - "x-ms-examples": { - "NameSpaceIpFilterRuleCreate": { - "$ref": "./examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleCreateorUpdate.json" - } - }, - "description": "Creates or updates an IpFilterRule for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/ipFilterRuleNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/IpFilterRule" - }, - "description": "The Namespace IpFilterRule." - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace IpFilterRule created", - "schema": { - "$ref": "#/definitions/IpFilterRule" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_DeleteIpFilterRule", - "x-ms-examples": { - "NameSpaceIpFilterRuleDelete": { - "$ref": "./examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleDelete.json" - } - }, - "description": "Deletes an IpFilterRule for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/ipFilterRuleNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "200": { - "description": "Namespace IpFilterRule successfully deleted." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_GetIpFilterRule", - "x-ms-examples": { - "NameSpaceIpFilterRuleGet": { - "$ref": "./examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleGet.json" - } - }, - "description": "Gets an IpFilterRule for a Namespace by rule name.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/ipFilterRuleNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace IpFilterRule returned successfully.", - "schema": { - "$ref": "#/definitions/IpFilterRule" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/virtualnetworkrules": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListVirtualNetworkRules", - "x-ms-examples": { - "ListIpFilterRules": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleListAll.json" - } - }, - "description": "Gets a list of VirtualNetwork rules for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace VirtualNetworkRule successfully returned.", - "schema": { - "$ref": "#/definitions/VirtualNetworkRuleListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/virtualnetworkrules/{virtualNetworkRuleName}": { - "put": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CreateOrUpdateVirtualNetworkRule", - "x-ms-examples": { - "NameSpaceVirtualNetworkRuleCreate": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleCreateorUpdate.json" - } - }, - "description": "Creates or updates an VirtualNetworkRule for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/virtualNetworkRuleNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualNetworkRule" - }, - "description": "The Namespace VirtualNetworkRule." - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace VirtualNetworkRule created", - "schema": { - "$ref": "#/definitions/VirtualNetworkRule" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_DeleteVirtualNetworkRule", - "x-ms-examples": { - "NameSpaceVirtualNetworkRuleDelete": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleDelete.json" - } - }, - "description": "Deletes an VirtualNetworkRule for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/virtualNetworkRuleNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "200": { - "description": "Namespace VirtualNetworkRule successfully deleted." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_GetVirtualNetworkRule", - "x-ms-examples": { - "NameSpaceVirtualNetworkRuleGet": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleGet.json" - } - }, - "description": "Gets an VirtualNetworkRule for a Namespace by rule name.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/virtualNetworkRuleNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace VirtualNetworkRule returned successfully.", - "schema": { - "$ref": "#/definitions/VirtualNetworkRule" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkrulesets/default": { - "put": { - "tags": [ - "Namespaces" - ], - "x-ms-examples": { - "NameSpaceVirtualNetworkRuleSetCreate": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json" - } - }, - "operationId": "Namespaces_CreateOrUpdateNetworkRuleSet", - "description": "Gets NetworkRuleSet for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/NetworkRuleSet" - }, - "description": "The Namespace IpFilterRule." - } - ], - "responses": { - "200": { - "description": "Namespace NetworkRuleSet successfully returned.", - "schema": { - "$ref": "#/definitions/NetworkRuleSet" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Namespaces" - ], - "x-ms-examples": { - "NameSpaceVirtualNetworkRuleSetget": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json" - } - }, - "operationId": "Namespaces_GetNetworkRuleSet", - "description": "Gets NetworkRuleSet for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/namespaceNameParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace NetworkRuleSet successfully returned.", - "schema": { - "$ref": "#/definitions/NetworkRuleSet" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "TrackedResource": { - "properties": { - "location": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "The Geo-location where the resource lives" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "required": [ - "location" - ], - "description": "The Resource definition." - }, - "Resource": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Resource type" - } - }, - "x-ms-azure-resource": true, - "description": "The Resource definition for other than namespace." - }, - "ResourceNamespacePatch": { - "properties": { - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "The Resource definition." - }, - "SBNamespaceListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SBNamespace" - }, - "description": "Result of the List Namespace operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of Namespaces." - } - }, - "description": "The response of the List Namespace operation." - }, - "SBNamespace": { - "properties": { - "sku": { - "$ref": "#/definitions/SBSku", - "description": "Properties of SKU" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SBNamespaceProperties", - "description": "Properties of the namespace." - } - }, - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "description": "Description of a namespace resource." - }, - "SBNamespaceUpdateParameters": { - "properties": { - "sku": { - "$ref": "#/definitions/SBSku", - "description": "Properties of SKU" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SBNamespaceProperties", - "description": "Properties of the namespace." - }, - "identity": { - "$ref": "#/definitions/Identity", - "description": "Properties of BYOK Identity description" - } - }, - "allOf": [ - { - "$ref": "#/definitions/ResourceNamespacePatch" - } - ], - "description": "Description of a namespace resource." - }, - "SBNamespaceProperties": { - "properties": { - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "Provisioning state of the namespace." - }, - "createdAt": { - "readOnly": true, - "format": "date-time", - "type": "string", - "description": "The time the namespace was created." - }, - "updatedAt": { - "readOnly": true, - "format": "date-time", - "type": "string", - "description": "The time the namespace was updated." - }, - "serviceBusEndpoint": { - "readOnly": true, - "type": "string", - "description": "Endpoint you can use to perform Service Bus operations." - }, - "metricId": { - "readOnly": true, - "type": "string", - "description": "Identifier for Azure Insights metrics" - }, - "zoneRedundant": { - "type": "boolean", - "description": "Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones." - }, - "encryption": { - "$ref": "#/definitions/Encryption", - "description": "Properties of BYOK Encryption description" - } - }, - "description": "Properties of the namespace." - }, - "SBSku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of this SKU.", - "enum": [ - "Basic", - "Standard", - "Premium" - ], - "x-ms-enum": { - "name": "SkuName", - "modelAsString": false - } - }, - "tier": { - "type": "string", - "description": "The billing tier of this particular SKU.", - "enum": [ - "Basic", - "Standard", - "Premium" - ], - "x-ms-enum": { - "name": "SkuTier", - "modelAsString": false - } - }, - "capacity": { - "format": "int32", - "type": "integer", - "description": "The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4." - } - }, - "required": [ - "name" - ], - "description": "SKU of the namespace." - }, - "OperationListResult": { - "description": "Result of the request to list ServiceBus operations. It contains a list of operations and a URL link to get the next set of results.", - "properties": { - "value": { - "readOnly": true, - "type": "array", - "description": "List of ServiceBus operations supported by the Microsoft.ServiceBus resource provider.", - "items": { - "$ref": "#/definitions/Operation" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "URL to get the next set of operation list results if there are any." - } - } - }, - "Operation": { - "description": "A ServiceBus REST API operation", - "type": "object", - "properties": { - "name": { - "readOnly": true, - "type": "string", - "description": "Operation name: {provider}/{resource}/{operation}" - }, - "display": { - "description": "The object that represents the operation.", - "properties": { - "provider": { - "readOnly": true, - "type": "string", - "description": "Service provider: Microsoft.ServiceBus" - }, - "resource": { - "readOnly": true, - "type": "string", - "description": "Resource on which the operation is performed: Invoice, etc." - }, - "operation": { - "readOnly": true, - "type": "string", - "description": "Operation type: Read, write, delete, etc." - } - } - } - } - }, - "ErrorResponse": { - "description": "Error response indicates ServiceBus service is not able to process the incoming request. The reason is provided in the error message.", - "type": "object", - "properties": { - "code": { - "description": "Error code.", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - }, - "IpFilterRule": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "properties": { - "ipMask": { - "type": "string", - "description": "IP Mask" - }, - "action": { - "type": "string", - "description": "The IP Filter Action", - "enum": [ - "Accept", - "Reject" - ], - "x-ms-enum": { - "name": "IPAction", - "modelAsString": true - } - }, - "filterName": { - "type": "string", - "description": "IP Filter name" - } - }, - "description": "Properties supplied to create or update IpFilterRules" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Single item in a List or Get IpFilterRules operation" - }, - "IpFilterRuleListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/IpFilterRule" - }, - "description": "Result of the List IpFilter Rules operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains an incomplete list of IpFilter Rules" - } - }, - "description": "The response from the List namespace operation." - }, - "VirtualNetworkRule": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "properties": { - "virtualNetworkSubnetId": { - "type": "string", - "description": "Resource ID of Virtual Network Subnet" - } - }, - "description": "Properties supplied to create or update VirtualNetworkRules" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Single item in a List or Get VirtualNetworkRules operation" - }, - "VirtualNetworkRuleListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkRule" - }, - "description": "Result of the List VirtualNetwork Rules operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains an incomplete list of VirtualNetwork Rules" - } - }, - "description": "The response from the List namespace operation." - }, - "Subnet": { - "properties": { - "id": { - "type": "string", - "description": "Resource ID of Virtual Network Subnet" - } - }, - "description": "Properties supplied for Subnet" - }, - "NWRuleSetIpRules": { - "x-ms-client-flatten": true, - "properties": { - "ipMask": { - "type": "string", - "description": "IP Mask" - }, - "action": { - "type": "string", - "description": "The IP Filter Action", - "enum": [ - "Allow" - ], - "x-ms-enum": { - "name": "NetworkRuleIPAction", - "modelAsString": true - } - } - }, - "description": "The response from the List namespace operation." - }, - "NWRuleSetVirtualNetworkRules": { - "x-ms-client-flatten": true, - "properties": { - "subnet": { - "$ref": "#/definitions/Subnet", - "description": "Subnet properties" - }, - "ignoreMissingVnetServiceEndpoint": { - "type": "boolean", - "description": "Value that indicates whether to ignore missing Vnet Service Endpoint" - } - }, - "description": "The response from the List namespace operation." - }, - "NetworkRuleSet": { - "properties": { - "properties": { - "description": "NetworkRuleSet properties", - "x-ms-client-flatten": true, - "properties": { - "defaultAction": { - "type": "string", - "description": "Default Action for Network Rule Set", - "enum": [ - "Allow", - "Deny" - ], - "x-ms-enum": { - "name": "DefaultAction", - "modelAsString": true - } - }, - "virtualNetworkRules": { - "type": "array", - "items": { - "$ref": "#/definitions/NWRuleSetVirtualNetworkRules" - }, - "description": "List VirtualNetwork Rules" - }, - "ipRules": { - "type": "array", - "items": { - "$ref": "#/definitions/NWRuleSetIpRules" - }, - "description": "List of IpRules" - } - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Description of topic resource." - }, - "Identity": { - "x-ms-client-flatten": true, - "properties": { - "principalId": { - "type": "string", - "readOnly": true, - "description": "ObjectId from the KeyVault" - }, - "tenantId": { - "type": "string", - "readOnly": true, - "description": "TenantId from the KeyVault" - }, - "type": { - "type": "string", - "description": "Enumerates the possible value Identity type, which currently supports only 'SystemAssigned'", - "default": "SystemAssigned", - "enum": [ - "SystemAssigned" - ], - "x-ms-enum": { - "name": "IdentityType", - "modelAsString": false - } - } - }, - "description": "Properties to configure Identity for Bring your Own Keys" - }, - "Encryption": { - "x-ms-client-flatten": true, - "properties": { - "keyVaultProperties": { - "$ref": "#/definitions/KeyVaultProperties", - "description": "Properties of KeyVault" - }, - "keySource": { - "type": "string", - "description": "Enumerates the possible value of keySource for Encryption", - "default": "Microsoft.KeyVault", - "enum": [ - "Microsoft.KeyVault" - ], - "x-ms-enum": { - "name": "keySource", - "modelAsString": false - } - } - }, - "description": "Properties to configure Encryption" - }, - "KeyVaultProperties": { - "properties": { - "keyName": { - "type": "string", - "description": "Name of the Key from KeyVault" - }, - "keyVaultUri": { - "type": "string", - "description": "Uri of KeyVault" - } - }, - "description": "Properties to configure keyVault Properties" - } - }, - "parameters": { - "subscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "apiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API version." - }, - "resourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method", - "description": "Name of the Resource group within the Azure subscription." - }, - "namespaceNameParameter": { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "minLength": 6, - "maxLength": 50, - "x-ms-parameter-location": "method", - "description": "The namespace name" - }, - "skuNameParameter": { - "name": "sku", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 50, - "x-ms-parameter-location": "method", - "description": "The sku type." - }, - "skipParameter": { - "name": "$skip", - "description": "Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.", - "in": "query", - "required": false, - "type": "integer", - "minimum": 0, - "maximum": 1000, - "x-ms-parameter-location": "method" - }, - "topParameter": { - "name": "$top", - "description": "May be used to limit the number of results to the most recent N usageDetails.", - "in": "query", - "required": false, - "type": "integer", - "minimum": 1, - "maximum": 1000, - "x-ms-parameter-location": "method" - }, - "ipFilterRuleNameParameter": { - "name": "ipFilterRuleName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "description": "The IP Filter Rule name." - }, - "virtualNetworkRuleNameParameter": { - "name": "virtualNetworkRuleName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "description": "The Virtual Network Rule name." - } - } -} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/AuthorizationRules.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/AuthorizationRules.json new file mode 100644 index 000000000000..c5af8932ebb9 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/AuthorizationRules.json @@ -0,0 +1,1095 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2017-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules": { + "get": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_ListAuthorizationRules", + "x-ms-examples": { + "NameSpaceAuthorizationRuleListAll": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleListAll.json" + } + }, + "description": "Gets the authorization rules for a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639376.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace authorization rules returned successfully.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}": { + "put": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_CreateOrUpdateAuthorizationRule", + "x-ms-examples": { + "NameSpaceAuthorizationRuleCreate": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleCreate.json" + } + }, + "description": "Creates or updates an authorization rule for a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639410.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + }, + "description": "The shared access authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace authorization rule created.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_DeleteAuthorizationRule", + "x-ms-examples": { + "NameSpaceAuthorizationRuleDelete": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleDelete.json" + } + }, + "description": "Deletes a namespace authorization rule.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639417.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace authorization rule successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_GetAuthorizationRule", + "x-ms-examples": { + "NameSpaceAuthorizationRuleGet": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleGet.json" + } + }, + "description": "Gets an authorization rule for a namespace by rule name.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639392.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace authorization rule returned successfully.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/listKeys": { + "post": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_ListKeys", + "x-ms-examples": { + "NameSpaceAuthorizationRuleListKey": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleListKey.json" + } + }, + "description": "Gets the primary and secondary connection strings for the namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639398.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully returned.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys": { + "post": { + "tags": [ + "Namespaces AuthorizationRule" + ], + "operationId": "Namespaces_RegenerateKeys", + "x-ms-examples": { + "NameSpaceAuthorizationRuleRegenerateKey": { + "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenerateKey.json" + } + }, + "description": "Regenerates the primary or secondary connection strings for the namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt718977.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateAccessKeyParameters" + }, + "description": "Parameters supplied to regenerate the authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rule successfully regenerated.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules": { + "get": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_ListAuthorizationRules", + "x-ms-examples": { + "QueueAuthorizationRuleListAll": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleListAll.json" + } + }, + "description": "Gets all authorization rules for a queue.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt705607.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rules successfully returned.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}": { + "put": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_CreateOrUpdateAuthorizationRule", + "x-ms-examples": { + "QueueAuthorizationRuleCreate": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleCreate.json" + } + }, + "description": "Creates an authorization rule for a queue.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + }, + "description": "The shared access authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rule successfully created.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_DeleteAuthorizationRule", + "x-ms-examples": { + "QueueAuthorizationRuleDelete": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleDelete.json" + } + }, + "description": "Deletes a queue authorization rule.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt705609.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rule successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_GetAuthorizationRule", + "x-ms-examples": { + "QueueAuthorizationRuleGet": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleGet.json" + } + }, + "description": "Gets an authorization rule for a queue by rule name.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt705611.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rule successfully returned.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}/ListKeys": { + "post": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_ListKeys", + "x-ms-examples": { + "QueueAuthorizationRuleListKey": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleListKey.json" + } + }, + "description": "Primary and secondary connection strings to the queue.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt705608.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully returned.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { + "post": { + "tags": [ + "Queues AuthorizationRule" + ], + "operationId": "Queues_RegenerateKeys", + "x-ms-examples": { + "QueueAuthorizationRuleRegenerateKey": { + "$ref": "./examples/Queues/SBQueueAuthorizationRuleRegenerateKey.json" + } + }, + "description": "Regenerates the primary or secondary connection strings to the queue.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt705606.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateAccessKeyParameters" + }, + "description": "Parameters supplied to regenerate the authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully regenerated.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules": { + "get": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_ListAuthorizationRules", + "x-ms-examples": { + "TopicAuthorizationRuleListAll": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleListAll.json" + } + }, + "description": "Gets authorization rules for a topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720681.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Authorization rules successfully returned.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}": { + "put": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_CreateOrUpdateAuthorizationRule", + "x-ms-examples": { + "TopicAuthorizationRuleCreate": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleCreate.json" + } + }, + "description": "Creates an authorization rule for the specified topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720678.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + }, + "description": "The shared access authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic authorization rule successfully created.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_GetAuthorizationRule", + "x-ms-examples": { + "TopicAuthorizationRuleGet": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleGet.json" + } + }, + "description": "Returns the specified authorization rule.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720676.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic authorization rule returned successfully.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_DeleteAuthorizationRule", + "x-ms-examples": { + "TopicAuthorizationRuleDelete": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleDelete.json" + } + }, + "description": "Deletes a topic authorization rule.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720681.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic authorization rule successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/ListKeys": { + "post": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_ListKeys", + "x-ms-examples": { + "TopicAuthorizationRuleListKey": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleListKey.json" + } + }, + "description": "Gets the primary and secondary connection strings for the topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720677.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully retrieved.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { + "post": { + "tags": [ + "Topics AuthorizationRule" + ], + "operationId": "Topics_RegenerateKeys", + "x-ms-examples": { + "TopicAuthorizationRuleRegenerateKey": { + "$ref": "./examples/Topics/SBTopicAuthorizationRuleRegenerateKey.json" + } + }, + "description": "Regenerates primary or secondary connection strings for the topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt720679.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateAccessKeyParameters" + }, + "description": "Parameters supplied to regenerate the authorization rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully regenerated.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SBAuthorizationRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBAuthorizationRule" + }, + "description": "Result of the List Authorization Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Authorization Rules." + } + }, + "description": "The response to the List Namespace operation." + }, + "SBAuthorizationRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "rights": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Manage", + "Send", + "Listen" + ], + "x-ms-enum": { + "name": "AccessRights", + "modelAsString": false + } + }, + "description": "The rights associated with the rule." + } + }, + "required": [ + "rights" + ], + "description": "AuthorizationRule properties." + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Description of a namespace authorization rule." + }, + "AccessKeys": { + "properties": { + "primaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Primary connection string of the created namespace authorization rule." + }, + "secondaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Secondary connection string of the created namespace authorization rule." + }, + "aliasPrimaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Primary connection string of the alias if GEO DR is enabled" + }, + "aliasSecondaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Secondary connection string of the alias if GEO DR is enabled" + }, + "primaryKey": { + "readOnly": true, + "type": "string", + "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." + }, + "secondaryKey": { + "readOnly": true, + "type": "string", + "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." + }, + "keyName": { + "readOnly": true, + "type": "string", + "description": "A string that describes the authorization rule." + } + }, + "description": "Namespace/ServiceBus Connection String" + }, + "RegenerateAccessKeyParameters": { + "properties": { + "keyType": { + "type": "string", + "description": "The access key to regenerate.", + "enum": [ + "PrimaryKey", + "SecondaryKey" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": false + } + }, + "key": { + "type": "string", + "description": "Optional, if the key value provided, is reset for KeyType value or autogenerate Key value set for keyType" + } + }, + "required": [ + "keyType" + ], + "description": "Parameters supplied to the Regenerate Authorization Rule operation, specifies which key needs to be reset." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/CheckNameAvailability.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/CheckNameAvailability.json new file mode 100644 index 000000000000..3d47a43a7882 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/CheckNameAvailability.json @@ -0,0 +1,132 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2017-04-01" + }, + "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}/providers/Microsoft.ServiceBus/CheckNameAvailability": { + "post": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CheckNameAvailability", + "x-ms-examples": { + "NameSpaceCheckNameAvailability": { + "$ref": "./examples/NameSpaces/SBNameSpaceCheckNameAvailability.json" + } + }, + "description": "Check the give namespace name availability.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailability" + }, + "description": "Parameters to check availability of the given namespace name" + } + ], + "responses": { + "200": { + "description": "check availability returned successfully.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "CheckNameAvailability": { + "properties": { + "name": { + "type": "string", + "description": "The Name to check the namespace name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number." + } + }, + "required": [ + "name" + ], + "description": "Description of a Check Name availability request properties." + }, + "CheckNameAvailabilityResult": { + "properties": { + "message": { + "readOnly": true, + "type": "string", + "description": "The detailed info regarding the reason associated with the namespace." + }, + "nameAvailable": { + "type": "boolean", + "description": "Value indicating namespace is availability, true if the namespace is available; otherwise, false." + }, + "reason": { + "$ref": "#/definitions/UnavailableReason", + "description": "The reason for unavailability of a namespace." + } + }, + "description": "Description of a Check Name availability request properties." + }, + "UnavailableReason": { + "type": "string", + "enum": [ + "None", + "InvalidName", + "SubscriptionIsDisabled", + "NameInUse", + "NameInLockdown", + "TooManyNamespaceInCurrentSubscription" + ], + "x-ms-enum": { + "name": "UnavailableReason", + "modelAsString": false + }, + "description": "Specifies the reason for the unavailability of the service." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/DisasterRecoveryConfig.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/DisasterRecoveryConfig.json new file mode 100644 index 000000000000..963984f6b5d3 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/DisasterRecoveryConfig.json @@ -0,0 +1,750 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2017-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/CheckNameAvailability": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_CheckNameAvailability", + "x-ms-examples": { + "AliasNameAvailability": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasCheckNameAvailability.json" + } + }, + "description": "Check the give namespace name availability.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailability" + }, + "description": "Parameters to check availability of the given namespace name" + } + ], + "responses": { + "200": { + "description": "check availability returned successfully.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs": { + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_List", + "x-ms-examples": { + "SBAliasList": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasList.json" + } + }, + "description": "Gets all Alias(Disaster Recovery configurations)", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of Alias(Disaster Recovery configurations) for servicebus namespace", + "schema": { + "$ref": "#/definitions/ArmDisasterRecoveryListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}": { + "put": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_CreateOrUpdate", + "x-ms-examples": { + "SBAliasCreate": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasCreate.json" + } + }, + "description": "Creates or updates a new Alias(Disaster Recovery configuration)", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArmDisasterRecovery" + }, + "description": "Parameters required to create an Alias(Disaster Recovery configuration)" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Alias(Disaster Recovery configuration) successfully created", + "schema": { + "$ref": "#/definitions/ArmDisasterRecovery" + } + }, + "201": { + "description": "Alias(Disaster Recovery configuration) creation request received" + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_Delete", + "x-ms-examples": { + "SBAliasDelete": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasDelete.json" + } + }, + "description": "Deletes an Alias(Disaster Recovery configuration)", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete Alias(Disaster Recovery configuration) request accepted" + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_Get", + "x-ms-examples": { + "SBAliasGet": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasGet.json" + } + }, + "description": "Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the Alias(Disaster Recovery configurations)", + "schema": { + "$ref": "#/definitions/ArmDisasterRecovery" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/breakPairing": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_BreakPairing", + "x-ms-examples": { + "SBEHAliasBreakPairing": { + "$ref": "./examples/disasterRecoveryConfigs/SBEHAliasBreakPairing.json" + } + }, + "description": "This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Break-Pairing operation is successful." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/failover": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_FailOver", + "x-ms-examples": { + "SBAliasFailOver": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasFailOver.json" + } + }, + "description": "Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Failover operation is successful." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/AuthorizationRules": { + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_ListAuthorizationRules", + "x-ms-examples": { + "NameSpaceAuthorizationRuleListAll": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListAll.json" + } + }, + "description": "Gets the authorization rules for a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639376.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "DisasterRecoveryConfigs authorization rules returned successfully.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/AuthorizationRules/{authorizationRuleName}": { + "get": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_GetAuthorizationRule", + "x-ms-examples": { + "DisasterRecoveryConfigsAuthorizationRuleGet": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleGet.json" + } + }, + "description": "Gets an authorization rule for a namespace by rule name.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639392.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "DisasterRecoveryConfigs authorization rule returned successfully.", + "schema": { + "$ref": "#/definitions/SBAuthorizationRule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/AuthorizationRules/{authorizationRuleName}/listKeys": { + "post": { + "tags": [ + "DisasterRecoveryConfigs" + ], + "operationId": "DisasterRecoveryConfigs_ListKeys", + "x-ms-examples": { + "DisasterRecoveryConfigsAuthorizationRuleListKey": { + "$ref": "./examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListKey.json" + } + }, + "description": "Gets the primary and secondary connection strings for the namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639398.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AliasNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/AuthorizationRuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Connection strings successfully returned.", + "schema": { + "$ref": "#/definitions/AccessKeys" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SBAuthorizationRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBAuthorizationRule" + }, + "description": "Result of the List Authorization Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Authorization Rules." + } + }, + "description": "The response to the List Namespace operation." + }, + "SBAuthorizationRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "rights": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Manage", + "Send", + "Listen" + ], + "x-ms-enum": { + "name": "AccessRights", + "modelAsString": false + } + }, + "description": "The rights associated with the rule." + } + }, + "required": [ + "rights" + ], + "description": "AuthorizationRule properties." + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Description of a namespace authorization rule." + }, + "AccessKeys": { + "properties": { + "primaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Primary connection string of the created namespace authorization rule." + }, + "secondaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Secondary connection string of the created namespace authorization rule." + }, + "aliasPrimaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Primary connection string of the alias if GEO DR is enabled" + }, + "aliasSecondaryConnectionString": { + "readOnly": true, + "type": "string", + "description": "Secondary connection string of the alias if GEO DR is enabled" + }, + "primaryKey": { + "readOnly": true, + "type": "string", + "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." + }, + "secondaryKey": { + "readOnly": true, + "type": "string", + "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." + }, + "keyName": { + "readOnly": true, + "type": "string", + "description": "A string that describes the authorization rule." + } + }, + "description": "Namespace/ServiceBus Connection String" + }, + "RegenerateAccessKeyParameters": { + "properties": { + "keyType": { + "type": "string", + "description": "The access key to regenerate.", + "enum": [ + "PrimaryKey", + "SecondaryKey" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": false + } + }, + "key": { + "type": "string", + "description": "Optional, if the key value provided, is reset for KeyType value or autogenerate Key value set for keyType" + } + }, + "required": [ + "keyType" + ], + "description": "Parameters supplied to the Regenerate Authorization Rule operation, specifies which key needs to be reset." + }, + "UnavailableReason": { + "type": "string", + "enum": [ + "None", + "InvalidName", + "SubscriptionIsDisabled", + "NameInUse", + "NameInLockdown", + "TooManyNamespaceInCurrentSubscription" + ], + "x-ms-enum": { + "name": "UnavailableReason", + "modelAsString": false + }, + "description": "Specifies the reason for the unavailability of the service." + }, + "CheckNameAvailability": { + "properties": { + "name": { + "type": "string", + "description": "The Name to check the namespace name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number." + } + }, + "required": [ + "name" + ], + "description": "Description of a Check Name availability request properties." + }, + "CheckNameAvailabilityResult": { + "properties": { + "message": { + "readOnly": true, + "type": "string", + "description": "The detailed info regarding the reason associated with the namespace." + }, + "nameAvailable": { + "type": "boolean", + "description": "Value indicating namespace is availability, true if the namespace is available; otherwise, false." + }, + "reason": { + "$ref": "#/definitions/UnavailableReason", + "description": "The reason for unavailability of a namespace." + } + }, + "description": "Description of a Check Name availability request properties." + }, + "ArmDisasterRecovery": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'", + "enum": [ + "Accepted", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningStateDR", + "modelAsString": false + } + }, + "pendingReplicationOperationsCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of entities pending to be replicated." + }, + "partnerNamespace": { + "type": "string", + "description": "ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing" + }, + "alternateName": { + "type": "string", + "description": "Primary/Secondary eventhub namespace name, which is part of GEO DR pairing" + }, + "role": { + "readOnly": true, + "type": "string", + "description": "role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'", + "enum": [ + "Primary", + "PrimaryNotReplicating", + "Secondary" + ], + "x-ms-enum": { + "name": "RoleDisasterRecovery", + "modelAsString": false + } + } + }, + "description": "Properties required to the Create Or Update Alias(Disaster Recovery configurations)" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Single item in List or Get Alias(Disaster Recovery configuration) operation" + }, + "ArmDisasterRecoveryListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ArmDisasterRecovery" + }, + "description": "List of Alias(Disaster Recovery configurations)" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Alias(Disaster Recovery configuration)" + } + }, + "description": "The result of the List Alias(Disaster Recovery configuration) operation." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/PremiumMessagingRegions.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/PremiumMessagingRegions.json new file mode 100644 index 000000000000..165c2a2c8983 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/PremiumMessagingRegions.json @@ -0,0 +1,280 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2017-04-01" + }, + "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}/providers/Microsoft.ServiceBus/premiumMessagingRegions": { + "get": { + "tags": [ + "PremiumMessagingRegions" + ], + "operationId": "PremiumMessagingRegions_List", + "x-ms-examples": { + "PremiumMessagingRegionsList": { + "$ref": "./examples/SkuRegions/PremiumMessagingRegions.json" + } + }, + "description": "Gets the available premium messaging regions for servicebus ", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Premium messaging regions successfully returned.", + "schema": { + "$ref": "#/definitions/PremiumMessagingRegionsListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ResourceNamespacePatch": { + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "The Resource definition." + }, + "PremiumMessagingRegions": { + "properties": { + "properties": { + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "Region code" + }, + "fullName": { + "readOnly": true, + "type": "string", + "description": "Full name of the region" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceNamespacePatch" + } + ], + "description": "Premium Messaging Region" + }, + "PremiumMessagingRegionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PremiumMessagingRegions" + }, + "description": "Result of the List PremiumMessagingRegions type." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if Value contains incomplete list of PremiumMessagingRegions." + } + }, + "description": "The response of the List PremiumMessagingRegions operation." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of the Resource group within the Azure subscription." + }, + "NamespaceNameParameter": { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 6, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The namespace name" + }, + "AuthorizationRuleNameParameter": { + "name": "authorizationRuleName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The authorization rule name." + }, + "QueueNameParameter": { + "name": "queueName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "description": "The queue name." + }, + "TopicNameParameter": { + "name": "topicName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "description": "The topic name." + }, + "SubscriptionNameParameter": { + "name": "subscriptionName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The subscription name." + }, + "RuleNameParameter": { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The rule name." + }, + "SkuNameParameter": { + "name": "sku", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The sku type." + }, + "AliasNameParameter": { + "name": "alias", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The Disaster Recovery configuration name" + }, + "ConfigNameParameter": { + "name": "configName", + "in": "path", + "description": "The configuration name. Should always be \"$default\".", + "required": true, + "type": "string", + "enum": [ + "$default" + ], + "x-ms-enum": { + "name": "MigrationConfigurationName", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + }, + "SkipParameter": { + "name": "$skip", + "description": "Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 0, + "maximum": 1000, + "x-ms-parameter-location": "method" + }, + "TopParameter": { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/Queue.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/Queue.json new file mode 100644 index 000000000000..3507b2b3be4a --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/Queue.json @@ -0,0 +1,381 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2017-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues": { + "get": { + "tags": [ + "Queues" + ], + "operationId": "Queues_ListByNamespace", + "x-ms-examples": { + "QueueListByNameSpace": { + "$ref": "./examples/Queues/SBQueueListByNameSpace.json" + } + }, + "description": "Gets the queues within a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639415.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "Queues successfully returned.", + "schema": { + "$ref": "#/definitions/SBQueueListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}": { + "put": { + "tags": [ + "Queues" + ], + "operationId": "Queues_CreateOrUpdate", + "x-ms-examples": { + "QueueCreate": { + "$ref": "./examples/Queues/SBQueueCreate.json" + } + }, + "description": "Creates or updates a Service Bus queue. This operation is idempotent.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639395.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBQueue" + }, + "description": "Parameters supplied to create or update a queue resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Queue successfully created.", + "schema": { + "$ref": "#/definitions/SBQueue" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Queues" + ], + "operationId": "Queues_Delete", + "x-ms-examples": { + "QueueDelete": { + "$ref": "./examples/Queues/SBQueueDelete.json" + } + }, + "description": "Deletes a queue from the specified namespace in a resource group.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639411.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Queue successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Queues" + ], + "operationId": "Queues_Get", + "x-ms-examples": { + "QueueGet": { + "$ref": "./examples/Queues/SBQueueGet.json" + } + }, + "description": "Returns a description for the specified queue.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639380.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/QueueNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Queue description successfully returned.", + "schema": { + "$ref": "#/definitions/SBQueue" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SBQueueListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBQueue" + }, + "description": "Result of the List Queues operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of queues." + } + }, + "description": "The response to the List Queues operation." + }, + "SBQueue": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBQueueProperties", + "description": "Queue Properties" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Description of queue Resource." + }, + "SBQueueProperties": { + "properties": { + "countDetails": { + "readOnly": true, + "$ref": "../../../common/v1/definitions.json#/definitions/MessageCountDetails", + "description": "Message Count Details." + }, + "createdAt": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The exact time the message was created." + }, + "updatedAt": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The exact time the message was updated." + }, + "accessedAt": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Last time a message was sent, or the last time there was a receive request to this queue." + }, + "sizeInBytes": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "The size of the queue, in bytes." + }, + "messageCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "The number of messages in the queue." + }, + "lockDuration": { + "format": "duration", + "type": "string", + "description": "ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute." + }, + "maxSizeInMegabytes": { + "format": "int32", + "type": "integer", + "description": "The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024." + }, + "requiresDuplicateDetection": { + "type": "boolean", + "description": "A value indicating if this queue requires duplicate detection." + }, + "requiresSession": { + "type": "boolean", + "description": "A value that indicates whether the queue supports the concept of sessions." + }, + "defaultMessageTimeToLive": { + "format": "duration", + "type": "string", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." + }, + "deadLetteringOnMessageExpiration": { + "type": "boolean", + "description": "A value that indicates whether this queue has dead letter support when a message expires." + }, + "duplicateDetectionHistoryTimeWindow": { + "format": "duration", + "type": "string", + "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes." + }, + "maxDeliveryCount": { + "format": "int32", + "type": "integer", + "description": "The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10." + }, + "status": { + "$ref": "../../../common/v1/definitions.json#/definitions/EntityStatus", + "description": "Enumerates the possible values for the status of a messaging entity." + }, + "enableBatchedOperations": { + "type": "boolean", + "description": "Value that indicates whether server-side batched operations are enabled." + }, + "autoDeleteOnIdle": { + "format": "duration", + "type": "string", + "description": "ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes." + }, + "enablePartitioning": { + "type": "boolean", + "description": "A value that indicates whether the queue is to be partitioned across multiple message brokers." + }, + "enableExpress": { + "type": "boolean", + "description": "A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage." + }, + "forwardTo": { + "type": "string", + "description": "Queue/Topic name to forward the messages" + }, + "forwardDeadLetteredMessagesTo": { + "type": "string", + "description": "Queue/Topic name to forward the Dead Letter message" + } + }, + "description": "The Queue Properties definition." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/Rules.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/Rules.json new file mode 100644 index 000000000000..0a2be2c6dc3a --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/Rules.json @@ -0,0 +1,447 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2017-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules": { + "get": { + "tags": [ + "Rules" + ], + "operationId": "Rules_ListBySubscriptions", + "x-ms-examples": { + "RulesListBySubscriptions": { + "$ref": "./examples/Rules/RuleListBySubscription.json" + } + }, + "description": "List all the rules within given topic-subscription", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved list of Rules.", + "schema": { + "$ref": "#/definitions/RuleListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules/{ruleName}": { + "put": { + "tags": [ + "Rules" + ], + "operationId": "Rules_CreateOrUpdate", + "x-ms-examples": { + "RulesCreateOrUpdate": { + "$ref": "./examples/Rules/RuleCreate.json" + }, + "RulesCreateSqlFilter": { + "$ref": "./examples/Rules/RuleCreate_SqlFilter.json" + }, + "RulesCreateCorrelationFilter": { + "$ref": "./examples/Rules/RuleCreate_CorrelationFilter.json" + } + }, + "description": "Creates a new rule and updates an existing rule", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/RuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Rule" + }, + "description": "Parameters supplied to create a rule." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Rule created.", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Rules" + ], + "operationId": "Rules_Delete", + "x-ms-examples": { + "RulesDelete": { + "$ref": "./examples/Rules/RuleDelete.json" + } + }, + "description": "Deletes an existing rule.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/RuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Rule deleted." + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Rules_Get", + "x-ms-examples": { + "RulesGet": { + "$ref": "./examples/Rules/RuleGet.json" + } + }, + "description": "Retrieves the description for the specified rule.", + "externalDocs": { + "url": "" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/RuleNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved rule description.", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Rule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/Ruleproperties", + "description": "Properties of Rule resource" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Description of Rule Resource." + }, + "Ruleproperties": { + "properties": { + "action": { + "$ref": "#/definitions/Action", + "description": "Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression." + }, + "filterType": { + "$ref": "#/definitions/FilterType", + "description": "Filter type that is evaluated against a BrokeredMessage." + }, + "sqlFilter": { + "$ref": "#/definitions/SqlFilter", + "description": "Properties of sqlFilter" + }, + "correlationFilter": { + "$ref": "#/definitions/CorrelationFilter", + "description": "Properties of correlationFilter" + } + }, + "description": "Description of Rule Resource." + }, + "RuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Rule" + }, + "description": "Result of the List Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of rules" + } + }, + "description": "The response of the List rule operation." + }, + "FilterType": { + "type": "string", + "enum": [ + "SqlFilter", + "CorrelationFilter" + ], + "x-ms-enum": { + "name": "FilterType", + "modelAsString": false + }, + "description": "Rule filter types" + }, + "SqlFilter": { + "type": "object", + "properties": { + "sqlExpression": { + "type": "string", + "description": "The SQL expression. e.g. MyProperty='ABC'" + }, + "compatibilityLevel": { + "format": "int32", + "type": "integer", + "default": 20, + "minimum": 20, + "maximum": 20, + "description": "This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20." + }, + "requiresPreprocessing": { + "type": "boolean", + "default": true, + "description": "Value that indicates whether the rule action requires preprocessing." + } + }, + "description": "Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline." + }, + "CorrelationFilter": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "dictionary object for custom filters" + }, + "correlationId": { + "type": "string", + "description": "Identifier of the correlation." + }, + "messageId": { + "type": "string", + "description": "Identifier of the message." + }, + "to": { + "type": "string", + "description": "Address to send to." + }, + "replyTo": { + "type": "string", + "description": "Address of the queue to reply to." + }, + "label": { + "type": "string", + "description": "Application specific label." + }, + "sessionId": { + "type": "string", + "description": "Session identifier." + }, + "replyToSessionId": { + "type": "string", + "description": "Session identifier to reply to." + }, + "contentType": { + "type": "string", + "description": "Content type of the message." + }, + "requiresPreprocessing": { + "type": "boolean", + "default": true, + "description": "Value that indicates whether the rule action requires preprocessing." + } + }, + "description": "Represents the correlation filter expression." + }, + "Action": { + "type": "object", + "properties": { + "sqlExpression": { + "type": "string", + "description": "SQL expression. e.g. MyProperty='ABC'" + }, + "compatibilityLevel": { + "format": "int32", + "type": "integer", + "description": "This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20." + }, + "requiresPreprocessing": { + "type": "boolean", + "default": true, + "description": "Value that indicates whether the rule action requires preprocessing." + } + }, + "description": "Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression." + }, + "SqlRuleAction": { + "type": "object", + "properties": { + "sqlExpression": { + "type": "string", + "description": "SQL expression. e.g. MyProperty='ABC'" + }, + "compatibilityLevel": { + "format": "int32", + "type": "integer", + "description": "This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20." + }, + "requiresPreprocessing": { + "type": "boolean", + "default": true, + "description": "Value that indicates whether the rule action requires preprocessing." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Action" + } + ], + "description": "Represents set of actions written in SQL language-based syntax that is performed against a ServiceBus.Messaging.BrokeredMessage " + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/eventhubs.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/eventhubs.json new file mode 100644 index 000000000000..b276ca8f3ea3 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/eventhubs.json @@ -0,0 +1,227 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2017-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/eventhubs": { + "get": { + "tags": [ + "EventHubs" + ], + "operationId": "EventHubs_ListByNamespace", + "x-ms-examples": { + "RulesCreateOrUpdate": { + "$ref": "./examples/SkuRegions/EventHubs.json" + } + }, + "description": "Gets all the Event Hubs in a service bus Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of Event Hubs.", + "schema": { + "$ref": "#/definitions/EventHubListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Eventhub": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "partitionIds": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "Current number of shards on the Event Hub." + }, + "createdAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "Exact time the Event Hub was created." + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the message was updated." + }, + "messageRetentionInDays": { + "format": "int64", + "type": "integer", + "maximum": 7, + "minimum": 1, + "description": "Number of days to retain the events for this Event Hub, value should be 1 to 7 days" + }, + "partitionCount": { + "format": "int64", + "type": "integer", + "maximum": 32, + "minimum": 1, + "description": "Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions." + }, + "status": { + "$ref": "../../../common/v1/definitions.json#/definitions/EntityStatus", + "description": "Enumerates the possible values for the status of a Event Hub." + }, + "captureDescription": { + "$ref": "#/definitions/CaptureDescription", + "description": "Properties of capture description" + } + }, + "description": "Properties supplied to the Create Or Update Event Hub operation." + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Single item in List or Get Event Hub operation" + }, + "EventHubListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Eventhub" + }, + "description": "Result of the List EventHubs operation." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if Value contains incomplete list of EventHubs." + } + }, + "description": "The result of the List EventHubs operation." + }, + "CaptureDescription": { + "properties": { + "enabled": { + "type": "boolean", + "description": "A value that indicates whether capture description is enabled. " + }, + "encoding": { + "type": "string", + "description": "Enumerates the possible values for the encoding format of capture description.", + "enum": [ + "Avro", + "AvroDeflate" + ], + "x-ms-enum": { + "name": "EncodingCaptureDescription", + "modelAsString": false + } + }, + "intervalInSeconds": { + "format": "int32", + "type": "integer", + "maximum": 900, + "minimum": 60, + "description": "The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds" + }, + "sizeLimitInBytes": { + "format": "int32", + "type": "integer", + "maximum": 524288000, + "minimum": 10485760, + "description": "The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 and 524288000 bytes" + }, + "destination": { + "$ref": "#/definitions/Destination", + "description": "Properties of Destination where capture will be stored. (Storage Account, Blob Names)" + } + }, + "description": "Properties to configure capture description for eventhub" + }, + "Destination": { + "properties": { + "name": { + "type": "string", + "description": "Name for capture destination" + }, + "properties": { + "x-ms-client-flatten": true, + "properties": { + "storageAccountResourceId": { + "type": "string", + "description": "Resource id of the storage account to be used to create the blobs" + }, + "blobContainer": { + "type": "string", + "description": "Blob container Name" + }, + "archiveNameFormat": { + "type": "string", + "description": "Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order" + } + }, + "description": "Properties describing the storage account, blob container and archive name format for capture destination" + } + }, + "description": "Capture storage details for capture description" + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/migrate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/migrate.json new file mode 100644 index 000000000000..73bb7df40663 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/migrate.json @@ -0,0 +1,113 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2017-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrate": { + "post": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Migrate", + "x-ms-examples": { + "NameSpaceUpdate": { + "$ref": "./examples/NameSpaces/SBNamespaceMigrate.json" + } + }, + "description": "This operation Migrate the given namespace to provided name type", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBNamespaceMigrate" + }, + "description": "Parameters supplied to migrate namespace type." + } + ], + "responses": { + "200": { + "description": "Migrate Namespace type is successful." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SBNamespaceMigrate": { + "type": "object", + "properties": { + "targetNamespaceType": { + "type": "string", + "description": "Type of namespaces", + "enum": [ + "Messaging", + "NotificationHub", + "Mixed", + "EventHub", + "Relay" + ], + "x-ms-enum": { + "name": "NameSpaceType", + "modelAsString": false + } + } + }, + "required": [ + "targetNamespaceType" + ], + "description": "Namespace Migrate Object" + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/migrationconfigs.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/migrationconfigs.json new file mode 100644 index 000000000000..1fd6e21e8fc1 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/migrationconfigs.json @@ -0,0 +1,375 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2017-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations": { + "get": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_List", + "x-ms-examples": { + "MigrationConfigurationsList": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationList.json" + } + }, + "description": "Gets all migrationConfigurations", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of migrationConfigurations for servicebus namespace", + "schema": { + "$ref": "#/definitions/MigrationConfigListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}": { + "put": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_CreateAndStartMigration", + "x-ms-examples": { + "MigrationConfigurationsStartMigration": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationCreateAndStartMigration.json" + } + }, + "description": "Creates Migration configuration and starts migration of entities from Standard to Premium namespace", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConfigNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MigrationConfigProperties" + }, + "description": "Parameters required to create Migration Configuration" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Migration Config successfully created", + "schema": { + "$ref": "#/definitions/MigrationConfigProperties" + } + }, + "201": { + "description": "Migration Config creation request received" + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_Delete", + "x-ms-examples": { + "MigrationConfigurationsDelete": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationDelete.json" + } + }, + "description": "Deletes a MigrationConfiguration", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConfigNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete Migration Config request accepted" + }, + "204": { + "description": "Not Found" + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_Get", + "x-ms-examples": { + "MigrationConfigurationsGet": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationGet.json" + } + }, + "description": "Retrieves Migration Config", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConfigNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved Migration Config)", + "schema": { + "$ref": "#/definitions/MigrationConfigProperties" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}/upgrade": { + "post": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_CompleteMigration", + "x-ms-examples": { + "MigrationConfigurationsCompleteMigration": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationCompleteMigration.json" + } + }, + "description": "This operation Completes Migration of entities by pointing the connection strings to Premium namespace and any entities created after the operation will be under Premium Namespace. CompleteMigration operation will fail when entity migration is in-progress.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConfigNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "upgrade operation of Migration Config is successful." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}/revert": { + "post": { + "tags": [ + "MigrationConfigs" + ], + "operationId": "MigrationConfigs_Revert", + "x-ms-examples": { + "MigrationConfigurationsRevert": { + "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationRevert.json" + } + }, + "description": "This operation reverts Migration", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ConfigNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "MigrationConfig Revert operation is successful." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "MigrationConfigProperties": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of Migration Configuration " + }, + "pendingReplicationOperationsCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of entities pending to be replicated." + }, + "targetNamespace": { + "type": "string", + "description": "Existing premium Namespace ARM Id name which has no entities, will be used for migration" + }, + "postMigrationName": { + "type": "string", + "description": "Name to access Standard Namespace after migration" + }, + "migrationState": { + "readOnly": true, + "type": "string", + "description": "State in which Standard to Premium Migration is, possible values : Unknown, Reverting, Completing, Initiating, Syncing, Active" + } + }, + "required": [ + "targetNamespace", + "postMigrationName" + ], + "description": "Properties required to the Create Migration Configuration" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Single item in List or Get Migration Config operation" + }, + "MigrationConfigListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MigrationConfigProperties" + }, + "description": "List of Migration Configs" + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if Value contains incomplete list of migrationConfigurations" + } + }, + "description": "The result of the List migrationConfigurations operation." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/namespaces.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/namespaces.json new file mode 100644 index 000000000000..0a0a320f695c --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/namespaces.json @@ -0,0 +1,491 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2017-04-01" + }, + "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}/providers/Microsoft.ServiceBus/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_List", + "x-ms-examples": { + "NameSpaceList": { + "$ref": "./examples/NameSpaces/SBNameSpaceList.json" + } + }, + "description": "Gets all the available namespaces within the subscription, irrespective of the resource groups.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespaces successfully returned.", + "schema": { + "$ref": "#/definitions/SBNamespaceListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListByResourceGroup", + "x-ms-examples": { + "NameSpaceListByResourceGroup": { + "$ref": "./examples/NameSpaces/SBNameSpaceListByResourceGroup.json" + } + }, + "description": "Gets the available namespaces within a resource group.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespaces successfully returned.", + "schema": { + "$ref": "#/definitions/SBNamespaceListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdate", + "x-ms-examples": { + "NameSpaceCreate": { + "$ref": "./examples/NameSpaces/SBNameSpaceCreate.json" + } + }, + "description": "Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBNamespace" + }, + "description": "Parameters supplied to create a namespace resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace created successfully.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "201": { + "description": "Namespace create request accepted.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "202": { + "description": "Namespace create or update request accepted." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Delete", + "x-ms-examples": { + "NameSpaceDelete": { + "$ref": "./examples/NameSpaces/SBNameSpaceDelete.json" + } + }, + "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace successfully deleted." + }, + "202": { + "description": "Namespace delete request accepted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Get", + "x-ms-examples": { + "NameSpaceGet": { + "$ref": "./examples/NameSpaces/SBNameSpaceGet.json" + } + }, + "description": "Gets a description for the specified namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace successfully returned.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Update", + "x-ms-examples": { + "NameSpaceUpdate": { + "$ref": "./examples/NameSpaces/SBNameSpaceUpdate.json" + } + }, + "description": "Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBNamespaceUpdateParameters" + }, + "description": "Parameters supplied to update a namespace resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace updated successfully.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "201": { + "description": "Namespace update request accepted.", + "schema": { + "$ref": "#/definitions/SBNamespace" + } + }, + "202": { + "description": "Namespace update request accepted." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ResourceNamespacePatch": { + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "The Resource definition." + }, + "SBNamespaceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBNamespace" + }, + "description": "Result of the List Namespace operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of Namespaces." + } + }, + "description": "The response of the List Namespace operation." + }, + "SBNamespace": { + "properties": { + "sku": { + "$ref": "#/definitions/SBSku", + "description": "Properties of Sku" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBNamespaceProperties", + "description": "Properties of the namespace." + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "description": "Description of a namespace resource." + }, + "SBNamespaceUpdateParameters": { + "properties": { + "sku": { + "$ref": "#/definitions/SBSku", + "description": "Properties of Sku" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBNamespaceProperties", + "description": "Properties of the namespace." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceNamespacePatch" + } + ], + "description": "Description of a namespace resource." + }, + "SBNamespaceProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the namespace." + }, + "createdAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the namespace was created." + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the namespace was updated." + }, + "serviceBusEndpoint": { + "readOnly": true, + "type": "string", + "description": "Endpoint you can use to perform Service Bus operations." + }, + "metricId": { + "readOnly": true, + "type": "string", + "description": "Identifier for Azure Insights metrics" + } + }, + "description": "Properties of the namespace." + }, + "SBSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of this SKU.", + "enum": [ + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": false + } + }, + "tier": { + "type": "string", + "description": "The billing tier of this particular SKU.", + "enum": [ + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": false + } + }, + "capacity": { + "format": "int32", + "type": "integer", + "description": "The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4." + } + }, + "required": [ + "name" + ], + "description": "SKU of the namespace." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/networksets.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/networksets.json new file mode 100644 index 000000000000..686dcf03fb43 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/networksets.json @@ -0,0 +1,283 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2017-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkRuleSets/default": { + "put": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceNetworkRuleSetCreate": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json" + } + }, + "operationId": "Namespaces_CreateOrUpdateNetworkRuleSet", + "description": "Create or update NetworkRuleSet for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + }, + "description": "The Namespace IpFilterRule." + } + ], + "responses": { + "200": { + "description": "Namespace NetworkRuleSet successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceNetworkRuleSetGet": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json" + } + }, + "operationId": "Namespaces_GetNetworkRuleSet", + "description": "Gets NetworkRuleSet for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace NetworkRuleSet successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkRuleSets": { + "get": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceNetworkRuleSetList": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetList.json" + } + }, + "operationId": "Namespaces_ListNetworkRuleSets", + "description": "Gets list of NetworkRuleSet for a Namespace.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of NetworkRuleSets for Namespace successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSetListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "NWRuleSetIpRules": { + "x-ms-client-flatten": true, + "properties": { + "ipMask": { + "type": "string", + "description": "IP Mask" + }, + "action": { + "type": "string", + "description": "The IP Filter Action", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "NetworkRuleIPAction", + "modelAsString": true + }, + "default": "Allow" + } + }, + "description": "Description of NetWorkRuleSet - IpRules resource." + }, + "Subnet": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID of Virtual Network Subnet" + } + }, + "required": [ + "id" + ], + "description": "Properties supplied for Subnet" + }, + "NWRuleSetVirtualNetworkRules": { + "x-ms-client-flatten": true, + "properties": { + "subnet": { + "$ref": "#/definitions/Subnet", + "description": "Subnet properties" + }, + "ignoreMissingVnetServiceEndpoint": { + "type": "boolean", + "description": "Value that indicates whether to ignore missing VNet Service Endpoint" + } + }, + "description": "Description of VirtualNetworkRules - NetworkRules resource." + }, + "NetworkRuleSet": { + "properties": { + "properties": { + "description": "NetworkRuleSet properties", + "x-ms-client-flatten": true, + "properties": { + "defaultAction": { + "type": "string", + "description": "Default Action for Network Rule Set", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "DefaultAction", + "modelAsString": true + } + }, + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetVirtualNetworkRules" + }, + "description": "List VirtualNetwork Rules" + }, + "ipRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetIpRules" + }, + "description": "List of IpRules" + } + } + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Description of NetworkRuleSet resource." + }, + "NetworkRuleSetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkRuleSet" + }, + "description": "Result of the List NetworkRuleSet operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of NetworkRuleSet." + } + }, + "description": "The response of the List NetworkRuleSet operation." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/operations.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/operations.json new file mode 100644 index 000000000000..0bedb0121ae5 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/operations.json @@ -0,0 +1,126 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2017-04-01" + }, + "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.ServiceBus/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/SBOperations_List.json" + } + }, + "description": "Lists all of the available ServiceBus REST API operations.", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list ServiceBus operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "description": "List of ServiceBus operations supported by the Microsoft.ServiceBus resource provider.", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "A ServiceBus REST API operation", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{operation}" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft.ServiceBus" + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource on which the operation is performed: Invoice, etc." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Operation type: Read, write, delete, etc." + } + } + } + } + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/servicebus.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/servicebus.json deleted file mode 100644 index 2970266db160..000000000000 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/servicebus.json +++ /dev/null @@ -1,4922 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ServiceBusManagementClient", - "description": "Azure Service Bus client", - "version": "2017-04-01" - }, - "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.ServiceBus/operations": { - "get": { - "tags": [ - "Operations" - ], - "operationId": "Operations_List", - "x-ms-examples": { - "OperationsList": { - "$ref": "./examples/SBOperations_List.json" - } - }, - "description": "Lists all of the available ServiceBus REST API operations.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/CheckNameAvailability": { - "post": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CheckNameAvailability", - "x-ms-examples": { - "NameSpaceCheckNameAvailability": { - "$ref": "./examples/NameSpaces/SBNameSpaceCheckNameAvailability.json" - } - }, - "description": "Check the give namespace name availability.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CheckNameAvailability" - }, - "description": "Parameters to check availability of the given namespace name" - } - ], - "responses": { - "200": { - "description": "check availability returned successfully.", - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/namespaces": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_List", - "x-ms-examples": { - "NameSpaceList": { - "$ref": "./examples/NameSpaces/SBNameSpaceList.json" - } - }, - "description": "Gets all the available namespaces within the subscription, irrespective of the resource groups.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespaces successfully returned.", - "schema": { - "$ref": "#/definitions/SBNamespaceListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListByResourceGroup", - "x-ms-examples": { - "NameSpaceListByResourceGroup": { - "$ref": "./examples/NameSpaces/SBNameSpaceListByResourceGroup.json" - } - }, - "description": "Gets the available namespaces within a resource group.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespaces successfully returned.", - "schema": { - "$ref": "#/definitions/SBNamespaceListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}": { - "put": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CreateOrUpdate", - "x-ms-examples": { - "NameSpaceCreate": { - "$ref": "./examples/NameSpaces/SBNameSpaceCreate.json" - } - }, - "description": "Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace name." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SBNamespace" - }, - "description": "Parameters supplied to create a namespace resource." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Namespace create request accepted.", - "schema": { - "$ref": "#/definitions/SBNamespace" - } - }, - "200": { - "description": "Namespace created successfully.", - "schema": { - "$ref": "#/definitions/SBNamespace" - } - }, - "202": { - "description": "Namespace create or update request accepted." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Delete", - "x-ms-examples": { - "NameSpaceDelete": { - "$ref": "./examples/NameSpaces/SBNameSpaceDelete.json" - } - }, - "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "200": { - "description": "Namespace successfully deleted." - }, - "202": { - "description": "Namespace delete request accepted." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Get", - "x-ms-examples": { - "NameSpaceGet": { - "$ref": "./examples/NameSpaces/SBNameSpaceGet.json" - } - }, - "description": "Gets a description for the specified namespace.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace successfully returned.", - "schema": { - "$ref": "#/definitions/SBNamespace" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Update", - "x-ms-examples": { - "NameSpaceUpdate": { - "$ref": "./examples/NameSpaces/SBNameSpaceUpdate.json" - } - }, - "description": "Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SBNamespaceUpdateParameters" - }, - "description": "Parameters supplied to update a namespace resource." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Namespace update request accepted.", - "schema": { - "$ref": "#/definitions/SBNamespace" - } - }, - "200": { - "description": "Namespace updated successfully.", - "schema": { - "$ref": "#/definitions/SBNamespace" - } - }, - "202": { - "description": "Namespace update request accepted." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListAuthorizationRules", - "x-ms-examples": { - "NameSpaceAuthorizationRuleListAll": { - "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleListAll.json" - } - }, - "description": "Gets the authorization rules for a namespace.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639376.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace authorization rules returned successfully.", - "schema": { - "$ref": "#/definitions/SBAuthorizationRuleListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}": { - "put": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CreateOrUpdateAuthorizationRule", - "x-ms-examples": { - "NameSpaceAuthorizationRuleCreate": { - "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleCreate.json" - } - }, - "description": "Creates or updates an authorization rule for a namespace.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639410.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SBAuthorizationRule" - }, - "description": "The shared access authorization rule." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace authorization rule created.", - "schema": { - "$ref": "#/definitions/SBAuthorizationRule" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_DeleteAuthorizationRule", - "x-ms-examples": { - "NameSpaceAuthorizationRuleDelete": { - "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleDelete.json" - } - }, - "description": "Deletes a namespace authorization rule.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639417.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "200": { - "description": "Namespace authorization rule successfully deleted." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_GetAuthorizationRule", - "x-ms-examples": { - "NameSpaceAuthorizationRuleGet": { - "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleGet.json" - } - }, - "description": "Gets an authorization rule for a namespace by rule name.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639392.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace authorization rule returned successfully.", - "schema": { - "$ref": "#/definitions/SBAuthorizationRule" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/listKeys": { - "post": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListKeys", - "x-ms-examples": { - "NameSpaceAuthorizationRuleListKey": { - "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleListKey.json" - } - }, - "description": "Gets the primary and secondary connection strings for the namespace.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639398.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Connection strings successfully returned.", - "schema": { - "$ref": "#/definitions/AccessKeys" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys": { - "post": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_RegenerateKeys", - "x-ms-examples": { - "NameSpaceAuthorizationRuleRegenerateKey": { - "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenerateKey.json" - } - }, - "description": "Regenerates the primary or secondary connection strings for the namespace.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt718977.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/RegenerateAccessKeyParameters" - }, - "description": "Parameters supplied to regenerate the authorization rule." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Authorization rule successfully regenerated.", - "schema": { - "$ref": "#/definitions/AccessKeys" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrate": { - "post": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Migrate", - "x-ms-examples": { - "NameSpaceUpdate": { - "$ref": "./examples/NameSpaces/SBNamespaceMigrate.json" - } - }, - "description": "This operation Migrate the given namespace to provided name type", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SBNamespaceMigrate" - }, - "description": "Parameters supplied to migrate namespace type." - } - ], - "responses": { - "200": { - "description": "Migrate Namespace type is successful." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/CheckNameAvailability": { - "post": { - "tags": [ - "DisasterRecoveryConfigs" - ], - "operationId": "DisasterRecoveryConfigs_CheckNameAvailability", - "x-ms-examples": { - "AliasNameAvailability": { - "$ref": "./examples/disasterRecoveryConfigs/SBAliasCheckNameAvailability.json" - } - }, - "description": "Check the give namespace name availability.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CheckNameAvailability" - }, - "description": "Parameters to check availability of the given namespace name" - } - ], - "responses": { - "200": { - "description": "check availability returned successfully.", - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs": { - "get": { - "tags": [ - "DisasterRecoveryConfigs" - ], - "operationId": "DisasterRecoveryConfigs_List", - "x-ms-examples": { - "SBAliasList": { - "$ref": "./examples/disasterRecoveryConfigs/SBAliasList.json" - } - }, - "description": "Gets all Alias(Disaster Recovery configurations)", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the list of Alias(Disaster Recovery configurations) for servicebus namespace", - "schema": { - "$ref": "#/definitions/ArmDisasterRecoveryListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}": { - "put": { - "tags": [ - "DisasterRecoveryConfigs" - ], - "operationId": "DisasterRecoveryConfigs_CreateOrUpdate", - "x-ms-examples": { - "SBAliasCreate": { - "$ref": "./examples/disasterRecoveryConfigs/SBAliasCreate.json" - } - }, - "description": "Creates or updates a new Alias(Disaster Recovery configuration)", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AliasNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ArmDisasterRecovery" - }, - "description": "Parameters required to create an Alias(Disaster Recovery configuration)" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Alias(Disaster Recovery configuration) successfully created", - "schema": { - "$ref": "#/definitions/ArmDisasterRecovery" - } - }, - "201": { - "description": "Alias(Disaster Recovery configuration) creation request received" - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "DisasterRecoveryConfigs" - ], - "operationId": "DisasterRecoveryConfigs_Delete", - "x-ms-examples": { - "SBAliasDelete": { - "$ref": "./examples/disasterRecoveryConfigs/SBAliasDelete.json" - } - }, - "description": "Deletes an Alias(Disaster Recovery configuration)", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AliasNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Delete Alias(Disaster Recovery configuration) request accepted" - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "DisasterRecoveryConfigs" - ], - "operationId": "DisasterRecoveryConfigs_Get", - "x-ms-examples": { - "SBAliasGet": { - "$ref": "./examples/disasterRecoveryConfigs/SBAliasGet.json" - } - }, - "description": "Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AliasNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the Alias(Disaster Recovery configurations)", - "schema": { - "$ref": "#/definitions/ArmDisasterRecovery" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/breakPairing": { - "post": { - "tags": [ - "DisasterRecoveryConfigs" - ], - "operationId": "DisasterRecoveryConfigs_BreakPairing", - "x-ms-examples": { - "SBEHAliasBreakPairing": { - "$ref": "./examples/disasterRecoveryConfigs/SBEHAliasBreakPairing.json" - } - }, - "description": "This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AliasNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Break-Pairing operation is successful." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/failover": { - "post": { - "tags": [ - "DisasterRecoveryConfigs" - ], - "operationId": "DisasterRecoveryConfigs_FailOver", - "x-ms-examples": { - "SBAliasFailOver": { - "$ref": "./examples/disasterRecoveryConfigs/SBAliasFailOver.json" - } - }, - "description": "Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AliasNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Failover operation is successful." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/AuthorizationRules": { - "get": { - "tags": [ - "DisasterRecoveryConfigs" - ], - "operationId": "DisasterRecoveryConfigs_ListAuthorizationRules", - "x-ms-examples": { - "NameSpaceAuthorizationRuleListAll": { - "$ref": "./examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListAll.json" - } - }, - "description": "Gets the authorization rules for a namespace.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639376.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AliasNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "DisasterRecoveryConfigs authorization rules returned successfully.", - "schema": { - "$ref": "#/definitions/SBAuthorizationRuleListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/AuthorizationRules/{authorizationRuleName}": { - "get": { - "tags": [ - "DisasterRecoveryConfigs" - ], - "operationId": "DisasterRecoveryConfigs_GetAuthorizationRule", - "x-ms-examples": { - "DisasterRecoveryConfigsAuthorizationRuleGet": { - "$ref": "./examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleGet.json" - } - }, - "description": "Gets an authorization rule for a namespace by rule name.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639392.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AliasNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "DisasterRecoveryConfigs authorization rule returned successfully.", - "schema": { - "$ref": "#/definitions/SBAuthorizationRule" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/{alias}/AuthorizationRules/{authorizationRuleName}/listKeys": { - "post": { - "tags": [ - "DisasterRecoveryConfigs" - ], - "operationId": "DisasterRecoveryConfigs_ListKeys", - "x-ms-examples": { - "DisasterRecoveryConfigsAuthorizationRuleListKey": { - "$ref": "./examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListKey.json" - } - }, - "description": "Gets the primary and secondary connection strings for the namespace.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639398.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/AliasNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Connection strings successfully returned.", - "schema": { - "$ref": "#/definitions/AccessKeys" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations": { - "get": { - "tags": [ - "MigrationConfigs" - ], - "operationId": "MigrationConfigs_List", - "x-ms-examples": { - "MigrationConfigurationsList": { - "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationList.json" - } - }, - "description": "Gets all migrationConfigurations", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the list of migrationConfigurations for servicebus namespace", - "schema": { - "$ref": "#/definitions/MigrationConfigListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}": { - "put": { - "tags": [ - "MigrationConfigs" - ], - "operationId": "MigrationConfigs_CreateAndStartMigration", - "x-ms-examples": { - "MigrationConfigurationsStartMigration": { - "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationCreateAndStartMigration.json" - } - }, - "description": "Creates Migration configuration and starts migration of entities from Standard to Premium namespace", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ConfigNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/MigrationConfigProperties" - }, - "description": "Parameters required to create Migration Configuration" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Migration Config successfully created", - "schema": { - "$ref": "#/definitions/MigrationConfigProperties" - } - }, - "201": { - "description": "Migration Config creation request received" - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "MigrationConfigs" - ], - "operationId": "MigrationConfigs_Delete", - "x-ms-examples": { - "MigrationConfigurationsDelete": { - "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationDelete.json" - } - }, - "description": "Deletes a MigrationConfiguration", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ConfigNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Delete Migration Config request accepted" - }, - "204": { - "description": "Not Found" - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "MigrationConfigs" - ], - "operationId": "MigrationConfigs_Get", - "x-ms-examples": { - "MigrationConfigurationsGet": { - "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationGet.json" - } - }, - "description": "Retrieves Migration Config", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ConfigNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved Migration Config)", - "schema": { - "$ref": "#/definitions/MigrationConfigProperties" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}/upgrade": { - "post": { - "tags": [ - "MigrationConfigs" - ], - "operationId": "MigrationConfigs_CompleteMigration", - "x-ms-examples": { - "MigrationConfigurationsCompleteMigration": { - "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationCompleteMigration.json" - } - }, - "description": "This operation Completes Migration of entities by pointing the connection strings to Premium namespace and any entities created after the operation will be under Premium Namespace. CompleteMigration operation will fail when entity migration is in-progress.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ConfigNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "upgrade operation of Migration Config is successful." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrationConfigurations/{configName}/revert": { - "post": { - "tags": [ - "MigrationConfigs" - ], - "operationId": "MigrationConfigs_Revert", - "x-ms-examples": { - "MigrationConfigurationsRevert": { - "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationRevert.json" - } - }, - "description": "This operation reverts Migration", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ConfigNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "MigrationConfig Revert operation is successful." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues": { - "get": { - "tags": [ - "Queues" - ], - "operationId": "Queues_ListByNamespace", - "x-ms-examples": { - "QueueListByNameSpace": { - "$ref": "./examples/Queues/SBQueueListByNameSpace.json" - } - }, - "description": "Gets the queues within a namespace.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639415.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/SkipParameter" - }, - { - "$ref": "#/parameters/TopParameter" - } - ], - "responses": { - "200": { - "description": "Queues successfully returned.", - "schema": { - "$ref": "#/definitions/SBQueueListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}": { - "put": { - "tags": [ - "Queues" - ], - "operationId": "Queues_CreateOrUpdate", - "x-ms-examples": { - "QueueCreate": { - "$ref": "./examples/Queues/SBQueueCreate.json" - } - }, - "description": "Creates or updates a Service Bus queue. This operation is idempotent.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639395.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/QueueNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SBQueue" - }, - "description": "Parameters supplied to create or update a queue resource." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Queue successfully created.", - "schema": { - "$ref": "#/definitions/SBQueue" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Queues" - ], - "operationId": "Queues_Delete", - "x-ms-examples": { - "QueueDelete": { - "$ref": "./examples/Queues/SBQueueDelete.json" - } - }, - "description": "Deletes a queue from the specified namespace in a resource group.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639411.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/QueueNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "200": { - "description": "Queue successfully deleted." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Queues" - ], - "operationId": "Queues_Get", - "x-ms-examples": { - "QueueGet": { - "$ref": "./examples/Queues/SBQueueGet.json" - } - }, - "description": "Returns a description for the specified queue.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639380.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/QueueNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Queue description successfully returned.", - "schema": { - "$ref": "#/definitions/SBQueue" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules": { - "get": { - "tags": [ - "Queues" - ], - "operationId": "Queues_ListAuthorizationRules", - "x-ms-examples": { - "QueueAuthorizationRuleListAll": { - "$ref": "./examples/Queues/SBQueueAuthorizationRuleListAll.json" - } - }, - "description": "Gets all authorization rules for a queue.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt705607.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/QueueNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Authorization rules successfully returned.", - "schema": { - "$ref": "#/definitions/SBAuthorizationRuleListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}": { - "put": { - "tags": [ - "Queues" - ], - "operationId": "Queues_CreateOrUpdateAuthorizationRule", - "x-ms-examples": { - "QueueAuthorizationRuleCreate": { - "$ref": "./examples/Queues/SBQueueAuthorizationRuleCreate.json" - } - }, - "description": "Creates an authorization rule for a queue.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/QueueNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SBAuthorizationRule" - }, - "description": "The shared access authorization rule." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Authorization rule successfully created.", - "schema": { - "$ref": "#/definitions/SBAuthorizationRule" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Queues" - ], - "operationId": "Queues_DeleteAuthorizationRule", - "x-ms-examples": { - "QueueAuthorizationRuleDelete": { - "$ref": "./examples/Queues/SBQueueAuthorizationRuleDelete.json" - } - }, - "description": "Deletes a queue authorization rule.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt705609.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/QueueNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "200": { - "description": "Authorization rule successfully deleted." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Queues" - ], - "operationId": "Queues_GetAuthorizationRule", - "x-ms-examples": { - "QueueAuthorizationRuleGet": { - "$ref": "./examples/Queues/SBQueueAuthorizationRuleGet.json" - } - }, - "description": "Gets an authorization rule for a queue by rule name.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt705611.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/QueueNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Authorization rule successfully returned.", - "schema": { - "$ref": "#/definitions/SBAuthorizationRule" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}/ListKeys": { - "post": { - "tags": [ - "Queues" - ], - "operationId": "Queues_ListKeys", - "x-ms-examples": { - "QueueAuthorizationRuleListKey": { - "$ref": "./examples/Queues/SBQueueAuthorizationRuleListKey.json" - } - }, - "description": "Primary and secondary connection strings to the queue.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt705608.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/QueueNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Connection strings successfully returned.", - "schema": { - "$ref": "#/definitions/AccessKeys" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { - "post": { - "tags": [ - "Queues" - ], - "operationId": "Queues_RegenerateKeys", - "x-ms-examples": { - "QueueAuthorizationRuleRegenerateKey": { - "$ref": "./examples/Queues/SBQueueAuthorizationRuleRegenerateKey.json" - } - }, - "description": "Regenerates the primary or secondary connection strings to the queue.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt705606.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/QueueNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/RegenerateAccessKeyParameters" - }, - "description": "Parameters supplied to regenerate the authorization rule." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Connection strings successfully regenerated.", - "schema": { - "$ref": "#/definitions/AccessKeys" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics": { - "get": { - "tags": [ - "Topics" - ], - "operationId": "Topics_ListByNamespace", - "x-ms-examples": { - "TopicGet": { - "$ref": "./examples/Topics/SBTopicListByNameSpace.json" - } - }, - "description": "Gets all the topics in a namespace.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639388.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/SkipParameter" - }, - { - "$ref": "#/parameters/TopParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved list of topics.", - "schema": { - "$ref": "#/definitions/SBTopicListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}": { - "put": { - "tags": [ - "Topics" - ], - "operationId": "Topics_CreateOrUpdate", - "x-ms-examples": { - "TopicCreate": { - "$ref": "./examples/Topics/SBTopicCreate.json" - } - }, - "description": "Creates a topic in the specified namespace.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639409.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/TopicNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SBTopic" - }, - "description": "Parameters supplied to create a topic resource." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Topic successfully created.", - "schema": { - "$ref": "#/definitions/SBTopic" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Topics" - ], - "operationId": "Topics_Delete", - "x-ms-examples": { - "TopicDelete": { - "$ref": "./examples/Topics/SBTopicDelete.json" - } - }, - "description": "Deletes a topic from the specified namespace and resource group.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639404.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/TopicNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "200": { - "description": "Topic successfully deleted." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Topics" - ], - "operationId": "Topics_Get", - "x-ms-examples": { - "TopicGet": { - "$ref": "./examples/Topics/SBTopicGet.json" - } - }, - "description": "Returns a description for the specified topic.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639399.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/TopicNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Topic description successfully retrieved.", - "schema": { - "$ref": "#/definitions/SBTopic" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules": { - "get": { - "tags": [ - "Topics" - ], - "operationId": "Topics_ListAuthorizationRules", - "x-ms-examples": { - "TopicAuthorizationRuleListAll": { - "$ref": "./examples/Topics/SBTopicAuthorizationRuleListAll.json" - } - }, - "description": "Gets authorization rules for a topic.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt720681.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/TopicNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Authorization rules successfully returned.", - "schema": { - "$ref": "#/definitions/SBAuthorizationRuleListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}": { - "put": { - "tags": [ - "Topics" - ], - "operationId": "Topics_CreateOrUpdateAuthorizationRule", - "x-ms-examples": { - "TopicAuthorizationRuleCreate": { - "$ref": "./examples/Topics/SBTopicAuthorizationRuleCreate.json" - } - }, - "description": "Creates an authorization rule for the specified topic.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt720678.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/TopicNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SBAuthorizationRule" - }, - "description": "The shared access authorization rule." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Topic authorization rule successfully created.", - "schema": { - "$ref": "#/definitions/SBAuthorizationRule" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Topics" - ], - "operationId": "Topics_GetAuthorizationRule", - "x-ms-examples": { - "TopicAuthorizationRuleGet": { - "$ref": "./examples/Topics/SBTopicAuthorizationRuleGet.json" - } - }, - "description": "Returns the specified authorization rule.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt720676.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/TopicNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Topic authorization rule returned successfully.", - "schema": { - "$ref": "#/definitions/SBAuthorizationRule" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Topics" - ], - "operationId": "Topics_DeleteAuthorizationRule", - "x-ms-examples": { - "TopicAuthorizationRuleDelete": { - "$ref": "./examples/Topics/SBTopicAuthorizationRuleDelete.json" - } - }, - "description": "Deletes a topic authorization rule.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt720681.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/TopicNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "200": { - "description": "Topic authorization rule successfully deleted." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/ListKeys": { - "post": { - "tags": [ - "Topics" - ], - "operationId": "Topics_ListKeys", - "x-ms-examples": { - "TopicAuthorizationRuleListKey": { - "$ref": "./examples/Topics/SBTopicAuthorizationRuleListKey.json" - } - }, - "description": "Gets the primary and secondary connection strings for the topic.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt720677.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/TopicNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Connection strings successfully retrieved.", - "schema": { - "$ref": "#/definitions/AccessKeys" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/regenerateKeys": { - "post": { - "tags": [ - "Topics" - ], - "operationId": "Topics_RegenerateKeys", - "x-ms-examples": { - "TopicAuthorizationRuleRegenerateKey": { - "$ref": "./examples/Topics/SBTopicAuthorizationRuleRegenerateKey.json" - } - }, - "description": "Regenerates primary or secondary connection strings for the topic.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt720679.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/TopicNameParameter" - }, - { - "$ref": "#/parameters/AuthorizationRuleNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/RegenerateAccessKeyParameters" - }, - "description": "Parameters supplied to regenerate the authorization rule." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Connection strings successfully regenerated.", - "schema": { - "$ref": "#/definitions/AccessKeys" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions": { - "get": { - "tags": [ - "Subscriptions" - ], - "operationId": "Subscriptions_ListByTopic", - "x-ms-examples": { - "SubscriptionListByTopic": { - "$ref": "./examples/Subscriptions/SBSubscriptionListByTopic.json" - } - }, - "description": "List all the subscriptions under a specified topic.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639400.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/TopicNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/SkipParameter" - }, - { - "$ref": "#/parameters/TopParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved list of subscriptions.", - "schema": { - "$ref": "#/definitions/SBSubscriptionListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}": { - "put": { - "tags": [ - "Subscriptions" - ], - "operationId": "Subscriptions_CreateOrUpdate", - "x-ms-examples": { - "SubscriptionCreate": { - "$ref": "./examples/Subscriptions/SBSubscriptionCreate.json" - } - }, - "description": "Creates a topic subscription.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639385.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/TopicNameParameter" - }, - { - "$ref": "#/parameters/SubscriptionNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SBSubscription" - }, - "description": "Parameters supplied to create a subscription resource." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Subscription create request accepted.", - "schema": { - "$ref": "#/definitions/SBSubscription" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Subscriptions" - ], - "operationId": "Subscriptions_Delete", - "x-ms-examples": { - "SubscriptionDelete": { - "$ref": "./examples/Subscriptions/SBSubscriptionDelete.json" - } - }, - "description": "Deletes a subscription from the specified topic.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639381.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/TopicNameParameter" - }, - { - "$ref": "#/parameters/SubscriptionNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "200": { - "description": "Subscription successfully deleted." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Subscriptions" - ], - "operationId": "Subscriptions_Get", - "x-ms-examples": { - "SubscriptionGet": { - "$ref": "./examples/Subscriptions/SBSubscriptionGet.json" - } - }, - "description": "Returns a subscription description for the specified topic.", - "externalDocs": { - "url": "https://msdn.microsoft.com/en-us/library/azure/mt639402.aspx" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/TopicNameParameter" - }, - { - "$ref": "#/parameters/SubscriptionNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved subscription description.", - "schema": { - "$ref": "#/definitions/SBSubscription" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules": { - "get": { - "tags": [ - "Rules" - ], - "operationId": "Rules_ListBySubscriptions", - "x-ms-examples": { - "RulesListBySubscriptions": { - "$ref": "./examples/Rules/RuleListBySubscription.json" - } - }, - "description": "List all the rules within given topic-subscription", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/TopicNameParameter" - }, - { - "$ref": "#/parameters/SubscriptionNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/SkipParameter" - }, - { - "$ref": "#/parameters/TopParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved list of Rules.", - "schema": { - "$ref": "#/definitions/RuleListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules/{ruleName}": { - "put": { - "tags": [ - "Rules" - ], - "operationId": "Rules_CreateOrUpdate", - "x-ms-examples": { - "RulesCreateOrUpdate": { - "$ref": "./examples/Rules/RuleCreate.json" - }, - "RulesCreateSqlFilter": { - "$ref": "./examples/Rules/RuleCreate_SqlFilter.json" - }, - "RulesCreateCorrelationFilter": { - "$ref": "./examples/Rules/RuleCreate_CorrelationFilter.json" - } - }, - "description": "Creates a new rule and updates an existing rule", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/TopicNameParameter" - }, - { - "$ref": "#/parameters/SubscriptionNameParameter" - }, - { - "$ref": "#/parameters/RuleNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Rule" - }, - "description": "Parameters supplied to create a rule." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Rule created.", - "schema": { - "$ref": "#/definitions/Rule" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Rules" - ], - "operationId": "Rules_Delete", - "x-ms-examples": { - "RulesDelete": { - "$ref": "./examples/Rules/RuleDelete.json" - } - }, - "description": "Deletes an existing rule.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/TopicNameParameter" - }, - { - "$ref": "#/parameters/SubscriptionNameParameter" - }, - { - "$ref": "#/parameters/RuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "200": { - "description": "Rule deleted." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Subscriptions" - ], - "operationId": "Rules_Get", - "x-ms-examples": { - "RulesGet": { - "$ref": "./examples/Rules/RuleGet.json" - } - }, - "description": "Retrieves the description for the specified rule.", - "externalDocs": { - "url": "" - }, - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/TopicNameParameter" - }, - { - "$ref": "#/parameters/SubscriptionNameParameter" - }, - { - "$ref": "#/parameters/RuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved rule description.", - "schema": { - "$ref": "#/definitions/Rule" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/sku/{sku}/regions": { - "get": { - "tags": [ - "Regions" - ], - "operationId": "Regions_ListBySku", - "x-ms-examples": { - "RegionsListBySku": { - "$ref": "./examples/SkuRegions/SkuRegions.json" - } - }, - "description": "Gets the available Regions for a given sku", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/SkuNameParameter" - } - ], - "responses": { - "200": { - "description": "Regions successfully returned.", - "schema": { - "$ref": "#/definitions/PremiumMessagingRegionsListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/premiumMessagingRegions": { - "get": { - "tags": [ - "PremiumMessagingRegions" - ], - "operationId": "PremiumMessagingRegions_List", - "x-ms-examples": { - "PremiumMessagingRegionsList": { - "$ref": "./examples/SkuRegions/PremiumMessagingRegions.json" - } - }, - "description": "Gets the available premium messaging regions for servicebus ", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Premium messaging regions successfully returned.", - "schema": { - "$ref": "#/definitions/PremiumMessagingRegionsListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/eventhubs": { - "get": { - "tags": [ - "EventHubs" - ], - "operationId": "EventHubs_ListByNamespace", - "x-ms-examples": { - "RulesCreateOrUpdate": { - "$ref": "./examples/SkuRegions/EventHubs.json" - } - }, - "description": "Gets all the Event Hubs in a service bus Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the list of Event Hubs.", - "schema": { - "$ref": "#/definitions/EventHubListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkRuleSets/default": { - "put": { - "tags": [ - "Namespaces" - ], - "x-ms-examples": { - "NameSpaceNetworkRuleSetCreate": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json" - } - }, - "operationId": "Namespaces_CreateOrUpdateNetworkRuleSet", - "description": "Create or update NetworkRuleSet for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/NetworkRuleSet" - }, - "description": "The Namespace IpFilterRule." - } - ], - "responses": { - "200": { - "description": "Namespace NetworkRuleSet successfully returned.", - "schema": { - "$ref": "#/definitions/NetworkRuleSet" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Namespaces" - ], - "x-ms-examples": { - "NameSpaceNetworkRuleSetGet": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json" - } - }, - "operationId": "Namespaces_GetNetworkRuleSet", - "description": "Gets NetworkRuleSet for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace NetworkRuleSet successfully returned.", - "schema": { - "$ref": "#/definitions/NetworkRuleSet" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkRuleSets": { - "get": { - "tags": [ - "Namespaces" - ], - "x-ms-examples": { - "NameSpaceNetworkRuleSetList": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetList.json" - } - }, - "operationId": "Namespaces_ListNetworkRuleSets", - "description": "Gets list of NetworkRuleSet for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "List of NetworkRuleSets for Namespace successfully returned.", - "schema": { - "$ref": "#/definitions/NetworkRuleSetListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "TrackedResource": { - "properties": { - "location": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "The Geo-location where the resource lives" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "required": [ - "location" - ], - "description": "The Resource definition." - }, - "Resource": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Resource type" - } - }, - "x-ms-azure-resource": true, - "description": "The Resource definition for other than namespace." - }, - "ResourceNamespacePatch": { - "properties": { - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "The Resource definition." - }, - "SBNamespaceListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SBNamespace" - }, - "description": "Result of the List Namespace operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of Namespaces." - } - }, - "description": "The response of the List Namespace operation." - }, - "SBNamespace": { - "properties": { - "sku": { - "$ref": "#/definitions/SBSku", - "description": "Properties of Sku" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SBNamespaceProperties", - "description": "Properties of the namespace." - } - }, - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "description": "Description of a namespace resource." - }, - "SBNamespaceUpdateParameters": { - "properties": { - "sku": { - "$ref": "#/definitions/SBSku", - "description": "Properties of Sku" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SBNamespaceProperties", - "description": "Properties of the namespace." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ResourceNamespacePatch" - } - ], - "description": "Description of a namespace resource." - }, - "SBNamespaceProperties": { - "properties": { - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "Provisioning state of the namespace." - }, - "createdAt": { - "readOnly": true, - "format": "date-time", - "type": "string", - "description": "The time the namespace was created." - }, - "updatedAt": { - "readOnly": true, - "format": "date-time", - "type": "string", - "description": "The time the namespace was updated." - }, - "serviceBusEndpoint": { - "readOnly": true, - "type": "string", - "description": "Endpoint you can use to perform Service Bus operations." - }, - "metricId": { - "readOnly": true, - "type": "string", - "description": "Identifier for Azure Insights metrics" - } - }, - "description": "Properties of the namespace." - }, - "SBSku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of this SKU.", - "enum": [ - "Basic", - "Standard", - "Premium" - ], - "x-ms-enum": { - "name": "SkuName", - "modelAsString": false - } - }, - "tier": { - "type": "string", - "description": "The billing tier of this particular SKU.", - "enum": [ - "Basic", - "Standard", - "Premium" - ], - "x-ms-enum": { - "name": "SkuTier", - "modelAsString": false - } - }, - "capacity": { - "format": "int32", - "type": "integer", - "description": "The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4." - } - }, - "required": [ - "name" - ], - "description": "SKU of the namespace." - }, - "SBNamespaceMigrate": { - "type": "object", - "properties": { - "targetNamespaceType": { - "type": "string", - "description": "Type of namespaces", - "enum": [ - "Messaging", - "NotificationHub", - "Mixed", - "EventHub", - "Relay" - ], - "x-ms-enum": { - "name": "NameSpaceType", - "modelAsString": false - } - } - }, - "required": [ - "targetNamespaceType" - ], - "description": "Namespace Migrate Object" - }, - "SBAuthorizationRuleListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SBAuthorizationRule" - }, - "description": "Result of the List Authorization Rules operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of Authorization Rules." - } - }, - "description": "The response to the List Namespace operation." - }, - "SBAuthorizationRule": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "properties": { - "rights": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Manage", - "Send", - "Listen" - ], - "x-ms-enum": { - "name": "AccessRights", - "modelAsString": false - } - }, - "description": "The rights associated with the rule." - } - }, - "required": [ - "rights" - ], - "description": "AuthorizationRule properties." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Description of a namespace authorization rule." - }, - "AuthorizationRuleProperties": { - "properties": { - "rights": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Manage", - "Send", - "Listen" - ], - "x-ms-enum": { - "name": "AccessRights", - "modelAsString": false - } - }, - "description": "The rights associated with the rule." - } - }, - "required": [ - "rights" - ], - "description": "AuthorizationRule properties." - }, - "AccessKeys": { - "properties": { - "primaryConnectionString": { - "readOnly": true, - "type": "string", - "description": "Primary connection string of the created namespace authorization rule." - }, - "secondaryConnectionString": { - "readOnly": true, - "type": "string", - "description": "Secondary connection string of the created namespace authorization rule." - }, - "aliasPrimaryConnectionString": { - "readOnly": true, - "type": "string", - "description": "Primary connection string of the alias if GEO DR is enabled" - }, - "aliasSecondaryConnectionString": { - "readOnly": true, - "type": "string", - "description": "Secondary connection string of the alias if GEO DR is enabled" - }, - "primaryKey": { - "readOnly": true, - "type": "string", - "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." - }, - "secondaryKey": { - "readOnly": true, - "type": "string", - "description": "A base64-encoded 256-bit primary key for signing and validating the SAS token." - }, - "keyName": { - "readOnly": true, - "type": "string", - "description": "A string that describes the authorization rule." - } - }, - "description": "Namespace/ServiceBus Connection String" - }, - "RegenerateAccessKeyParameters": { - "properties": { - "keyType": { - "type": "string", - "description": "The access key to regenerate.", - "enum": [ - "PrimaryKey", - "SecondaryKey" - ], - "x-ms-enum": { - "name": "KeyType", - "modelAsString": false - } - }, - "key": { - "type": "string", - "description": "Optional, if the key value provided, is reset for KeyType value or autogenerate Key value set for keyType" - } - }, - "required": [ - "keyType" - ], - "description": "Parameters supplied to the Regenerate Authorization Rule operation, specifies which key needs to be reset." - }, - "SBQueueListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SBQueue" - }, - "description": "Result of the List Queues operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of queues." - } - }, - "description": "The response to the List Queues operation." - }, - "SBQueue": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SBQueueProperties", - "description": "Queue Properties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Description of queue Resource." - }, - "SBQueueProperties": { - "properties": { - "countDetails": { - "readOnly": true, - "$ref": "#/definitions/MessageCountDetails", - "description": "Message Count Details." - }, - "createdAt": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "The exact time the message was created." - }, - "updatedAt": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "The exact time the message was updated." - }, - "accessedAt": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "Last time a message was sent, or the last time there was a receive request to this queue." - }, - "sizeInBytes": { - "readOnly": true, - "format": "int64", - "type": "integer", - "description": "The size of the queue, in bytes." - }, - "messageCount": { - "readOnly": true, - "format": "int64", - "type": "integer", - "description": "The number of messages in the queue." - }, - "lockDuration": { - "format": "duration", - "type": "string", - "description": "ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute." - }, - "maxSizeInMegabytes": { - "format": "int32", - "type": "integer", - "description": "The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024." - }, - "requiresDuplicateDetection": { - "type": "boolean", - "description": "A value indicating if this queue requires duplicate detection." - }, - "requiresSession": { - "type": "boolean", - "description": "A value that indicates whether the queue supports the concept of sessions." - }, - "defaultMessageTimeToLive": { - "format": "duration", - "type": "string", - "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." - }, - "deadLetteringOnMessageExpiration": { - "type": "boolean", - "description": "A value that indicates whether this queue has dead letter support when a message expires." - }, - "duplicateDetectionHistoryTimeWindow": { - "format": "duration", - "type": "string", - "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes." - }, - "maxDeliveryCount": { - "format": "int32", - "type": "integer", - "description": "The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10." - }, - "status": { - "$ref": "#/definitions/EntityStatus", - "description": "Enumerates the possible values for the status of a messaging entity." - }, - "enableBatchedOperations": { - "type": "boolean", - "description": "Value that indicates whether server-side batched operations are enabled." - }, - "autoDeleteOnIdle": { - "format": "duration", - "type": "string", - "description": "ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes." - }, - "enablePartitioning": { - "type": "boolean", - "description": "A value that indicates whether the queue is to be partitioned across multiple message brokers." - }, - "enableExpress": { - "type": "boolean", - "description": "A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage." - }, - "forwardTo": { - "type": "string", - "description": "Queue/Topic name to forward the messages" - }, - "forwardDeadLetteredMessagesTo": { - "type": "string", - "description": "Queue/Topic name to forward the Dead Letter message" - } - }, - "description": "The Queue Properties definition." - }, - "MessageCountDetails": { - "type": "object", - "properties": { - "activeMessageCount": { - "readOnly": true, - "format": "int64", - "type": "integer", - "description": "Number of active messages in the queue, topic, or subscription." - }, - "deadLetterMessageCount": { - "readOnly": true, - "format": "int64", - "type": "integer", - "description": "Number of messages that are dead lettered." - }, - "scheduledMessageCount": { - "readOnly": true, - "format": "int64", - "type": "integer", - "description": "Number of scheduled messages." - }, - "transferMessageCount": { - "readOnly": true, - "format": "int64", - "type": "integer", - "description": "Number of messages transferred to another queue, topic, or subscription." - }, - "transferDeadLetterMessageCount": { - "readOnly": true, - "format": "int64", - "type": "integer", - "description": "Number of messages transferred into dead letters." - } - }, - "description": "Message Count Details." - }, - "SBTopicListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SBTopic" - }, - "description": "Result of the List Topics operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of topics." - } - }, - "description": "The response to the List Topics operation." - }, - "SBTopic": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SBTopicProperties", - "description": "Properties of topic resource." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Description of topic resource." - }, - "SBTopicProperties": { - "properties": { - "sizeInBytes": { - "readOnly": true, - "format": "int64", - "type": "integer", - "description": "Size of the topic, in bytes." - }, - "createdAt": { - "readOnly": true, - "format": "date-time", - "type": "string", - "description": "Exact time the message was created." - }, - "updatedAt": { - "readOnly": true, - "format": "date-time", - "type": "string", - "description": "The exact time the message was updated." - }, - "accessedAt": { - "readOnly": true, - "format": "date-time", - "type": "string", - "description": "Last time the message was sent, or a request was received, for this topic." - }, - "subscriptionCount": { - "readOnly": true, - "format": "int32", - "type": "integer", - "description": "Number of subscriptions." - }, - "countDetails": { - "readOnly": true, - "$ref": "#/definitions/MessageCountDetails", - "description": "Message count details" - }, - "defaultMessageTimeToLive": { - "format": "duration", - "type": "string", - "description": "ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." - }, - "maxSizeInMegabytes": { - "format": "int32", - "type": "integer", - "description": "Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024." - }, - "requiresDuplicateDetection": { - "type": "boolean", - "description": "Value indicating if this topic requires duplicate detection." - }, - "duplicateDetectionHistoryTimeWindow": { - "format": "duration", - "type": "string", - "description": "ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes." - }, - "enableBatchedOperations": { - "type": "boolean", - "description": "Value that indicates whether server-side batched operations are enabled." - }, - "status": { - "$ref": "#/definitions/EntityStatus", - "description": "Enumerates the possible values for the status of a messaging entity." - }, - "supportOrdering": { - "type": "boolean", - "description": "Value that indicates whether the topic supports ordering." - }, - "autoDeleteOnIdle": { - "format": "duration", - "type": "string", - "description": "ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes." - }, - "enablePartitioning": { - "type": "boolean", - "description": "Value that indicates whether the topic to be partitioned across multiple message brokers is enabled." - }, - "enableExpress": { - "type": "boolean", - "description": "Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage." - } - }, - "description": "The Topic Properties definition." - }, - "SBSubscriptionListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SBSubscription" - }, - "description": "Result of the List Subscriptions operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of subscriptions." - } - }, - "description": "The response to the List Subscriptions operation." - }, - "SBSubscription": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SBSubscriptionProperties", - "description": "Properties of subscriptions resource." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Description of subscription resource." - }, - "SBSubscriptionProperties": { - "properties": { - "messageCount": { - "readOnly": true, - "format": "int64", - "type": "integer", - "description": "Number of messages." - }, - "createdAt": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "Exact time the message was created." - }, - "accessedAt": { - "readOnly": true, - "format": "date-time", - "type": "string", - "description": "Last time there was a receive request to this subscription." - }, - "updatedAt": { - "readOnly": true, - "format": "date-time", - "type": "string", - "description": "The exact time the message was updated." - }, - "countDetails": { - "readOnly": true, - "$ref": "#/definitions/MessageCountDetails", - "description": "Message count details" - }, - "lockDuration": { - "format": "duration", - "type": "string", - "description": "ISO 8061 lock duration timespan for the subscription. The default value is 1 minute." - }, - "requiresSession": { - "type": "boolean", - "description": "Value indicating if a subscription supports the concept of sessions." - }, - "defaultMessageTimeToLive": { - "format": "duration", - "type": "string", - "description": "ISO 8061 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." - }, - "deadLetteringOnFilterEvaluationExceptions": { - "type": "boolean", - "description": "Value that indicates whether a subscription has dead letter support on filter evaluation exceptions." - }, - "deadLetteringOnMessageExpiration": { - "type": "boolean", - "description": "Value that indicates whether a subscription has dead letter support when a message expires." - }, - "duplicateDetectionHistoryTimeWindow": { - "format": "duration", - "type": "string", - "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes." - }, - "maxDeliveryCount": { - "format": "int32", - "type": "integer", - "description": "Number of maximum deliveries." - }, - "status": { - "$ref": "#/definitions/EntityStatus", - "description": "Enumerates the possible values for the status of a messaging entity." - }, - "enableBatchedOperations": { - "type": "boolean", - "description": "Value that indicates whether server-side batched operations are enabled." - }, - "autoDeleteOnIdle": { - "format": "duration", - "type": "string", - "description": "ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes." - }, - "forwardTo": { - "type": "string", - "description": "Queue/Topic name to forward the messages" - }, - "forwardDeadLetteredMessagesTo": { - "type": "string", - "description": "Queue/Topic name to forward the Dead Letter message" - } - }, - "description": "Description of Subscription Resource." - }, - "EntityStatus": { - "type": "string", - "enum": [ - "Active", - "Disabled", - "Restoring", - "SendDisabled", - "ReceiveDisabled", - "Creating", - "Deleting", - "Renaming", - "Unknown" - ], - "x-ms-enum": { - "name": "EntityStatus", - "modelAsString": false - }, - "description": "Entity status." - }, - "UnavailableReason": { - "type": "string", - "enum": [ - "None", - "InvalidName", - "SubscriptionIsDisabled", - "NameInUse", - "NameInLockdown", - "TooManyNamespaceInCurrentSubscription" - ], - "x-ms-enum": { - "name": "UnavailableReason", - "modelAsString": false - }, - "description": "Specifies the reason for the unavailability of the service." - }, - "CheckNameAvailability": { - "properties": { - "name": { - "type": "string", - "description": "The Name to check the namespace name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number." - } - }, - "required": [ - "name" - ], - "description": "Description of a Check Name availability request properties." - }, - "CheckNameAvailabilityResult": { - "properties": { - "message": { - "readOnly": true, - "type": "string", - "description": "The detailed info regarding the reason associated with the namespace." - }, - "nameAvailable": { - "type": "boolean", - "description": "Value indicating namespace is availability, true if the namespace is available; otherwise, false." - }, - "reason": { - "$ref": "#/definitions/UnavailableReason", - "description": "The reason for unavailability of a namespace." - } - }, - "description": "Description of a Check Name availability request properties." - }, - "OperationListResult": { - "description": "Result of the request to list ServiceBus operations. It contains a list of operations and a URL link to get the next set of results.", - "properties": { - "value": { - "readOnly": true, - "type": "array", - "description": "List of ServiceBus operations supported by the Microsoft.ServiceBus resource provider.", - "items": { - "$ref": "#/definitions/Operation" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "URL to get the next set of operation list results if there are any." - } - } - }, - "Operation": { - "description": "A ServiceBus REST API operation", - "type": "object", - "properties": { - "name": { - "readOnly": true, - "type": "string", - "description": "Operation name: {provider}/{resource}/{operation}" - }, - "display": { - "description": "The object that represents the operation.", - "properties": { - "provider": { - "readOnly": true, - "type": "string", - "description": "Service provider: Microsoft.ServiceBus" - }, - "resource": { - "readOnly": true, - "type": "string", - "description": "Resource on which the operation is performed: Invoice, etc." - }, - "operation": { - "readOnly": true, - "type": "string", - "description": "Operation type: Read, write, delete, etc." - } - } - } - } - }, - "ErrorResponse": { - "description": "Error response indicates ServiceBus service is not able to process the incoming request. The reason is provided in the error message.", - "type": "object", - "properties": { - "code": { - "description": "Error code.", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - }, - "Rule": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/Ruleproperties", - "description": "Properties of Rule resource" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Description of Rule Resource." - }, - "Ruleproperties": { - "properties": { - "action": { - "$ref": "#/definitions/Action", - "description": "Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression." - }, - "filterType": { - "$ref": "#/definitions/FilterType", - "description": "Filter type that is evaluated against a BrokeredMessage." - }, - "sqlFilter": { - "$ref": "#/definitions/SqlFilter", - "description": "Properties of sqlFilter" - }, - "correlationFilter": { - "$ref": "#/definitions/CorrelationFilter", - "description": "Properties of correlationFilter" - } - }, - "description": "Description of Rule Resource." - }, - "RuleListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Rule" - }, - "description": "Result of the List Rules operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of rules" - } - }, - "description": "The response of the List rule operation." - }, - "FilterType": { - "type": "string", - "enum": [ - "SqlFilter", - "CorrelationFilter" - ], - "x-ms-enum": { - "name": "FilterType", - "modelAsString": false - }, - "description": "Rule filter types" - }, - "SqlFilter": { - "type": "object", - "properties": { - "sqlExpression": { - "type": "string", - "description": "The SQL expression. e.g. MyProperty='ABC'" - }, - "compatibilityLevel": { - "format": "int32", - "type": "integer", - "default": 20, - "minimum": 20, - "maximum": 20, - "description": "This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20." - }, - "requiresPreprocessing": { - "type": "boolean", - "default": true, - "description": "Value that indicates whether the rule action requires preprocessing." - } - }, - "description": "Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline." - }, - "CorrelationFilter": { - "type": "object", - "properties": { - "properties": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "dictionary object for custom filters" - }, - "correlationId": { - "type": "string", - "description": "Identifier of the correlation." - }, - "messageId": { - "type": "string", - "description": "Identifier of the message." - }, - "to": { - "type": "string", - "description": "Address to send to." - }, - "replyTo": { - "type": "string", - "description": "Address of the queue to reply to." - }, - "label": { - "type": "string", - "description": "Application specific label." - }, - "sessionId": { - "type": "string", - "description": "Session identifier." - }, - "replyToSessionId": { - "type": "string", - "description": "Session identifier to reply to." - }, - "contentType": { - "type": "string", - "description": "Content type of the message." - }, - "requiresPreprocessing": { - "type": "boolean", - "default": true, - "description": "Value that indicates whether the rule action requires preprocessing." - } - }, - "description": "Represents the correlation filter expression." - }, - "Action": { - "type": "object", - "properties": { - "sqlExpression": { - "type": "string", - "description": "SQL expression. e.g. MyProperty='ABC'" - }, - "compatibilityLevel": { - "format": "int32", - "type": "integer", - "description": "This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20." - }, - "requiresPreprocessing": { - "type": "boolean", - "default": true, - "description": "Value that indicates whether the rule action requires preprocessing." - } - }, - "description": "Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression." - }, - "SqlRuleAction": { - "type": "object", - "properties": { - "sqlExpression": { - "type": "string", - "description": "SQL expression. e.g. MyProperty='ABC'" - }, - "compatibilityLevel": { - "format": "int32", - "type": "integer", - "description": "This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20." - }, - "requiresPreprocessing": { - "type": "boolean", - "default": true, - "description": "Value that indicates whether the rule action requires preprocessing." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Action" - } - ], - "description": "Represents set of actions written in SQL language-based syntax that is performed against a ServiceBus.Messaging.BrokeredMessage " - }, - "PremiumMessagingRegions": { - "properties": { - "properties": { - "properties": { - "code": { - "readOnly": true, - "type": "string", - "description": "Region code" - }, - "fullName": { - "readOnly": true, - "type": "string", - "description": "Full name of the region" - } - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/ResourceNamespacePatch" - } - ], - "description": "Premium Messaging Region" - }, - "PremiumMessagingRegionsListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PremiumMessagingRegions" - }, - "description": "Result of the List PremiumMessagingRegions type." - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next set of results. Not empty if Value contains incomplete list of PremiumMessagingRegions." - } - }, - "description": "The response of the List PremiumMessagingRegions operation." - }, - "Eventhub": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "properties": { - "partitionIds": { - "readOnly": true, - "type": "array", - "items": { - "type": "string" - }, - "description": "Current number of shards on the Event Hub." - }, - "createdAt": { - "readOnly": true, - "format": "date-time", - "type": "string", - "description": "Exact time the Event Hub was created." - }, - "updatedAt": { - "readOnly": true, - "format": "date-time", - "type": "string", - "description": "The exact time the message was updated." - }, - "messageRetentionInDays": { - "format": "int64", - "type": "integer", - "maximum": 7, - "minimum": 1, - "description": "Number of days to retain the events for this Event Hub, value should be 1 to 7 days" - }, - "partitionCount": { - "format": "int64", - "type": "integer", - "maximum": 32, - "minimum": 1, - "description": "Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions." - }, - "status": { - "type": "string", - "description": "Enumerates the possible values for the status of the Event Hub.", - "enum": [ - "Active", - "Disabled", - "Restoring", - "SendDisabled", - "ReceiveDisabled", - "Creating", - "Deleting", - "Renaming", - "Unknown" - ], - "x-ms-enum": { - "name": "EntityStatus", - "modelAsString": false - } - }, - "captureDescription": { - "$ref": "#/definitions/CaptureDescription", - "description": "Properties of capture description" - } - }, - "description": "Properties supplied to the Create Or Update Event Hub operation." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Single item in List or Get Event Hub operation" - }, - "EventHubListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Eventhub" - }, - "description": "Result of the List EventHubs operation." - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next set of results. Not empty if Value contains incomplete list of EventHubs." - } - }, - "description": "The result of the List EventHubs operation." - }, - "CaptureDescription": { - "properties": { - "enabled": { - "type": "boolean", - "description": "A value that indicates whether capture description is enabled. " - }, - "encoding": { - "type": "string", - "description": "Enumerates the possible values for the encoding format of capture description.", - "enum": [ - "Avro", - "AvroDeflate" - ], - "x-ms-enum": { - "name": "EncodingCaptureDescription", - "modelAsString": false - } - }, - "intervalInSeconds": { - "format": "int32", - "type": "integer", - "maximum": 900, - "minimum": 60, - "description": "The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds" - }, - "sizeLimitInBytes": { - "format": "int32", - "type": "integer", - "maximum": 524288000, - "minimum": 10485760, - "description": "The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 and 524288000 bytes" - }, - "destination": { - "$ref": "#/definitions/Destination", - "description": "Properties of Destination where capture will be stored. (Storage Account, Blob Names)" - } - }, - "description": "Properties to configure capture description for eventhub" - }, - "Destination": { - "properties": { - "name": { - "type": "string", - "description": "Name for capture destination" - }, - "properties": { - "x-ms-client-flatten": true, - "properties": { - "storageAccountResourceId": { - "type": "string", - "description": "Resource id of the storage account to be used to create the blobs" - }, - "blobContainer": { - "type": "string", - "description": "Blob container Name" - }, - "archiveNameFormat": { - "type": "string", - "description": "Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order" - } - }, - "description": "Properties describing the storage account, blob container and archive name format for capture destination" - } - }, - "description": "Capture storage details for capture description" - }, - "ArmDisasterRecovery": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "properties": { - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "Provisioning state of the Alias(Disaster Recovery configuration) - possible values 'Accepted' or 'Succeeded' or 'Failed'", - "enum": [ - "Accepted", - "Succeeded", - "Failed" - ], - "x-ms-enum": { - "name": "ProvisioningStateDR", - "modelAsString": false - } - }, - "pendingReplicationOperationsCount": { - "readOnly": true, - "format": "int64", - "type": "integer", - "description": "Number of entities pending to be replicated." - }, - "partnerNamespace": { - "type": "string", - "description": "ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing" - }, - "alternateName": { - "type": "string", - "description": "Primary/Secondary eventhub namespace name, which is part of GEO DR pairing" - }, - "role": { - "readOnly": true, - "type": "string", - "description": "role of namespace in GEO DR - possible values 'Primary' or 'PrimaryNotReplicating' or 'Secondary'", - "enum": [ - "Primary", - "PrimaryNotReplicating", - "Secondary" - ], - "x-ms-enum": { - "name": "RoleDisasterRecovery", - "modelAsString": false - } - } - }, - "description": "Properties required to the Create Or Update Alias(Disaster Recovery configurations)" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Single item in List or Get Alias(Disaster Recovery configuration) operation" - }, - "ArmDisasterRecoveryListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ArmDisasterRecovery" - }, - "description": "List of Alias(Disaster Recovery configurations)" - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next set of results. Not empty if Value contains incomplete list of Alias(Disaster Recovery configuration)" - } - }, - "description": "The result of the List Alias(Disaster Recovery configuration) operation." - }, - "MigrationConfigProperties": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "properties": { - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "Provisioning state of Migration Configuration " - }, - "pendingReplicationOperationsCount": { - "readOnly": true, - "format": "int64", - "type": "integer", - "description": "Number of entities pending to be replicated." - }, - "targetNamespace": { - "type": "string", - "description": "Existing premium Namespace ARM Id name which has no entities, will be used for migration" - }, - "postMigrationName": { - "type": "string", - "description": "Name to access Standard Namespace after migration" - }, - "migrationState": { - "readOnly": true, - "type": "string", - "description": "State in which Standard to Premium Migration is, possible values : Unknown, Reverting, Completing, Initiating, Syncing, Active" - } - }, - "required": [ - "targetNamespace", - "postMigrationName" - ], - "description": "Properties required to the Create Migration Configuration" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Single item in List or Get Migration Config operation" - }, - "MigrationConfigListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/MigrationConfigProperties" - }, - "description": "List of Migration Configs" - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next set of results. Not empty if Value contains incomplete list of migrationConfigurations" - } - }, - "description": "The result of the List migrationConfigurations operation." - }, - "Subnet": { - "properties": { - "id": { - "type": "string", - "description": "Resource ID of Virtual Network Subnet" - } - }, - "required": [ - "id" - ], - "description": "Properties supplied for Subnet" - }, - "NWRuleSetIpRules": { - "x-ms-client-flatten": true, - "properties": { - "ipMask": { - "type": "string", - "description": "IP Mask" - }, - "action": { - "type": "string", - "description": "The IP Filter Action", - "enum": [ - "Allow" - ], - "x-ms-enum": { - "name": "NetworkRuleIPAction", - "modelAsString": true - }, - "default": "Allow" - } - }, - "description": "Description of NetWorkRuleSet - IpRules resource." - }, - "NWRuleSetVirtualNetworkRules": { - "x-ms-client-flatten": true, - "properties": { - "subnet": { - "$ref": "#/definitions/Subnet", - "description": "Subnet properties" - }, - "ignoreMissingVnetServiceEndpoint": { - "type": "boolean", - "description": "Value that indicates whether to ignore missing VNet Service Endpoint" - } - }, - "description": "Description of VirtualNetworkRules - NetworkRules resource." - }, - "NetworkRuleSet": { - "properties": { - "properties": { - "description": "NetworkRuleSet properties", - "x-ms-client-flatten": true, - "properties": { - "defaultAction": { - "type": "string", - "description": "Default Action for Network Rule Set", - "enum": [ - "Allow", - "Deny" - ], - "x-ms-enum": { - "name": "DefaultAction", - "modelAsString": true - } - }, - "virtualNetworkRules": { - "type": "array", - "items": { - "$ref": "#/definitions/NWRuleSetVirtualNetworkRules" - }, - "description": "List VirtualNetwork Rules" - }, - "ipRules": { - "type": "array", - "items": { - "$ref": "#/definitions/NWRuleSetIpRules" - }, - "description": "List of IpRules" - } - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Description of NetworkRuleSet resource." - }, - "NetworkRuleSetListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkRuleSet" - }, - "description": "Result of the List NetworkRuleSet operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of NetworkRuleSet." - } - }, - "description": "The response of the List NetworkRuleSet operation." - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API version." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method", - "description": "Name of the Resource group within the Azure subscription." - }, - "NamespaceNameParameter": { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "minLength": 6, - "maxLength": 50, - "x-ms-parameter-location": "method", - "description": "The namespace name" - }, - "AuthorizationRuleNameParameter": { - "name": "authorizationRuleName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 50, - "x-ms-parameter-location": "method", - "description": "The authorization rule name." - }, - "QueueNameParameter": { - "name": "queueName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "description": "The queue name." - }, - "TopicNameParameter": { - "name": "topicName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "description": "The topic name." - }, - "SubscriptionNameParameter": { - "name": "subscriptionName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 50, - "x-ms-parameter-location": "method", - "description": "The subscription name." - }, - "RuleNameParameter": { - "name": "ruleName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 50, - "x-ms-parameter-location": "method", - "description": "The rule name." - }, - "SkuNameParameter": { - "name": "sku", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 50, - "x-ms-parameter-location": "method", - "description": "The sku type." - }, - "AliasNameParameter": { - "name": "alias", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 50, - "x-ms-parameter-location": "method", - "description": "The Disaster Recovery configuration name" - }, - "ConfigNameParameter": { - "name": "configName", - "in": "path", - "description": "The configuration name. Should always be \"$default\".", - "required": true, - "type": "string", - "enum": [ - "$default" - ], - "x-ms-enum": { - "name": "MigrationConfigurationName", - "modelAsString": true - }, - "x-ms-parameter-location": "method" - }, - "SkipParameter": { - "name": "$skip", - "description": "Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.", - "in": "query", - "required": false, - "type": "integer", - "minimum": 0, - "maximum": 1000, - "x-ms-parameter-location": "method" - }, - "TopParameter": { - "name": "$top", - "description": "May be used to limit the number of results to the most recent N usageDetails.", - "in": "query", - "required": false, - "type": "integer", - "minimum": 1, - "maximum": 1000, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/sku.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/sku.json new file mode 100644 index 000000000000..441383120485 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/sku.json @@ -0,0 +1,145 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2017-04-01" + }, + "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}/providers/Microsoft.ServiceBus/sku/{sku}/regions": { + "get": { + "tags": [ + "Regions" + ], + "operationId": "Regions_ListBySku", + "x-ms-examples": { + "RegionsListBySku": { + "$ref": "./examples/SkuRegions/SkuRegions.json" + } + }, + "description": "Gets the available Regions for a given sku", + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SkuNameParameter" + } + ], + "responses": { + "200": { + "description": "Regions successfully returned.", + "schema": { + "$ref": "#/definitions/PremiumMessagingRegionsListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ResourceNamespacePatch": { + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "The Resource definition." + }, + "PremiumMessagingRegions": { + "properties": { + "properties": { + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "Region code" + }, + "fullName": { + "readOnly": true, + "type": "string", + "description": "Full name of the region" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceNamespacePatch" + } + ], + "description": "Premium Messaging Region" + }, + "PremiumMessagingRegionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PremiumMessagingRegions" + }, + "description": "Result of the List PremiumMessagingRegions type." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next set of results. Not empty if Value contains incomplete list of PremiumMessagingRegions." + } + }, + "description": "The response of the List PremiumMessagingRegions operation." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/subscriptions.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/subscriptions.json new file mode 100644 index 000000000000..380bb3d8806a --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/subscriptions.json @@ -0,0 +1,374 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2017-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions": { + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_ListByTopic", + "x-ms-examples": { + "SubscriptionListByTopic": { + "$ref": "./examples/Subscriptions/SBSubscriptionListByTopic.json" + } + }, + "description": "List all the subscriptions under a specified topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639400.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved list of subscriptions.", + "schema": { + "$ref": "#/definitions/SBSubscriptionListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}": { + "put": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_CreateOrUpdate", + "x-ms-examples": { + "SubscriptionCreate": { + "$ref": "./examples/Subscriptions/SBSubscriptionCreate.json" + } + }, + "description": "Creates a topic subscription.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639385.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBSubscription" + }, + "description": "Parameters supplied to create a subscription resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Subscription create request accepted.", + "schema": { + "$ref": "#/definitions/SBSubscription" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_Delete", + "x-ms-examples": { + "SubscriptionDelete": { + "$ref": "./examples/Subscriptions/SBSubscriptionDelete.json" + } + }, + "description": "Deletes a subscription from the specified topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639381.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Subscription successfully deleted." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_Get", + "x-ms-examples": { + "SubscriptionGet": { + "$ref": "./examples/Subscriptions/SBSubscriptionGet.json" + } + }, + "description": "Returns a subscription description for the specified topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639402.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved subscription description.", + "schema": { + "$ref": "#/definitions/SBSubscription" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SBSubscriptionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBSubscription" + }, + "description": "Result of the List Subscriptions operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of subscriptions." + } + }, + "description": "The response to the List Subscriptions operation." + }, + "SBSubscription": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBSubscriptionProperties", + "description": "Properties of subscriptions resource." + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Description of subscription resource." + }, + "SBSubscriptionProperties": { + "properties": { + "messageCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of messages." + }, + "createdAt": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Exact time the message was created." + }, + "accessedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "Last time there was a receive request to this subscription." + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the message was updated." + }, + "countDetails": { + "readOnly": true, + "$ref": "../../../common/v1/definitions.json#/definitions/MessageCountDetails", + "description": "Message count details" + }, + "lockDuration": { + "format": "duration", + "type": "string", + "description": "ISO 8061 lock duration timespan for the subscription. The default value is 1 minute." + }, + "requiresSession": { + "type": "boolean", + "description": "Value indicating if a subscription supports the concept of sessions." + }, + "defaultMessageTimeToLive": { + "format": "duration", + "type": "string", + "description": "ISO 8061 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." + }, + "deadLetteringOnFilterEvaluationExceptions": { + "type": "boolean", + "description": "Value that indicates whether a subscription has dead letter support on filter evaluation exceptions." + }, + "deadLetteringOnMessageExpiration": { + "type": "boolean", + "description": "Value that indicates whether a subscription has dead letter support when a message expires." + }, + "duplicateDetectionHistoryTimeWindow": { + "format": "duration", + "type": "string", + "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes." + }, + "maxDeliveryCount": { + "format": "int32", + "type": "integer", + "description": "Number of maximum deliveries." + }, + "status": { + "$ref": "../../../common/v1/definitions.json#/definitions/EntityStatus", + "description": "Enumerates the possible values for the status of a messaging entity." + }, + "enableBatchedOperations": { + "type": "boolean", + "description": "Value that indicates whether server-side batched operations are enabled." + }, + "autoDeleteOnIdle": { + "format": "duration", + "type": "string", + "description": "ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes." + }, + "forwardTo": { + "type": "string", + "description": "Queue/Topic name to forward the messages" + }, + "forwardDeadLetteredMessagesTo": { + "type": "string", + "description": "Queue/Topic name to forward the Dead Letter message" + } + }, + "description": "Description of Subscription Resource." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/topics.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/topics.json new file mode 100644 index 000000000000..ed15010fd198 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/topics.json @@ -0,0 +1,359 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceBusManagementClient", + "description": "Azure Service Bus client", + "version": "2017-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics": { + "get": { + "tags": [ + "Topics" + ], + "operationId": "Topics_ListByNamespace", + "x-ms-examples": { + "TopicGet": { + "$ref": "./examples/Topics/SBTopicListByNameSpace.json" + } + }, + "description": "Gets all the topics in a namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639388.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SkipParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved list of topics.", + "schema": { + "$ref": "#/definitions/SBTopicListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}": { + "put": { + "tags": [ + "Topics" + ], + "operationId": "Topics_CreateOrUpdate", + "x-ms-examples": { + "TopicCreate": { + "$ref": "./examples/Topics/SBTopicCreate.json" + } + }, + "description": "Creates a topic in the specified namespace.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639409.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBTopic" + }, + "description": "Parameters supplied to create a topic resource." + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic successfully created.", + "schema": { + "$ref": "#/definitions/SBTopic" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Topics" + ], + "operationId": "Topics_Delete", + "x-ms-examples": { + "TopicDelete": { + "$ref": "./examples/Topics/SBTopicDelete.json" + } + }, + "description": "Deletes a topic from the specified namespace and resource group.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639404.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic successfully deleted." + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Topics" + ], + "operationId": "Topics_Get", + "x-ms-examples": { + "TopicGet": { + "$ref": "./examples/Topics/SBTopicGet.json" + } + }, + "description": "Returns a description for the specified topic.", + "externalDocs": { + "url": "https://msdn.microsoft.com/en-us/library/azure/mt639399.aspx" + }, + "parameters": [ + { + "$ref": "../../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/NamespaceNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/TopicNameParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Topic description successfully retrieved.", + "schema": { + "$ref": "#/definitions/SBTopic" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SBTopicListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SBTopic" + }, + "description": "Result of the List Topics operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of topics." + } + }, + "description": "The response to the List Topics operation." + }, + "SBTopic": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SBTopicProperties", + "description": "Properties of topic resource." + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/definitions.json#/definitions/Resource" + } + ], + "description": "Description of topic resource." + }, + "SBTopicProperties": { + "properties": { + "sizeInBytes": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Size of the topic, in bytes." + }, + "createdAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "Exact time the message was created." + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the message was updated." + }, + "accessedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "Last time the message was sent, or a request was received, for this topic." + }, + "subscriptionCount": { + "readOnly": true, + "format": "int32", + "type": "integer", + "description": "Number of subscriptions." + }, + "countDetails": { + "readOnly": true, + "$ref": "../../../common/v1/definitions.json#/definitions/MessageCountDetails", + "description": "Message count details" + }, + "defaultMessageTimeToLive": { + "format": "duration", + "type": "string", + "description": "ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." + }, + "maxSizeInMegabytes": { + "format": "int32", + "type": "integer", + "description": "Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024." + }, + "requiresDuplicateDetection": { + "type": "boolean", + "description": "Value indicating if this topic requires duplicate detection." + }, + "duplicateDetectionHistoryTimeWindow": { + "format": "duration", + "type": "string", + "description": "ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes." + }, + "enableBatchedOperations": { + "type": "boolean", + "description": "Value that indicates whether server-side batched operations are enabled." + }, + "status": { + "$ref": "../../../common/v1/definitions.json#/definitions/EntityStatus", + "description": "Enumerates the possible values for the status of a messaging entity." + }, + "supportOrdering": { + "type": "boolean", + "description": "Value that indicates whether the topic supports ordering." + }, + "autoDeleteOnIdle": { + "format": "duration", + "type": "string", + "description": "ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes." + }, + "enablePartitioning": { + "type": "boolean", + "description": "Value that indicates whether the topic to be partitioned across multiple message brokers is enabled." + }, + "enableExpress": { + "type": "boolean", + "description": "Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage." + } + }, + "description": "The Topic Properties definition." + } + }, + "parameters": {} +} diff --git a/specification/servicebus/resource-manager/common/v1/definitions.json b/specification/servicebus/resource-manager/common/v1/definitions.json new file mode 100644 index 000000000000..1e9255ffda10 --- /dev/null +++ b/specification/servicebus/resource-manager/common/v1/definitions.json @@ -0,0 +1,359 @@ +{ + "swagger": "2.0", + "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" + } + } + }, + "info": { + "version": "1.0", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "TrackedResource": { + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The Geo-location where the resource lives" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "location" + ], + "description": "The Resource definition." + }, + "Resource": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + } + }, + "x-ms-azure-resource": true, + "description": "The Resource definition for other than namespace." + }, + "EntityStatus": { + "type": "string", + "enum": [ + "Active", + "Disabled", + "Restoring", + "SendDisabled", + "ReceiveDisabled", + "Creating", + "Deleting", + "Renaming", + "Unknown" + ], + "x-ms-enum": { + "name": "EntityStatus", + "modelAsString": false + }, + "description": "Entity status." + }, + "MessageCountDetails": { + "type": "object", + "properties": { + "activeMessageCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of active messages in the queue, topic, or subscription." + }, + "deadLetterMessageCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of messages that are dead lettered." + }, + "scheduledMessageCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of scheduled messages." + }, + "transferMessageCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of messages transferred to another queue, topic, or subscription." + }, + "transferDeadLetterMessageCount": { + "readOnly": true, + "format": "int64", + "type": "integer", + "description": "Number of messages transferred into dead letters." + } + }, + "description": "Message Count Details." + }, + "ErrorResponse": { + "properties": { + "error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The error code." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "The error message." + }, + "target": { + "readOnly": true, + "type": "string", + "description": "The error target." + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorResponse" + }, + "description": "The error details." + }, + "additionalInfo": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorAdditionalInfo" + }, + "description": "The error additional info." + } + } + } + }, + "description": "The resource management error response." + }, + "ErrorAdditionalInfo": { + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The additional info type." + }, + "info": { + "readOnly": true, + "type": "object", + "description": "The additional info." + } + }, + "description": "The resource management error additional info." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of the Resource group within the Azure subscription." + }, + "NamespaceNameParameter": { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 6, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The namespace name" + }, + "PrivateEndpointConnectionNameParameter": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The PrivateEndpointConnection name" + }, + "AuthorizationRuleNameParameter": { + "name": "authorizationRuleName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The authorization rule name." + }, + "QueueNameParameter": { + "name": "queueName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "description": "The queue name." + }, + "TopicNameParameter": { + "name": "topicName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "description": "The topic name." + }, + "AliasNameParameter": { + "name": "alias", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The Disaster Recovery configuration name" + }, + "SubscriptionNameParameter": { + "name": "subscriptionName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The subscription name." + }, + "ConfigNameParameter": { + "name": "configName", + "in": "path", + "description": "The configuration name. Should always be \"$default\".", + "required": true, + "type": "string", + "enum": [ + "$default" + ], + "x-ms-enum": { + "name": "MigrationConfigurationName", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + }, + "SkipParameter": { + "name": "$skip", + "description": "Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 0, + "maximum": 1000, + "x-ms-parameter-location": "method" + }, + "TopParameter": { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000, + "x-ms-parameter-location": "method" + }, + "RuleNameParameter": { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The rule name." + }, + "SkuNameParameter": { + "name": "sku", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The sku type." + }, + "IpFilterRuleNameParameter": { + "name": "ipFilterRuleName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "description": "The IP Filter Rule name." + }, + "VirtualNetworkRuleNameParameter": { + "name": "virtualNetworkRuleName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "description": "The Virtual Network Rule name." + } + } +} diff --git a/specification/servicebus/resource-manager/readme.azureresourceschema.md b/specification/servicebus/resource-manager/readme.azureresourceschema.md index 3bd281d594f7..72a1c9f004ef 100644 --- a/specification/servicebus/resource-manager/readme.azureresourceschema.md +++ b/specification/servicebus/resource-manager/readme.azureresourceschema.md @@ -21,7 +21,11 @@ output-folder: $(azureresourceschema-folder)/schemas # all the input files in this apiVersion input-file: - - Microsoft.ServiceBus/preview/2018-01-01-preview/servicebus-preview.json + - Microsoft.ServiceBus/preview/2018-01-01-preview/IPFilterRules-preview.json + - Microsoft.ServiceBus/preview/2018-01-01-preview/namespace-preview.json + - Microsoft.ServiceBus/preview/2018-01-01-preview/NetworkRuleSet-preview.json + - Microsoft.ServiceBus/preview/2018-01-01-preview/VirtualNetworkRules-preview.json + - Microsoft.ServiceBus/preview/2018-01-01-preview/operationlist-preview.json ``` @@ -32,7 +36,21 @@ output-folder: $(azureresourceschema-folder)/schemas # all the input files in this apiVersion input-file: - - Microsoft.ServiceBus/stable/2017-04-01/servicebus.json + - Microsoft.ServiceBus/stable/2017-04-01/AuthorizationRules.json + - Microsoft.ServiceBus/stable/2017-04-01/CheckNameAvailability.json + - Microsoft.ServiceBus/stable/2017-04-01/DisasterRecoveryConfig.json + - Microsoft.ServiceBus/stable/2017-04-01/eventhubs.json + - Microsoft.ServiceBus/stable/2017-04-01/migrate.json + - Microsoft.ServiceBus/stable/2017-04-01/migrationconfigs.json + - Microsoft.ServiceBus/stable/2017-04-01/namespaces.json + - Microsoft.ServiceBus/stable/2017-04-01/networksets.json + - Microsoft.ServiceBus/stable/2017-04-01/operations.json + - Microsoft.ServiceBus/stable/2017-04-01/PremiumMessagingRegions.json + - Microsoft.ServiceBus/stable/2017-04-01/Queue.json + - Microsoft.ServiceBus/stable/2017-04-01/Rules.json + - Microsoft.ServiceBus/stable/2017-04-01/sku.json + - Microsoft.ServiceBus/stable/2017-04-01/subscriptions.json + - Microsoft.ServiceBus/stable/2017-04-01/topics.json ``` diff --git a/specification/servicebus/resource-manager/readme.md b/specification/servicebus/resource-manager/readme.md index 0312323c7de2..83e7741ca82d 100644 --- a/specification/servicebus/resource-manager/readme.md +++ b/specification/servicebus/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the ServiceBus API. ``` yaml openapi-type: arm -tag: package-2017-04 +tag: package-2018-01-preview ``` ### Tag: package-2018-01-preview @@ -35,7 +35,23 @@ These settings apply only when `--tag=package-2018-01-preview` is specified on t ``` yaml $(tag) == 'package-2018-01-preview' input-file: -- Microsoft.ServiceBus/preview/2018-01-01-preview/servicebus-preview.json +- Microsoft.ServiceBus/preview/2018-01-01-preview/IPFilterRules-preview.json +- Microsoft.ServiceBus/preview/2018-01-01-preview/namespace-preview.json +- Microsoft.ServiceBus/preview/2018-01-01-preview/NetworkRuleSet-preview.json +- Microsoft.ServiceBus/preview/2018-01-01-preview/VirtualNetworkRules-preview.json +- Microsoft.ServiceBus/preview/2018-01-01-preview/operationlist-preview.json +- Microsoft.ServiceBus/stable/2017-04-01/AuthorizationRules.json +- Microsoft.ServiceBus/stable/2017-04-01/CheckNameAvailability.json +- Microsoft.ServiceBus/stable/2017-04-01/DisasterRecoveryConfig.json +- Microsoft.ServiceBus/stable/2017-04-01/eventhubs.json +- Microsoft.ServiceBus/stable/2017-04-01/migrate.json +- Microsoft.ServiceBus/stable/2017-04-01/migrationconfigs.json +- Microsoft.ServiceBus/stable/2017-04-01/PremiumMessagingRegions.json +- Microsoft.ServiceBus/stable/2017-04-01/Queue.json +- Microsoft.ServiceBus/stable/2017-04-01/sku.json +- Microsoft.ServiceBus/stable/2017-04-01/subscriptions.json +- Microsoft.ServiceBus/stable/2017-04-01/topics.json +- Microsoft.ServiceBus/stable/2017-04-01/Rules.json ``` ### Tag: package-2017-04 @@ -45,7 +61,21 @@ These settings apply only when `--tag=package-2017-04` is specified on the comma ``` yaml $(tag) == 'package-2017-04' input-file: -- Microsoft.ServiceBus/stable/2017-04-01/servicebus.json +- Microsoft.ServiceBus/stable/2017-04-01/AuthorizationRules.json +- Microsoft.ServiceBus/stable/2017-04-01/CheckNameAvailability.json +- Microsoft.ServiceBus/stable/2017-04-01/DisasterRecoveryConfig.json +- Microsoft.ServiceBus/stable/2017-04-01/eventhubs.json +- Microsoft.ServiceBus/stable/2017-04-01/migrate.json +- Microsoft.ServiceBus/stable/2017-04-01/migrationconfigs.json +- Microsoft.ServiceBus/stable/2017-04-01/namespaces.json +- Microsoft.ServiceBus/stable/2017-04-01/networksets.json +- Microsoft.ServiceBus/stable/2017-04-01/operations.json +- Microsoft.ServiceBus/stable/2017-04-01/PremiumMessagingRegions.json +- Microsoft.ServiceBus/stable/2017-04-01/Queue.json +- Microsoft.ServiceBus/stable/2017-04-01/Rules.json +- Microsoft.ServiceBus/stable/2017-04-01/sku.json +- Microsoft.ServiceBus/stable/2017-04-01/subscriptions.json +- Microsoft.ServiceBus/stable/2017-04-01/topics.json ``` Important notes: @@ -154,10 +184,26 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: - - $(this-folder)/Microsoft.ServiceBus/preview/2018-01-01-preview/servicebus-preview.json - - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/servicebus.json - $(this-folder)/Microsoft.ServiceBus/stable/2015-08-01/servicebus.json - + - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/AuthorizationRules.json + - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/CheckNameAvailability.json + - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/DisasterRecoveryConfig.json + - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/eventhubs.json + - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/migrate.json + - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/migrationconfigs.json + - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/namespaces.json + - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/networksets.json + - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/operations.json + - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/PremiumMessagingRegions.json + - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/Queue.json + - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/Rules.json + - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/sku.json + - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/subscriptions.json + - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/topics.json + - $(this-folder)/Microsoft.ServiceBus/preview/2018-01-01-preview/IPFilterRules-preview.json + - $(this-folder)/Microsoft.ServiceBus/preview/2018-01-01-preview/namespace-preview.json + - $(this-folder)/Microsoft.ServiceBus/preview/2018-01-01-preview/NetworkRuleSet-preview.json + - $(this-folder)/Microsoft.ServiceBus/preview/2018-01-01-preview/VirtualNetworkRules-preview.json ``` If there are files that should not be in the `all-api-versions` set, From 8fee11f5dd30e228a850ee25a2f3368dc1671b53 Mon Sep 17 00:00:00 2001 From: ramparab <49212302+ramparab@users.noreply.github.com> Date: Thu, 10 Sep 2020 09:50:43 -0700 Subject: [PATCH 032/164] FR v2.1-preview.1 update (#10747) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Bringing FRv2.0-preview version forward. * Adding Model Compose feature * Adding Model Copy feature * Adding PreBuilt: Business card feature * Fix swagger version. * Add CheckBox feature (option-A) * Add CheckBox feature (option-B) * Initial commit; Bringing things forward from v2.0 * Minor fixes in compose contract * Add suggested model name changes for supervised * Incorporating final changes from v2.0-preview * Incorporating ModelName feature * Update for model compose * Incorporating selectionMark feature. * FRv2.1 Feature updates (#13) List of changes: ----------------- * Bringing Final swagger for FRv2.0-preview version forward. * Adding Model Compose feature * Adding PreBuilt: Business card feature * Add SelectionMark (aka CheckBox) feature * ModelName Support * Fix swagger version * FR FE changes (#15) * Remove quotes from data queries in RI apis (#9323) * [DataFactory]Store settings should be added for Delete and GetMetadata (#9208) * [DataFactory]Store settings should be added for Delete and GetMetadata Activity * Add format settings for GetMetadata * [Hub Generated] Review request for Microsoft.ChangeAnalysis to add version preview/2020-04-01-preview (#8981) * New Readme Config File * New Go Language Readme Config File * New Typescript Language Readme Config File * New Python Language Readme Config File * New C# Language Readme Config File * New Ruby Language Readme Config File * New Swagger Spec File * New Swagger Example Spec File * add swagger spec second time * trying to fix violations #1 * adding descriptions and schema tag for default error * removing required location element from proxy resource. * adding prettifier fixed * update 3 * update 4 * update 5 * update 6 * update 7 * update 8 * update 9 * update 10 * update 11 * update 12 * update 13 * update 14 * update 15 * update 16 * update 17 * update 18 * Adds suppression to readme * updating comments of few models * changing description of few elements * prettier run: Co-authored-by: Alex Dubinkov * regenerated all-api-versions * Fix readme.go.md for some sql service (#9348) * Update network (#9349) * Add multiapi section (#9347) * Dataplane swagger for tables (#8151) * adding swagger for tables dataplane * updating produces/consumes, adding format parameter and adding DataServiceVersion header * update swagger so that query parameters do not appear in x-ms-paths * add new custom words, fix incorrect api version * making suggested changes to continuation header, response status codes * Updates to tables spec * Fixed indentation * Removed storage references * Grammar * Improved match condition description * Remove format statements * Removed excess tags * Fix extra commas * Added missing example * Updated Delete example * Run prettier * Removed duplicate API version * Fixed insert response * Removed 2018 readme tag * Remove storage name * Remove multi-api reference Co-authored-by: Sam Hurd Co-authored-by: annatisch * regenerated all-api-versions * Datr m (#9332) * update readme docs * add nullables * add autogen * location required * add require to all * add requires * prettier * track resoruce ref and require for properties * remove # * fix # resoruce * pr comments * fix ruby * go fix * azure_mgmt_desktop_virtualization * rekickoff tests * regenerated all-api-versions * Allow empty access policies array in HealthcareApis (#9326) * Allow empty access polies array in HealthcareApis. * accessPolicies property can be omitted * [CDN] Add API version 2020-04-15 (#9242) * regenerated all-api-versions * Update readme.md (#9384) * Update readme.md Adding stable version to not break existing APIs * Added examples * fix example * prettier fix * regenerated all-api-versions * [MixedReality] Version Iteration for new Releases (#9351) * Version Iteration for new Releases (#8848) * Version Iteration for new Releases There are going to be 2 significant releases: 1. Public Preview of Remote Rendering in April 6th 2. GA of Spatial Anchors in May * Referring new swagger files in readme.md * Specifying default package version as 2020-05-01 * Fix MV * Fix MV (#9397) Fix MV in Patch examples Co-authored-by: Xiangyu Luo Co-authored-by: Lei Ni * fix network (#9369) * fix network * duplicated publicipprefix * fixed example in 2018-01-01 * final updates * missing examples * regenerated all-api-versions * SQLDB - update LicenseType description (#9001) * SDK support for Table and Queue Storage Services (#9259) * Adding table spec, without examples * Adding queue swagger, also updating comments for table * Updated the models to include ARM fields, completed, no examples * Added list table and queue services spec * Adding table CRUD examples * Adding Queue CRUD examples * Validation complete, TablName changed to camelCase * Modified comment * Spell correction * changing order in readme.md * Changed the object name from Queue to StorageQueue, as sdk code gen throws name conflict error with Collections.Queue * Resolve prettier check errors * Change URI param to be camel case * updated default error response schema * Change Default error response model schema * Added x-ms-nextLink * regenerated all-api-versions * [ACR] add regionEndpointEnabled to replication properties and replicationUpdateParameters (#8840) * add regionendpointenabled to replication properties and replicationupdateparameters * fix property placement error * Update spec. with update properties * Update descriptions Co-authored-by: Tosin Adewale * update triage label (#9396) * validate blockchain cli codegen (#9089) * validate blockchain cli codegen * use strong password with length>=12 Co-authored-by: Changlong Liu * feat: add subscription 2019 10 01 preview (#9388) * [Hub Generated] Review request for Microsoft.CostManagement to add version stable/2019-11-01 (#9288) * adding the views api to the 2019-11-01 version * Fix api version value * adding private view list example document * Fix enum conflict * fix Granularity enum type * Add api version of go SDK for imagebuilder (#9408) * Update PR template (#9371) * Update PR template * Add FAQ link * add Microsoft.AVS 2019-08-09-preview API spec (#9307) * cp -r vmwarevirtustream vmware * rebrand * add sku to PrivateCloud * add SSL thumbprints * Fix description typo (#5) * lists return value[] * suppress R3020 * fix suppress * add Locations_ prefix Co-authored-by: jspearman3 * regenerated all-api-versions * Add 2020-04-01 API specification for Microsoft.Peering (#9361) * Remove readonly flag from microsoftSessionAddress properties in BgpSession; add an example for IxRs directPeeringType * Add 2020-04-01 API specification for Microsoft.Peering * Fix subId * Fix static validation issues * Fix GetPeeringReceivedRoutes example * Fix PeeringServiceSku * Add RPKI to custom-words * Update readme to include package-2020-04-01 * Fix input file path in package-2020-04-01 * Fix ErrorResponse data model Co-authored-by: Praneeth Sanapathi * Move added client name IdentityUserAssignedIdentitiesValue into an inner scope (#9363) * Bug fixes: skip url encoding for ScopeParameter; add client name for userAssignedIdentities. * Pretty check fix. * Move added client name into additionalProperties of userAssignedIdentities. * Change operationID for table and queue, update the name of an example (#9410) * update version of rest-api-specs-scripts in PPE (#9420) Co-authored-by: Jianye Xi * adding new properties (#9404) * Pipeline devops (#9374) * netapp trenton pipeline * logic pipeline test * Revert "logic pipeline test" This reverts commit ad9f1f00d99379de1e461fcbb6c803a491b5bd29. * devops pipeline test * Update readme.md Co-authored-by: root * typo (#9210) * IoT Edge in Central APIs initial (#9248) * IoT Edge in Central APIs initial * making recommended fixes * Moved storage private link related models into common types (#8935) * Moved private link related model into common types * Fix path to common types.json * Fix parameter reference * fix prettier issue * Resovled the conflict and moved PrivateEndpointConnectionListResult into common and updated reference * EventGrid: Update 2020-04-01-preview swagger to include new properties per customer's feedback (#9402) * Update 2020-04-01-preview swagger to include new properties per customer's feedback * fix spelling * add readonly flag for readiness state * fix prettier Co-authored-by: Ashraf Hamad * [Hub Generated] Review request for Microsoft.VirtualMachineImages to add version stable/2020-02-14 (#9411) * [Azure Stack] Updates to Azs.Storage.Admin spec (#8959) * commit 1ef81911c39d8f618bf6ec097223ff5e8961b3cb Author: Yuxing Zhou Date: Thu Feb 6 09:13:52 2020 +0800 [Azure Stack] Update storage admin specs for new generation with autorest-beta (#8306) * Update storage admin specs for new generation with autorest-beta * fix code style commit 9e551f0eab4057d4c2f54c333c7aa2a1a564c125 Author: bganapa Date: Tue Nov 12 11:44:22 2019 -0800 Reset to Stackadmin2 (#7766) * Fix resourcegroup case * Fix old version * Address PR feedback * Customerprovider pipeline2[DONOT MERGE] (#9428) * customer provider * add flag * Add DeletedWorkspaces API (#9401) * Add force flag (#9417) * Add force flag * Fix * [Storage] Adding support for listing soft deleted blob containers (#9435) * [Storage] Adding support for listing soft deleted blob containers . Adding swagger support for listing soft deleted blob containers . Added examples as well * Update blob.json * Update DeletedBlobContainersList.json Prettier check failing * Create a New Default Tag for Code Generation (#9440) Include both Spatial Anchors and Remote Rendering in the same package. * regenerated all-api-versions * fastfix_tfpr (#9439) Co-authored-by: Xiaoxu Qi * Adding 200 response in CreateOrUpdate api (#9228) * Adding 200 response in CreateOrUpdate api * Update example * Empty commit to trigger build * Updated README tag version (#9240) * Updated README tag version * Moved provisioning state under properties, added operations API * fixed json syntax * Added operations list * Added Display * Update bookmark relations API (#8495) * Update bookmark relations API * fix pr comments * fix invalid examples failing model validation * Fixed invalid reference (#9449) * [Hub Generated] Review request for Microsoft.VirtualMachineImages to add version stable/2020-02-14 (#9451) * SKU api filter takes location only. (#9328) * change to test logic for az (#9443) * [Hub Generated] Review request for Microsoft.Consumption to add version stable/2019-10-01 (#9453) * Adding ReservationRecommendationDetails API Adding ReservationRecommendationDetails API * fixing semantic errors * test fix * test * updating property lookbackUnitType * prettified * prettified examples * Updating scope parameter * updating sample * adding 204 status code * updating examples with 204 * updating samples * updating 204 * prettify * prettifying * Update swagger specs for Managed Instance (#8182) - Add optional parameter maintenance configuration id. * luis authoring api updates for nested children and required features (#9405) * luis authoring api updates for nested children and required features * fix examples * change required field "enableNestedChildren" to optional * add default value for enableNestedChildren * remove deprecated permissions API * [Hub Generated] Review request for Microsoft.ResourceGraph to add version stable/2019-04-01 (#9215) * Fixing comments * update oprationId * update oprationId * Revert operation change * test commit * Revert "test commit" This reverts commit 1fb003317a14420f912bf8a625570224d332b227. * cost-management-for-cli-extensions (#9392) * add 2019-10-preview tag for luis (#9406) * upgrade pipeline scripts version to 0.8.0 (#9457) Co-authored-by: Jianye Xi * Make CDN privateEndpointStatus modeled as string (#9433) * [Cognitive Service Computer Vision] Create CV v3.0 API version swagger (#8734) * [Cognitive Service Computer Vision] Create CV v3.0 API version swagger * Complete Compter vision's readme file to fix build issue * Correct CV v3.0 examples to match swagger schema * Run Prettier script on new examples Co-authored-by: bob * regenerated all-api-versions * added app service schema (#9310) * added app service schema * added ref to new file in readme.md * prettier * JSON Lint * created classes for app event type detail * remove delete and create event data * fix format * ran prettier * fix async status and remove description from each ref * remove x-ms-enum for some * fix x-ms-enum * remove x-ms-enum from status * add x-ms-enum to all enum and add model as extensible * typo to model as string * move model as string under x-ms-enum * remove last empty line: * add back last empty line Co-authored-by: Elle Tojaroon * Added new SecureScore API to Microsoft.Security (#8235) * Set theme jekyll-theme-midnight * Adding new APIs for secure score * Updated files * updated md file * Working on 1 path at a time * Fix type to ref * more fixes * removed ref type * AutoRest fixes * more fixes * Internal PR * fixed some static validation issues * Fixed some more auto-rest issues * Fixed example + organizing readonly attribute * Run prettier on files * Changed initiativeId to policySetDefinitionId in the sample files * Changed assessmentsMetadata to assessmentsDefinition * Added scope in defintions example and adjust enum value of BuiltIn * Added missing fields and align examples * Renamed fields in example files * Changed return value * Added control definitions per subscription scope * Added definition property (optional, in case of $expand) * prettier updated files * prettier again ... * PR comments * Renamed enum * Fixed some errors * Remove "secureScoreName" parameter from example * Changed operationId from GetSecureScores_Single to SecureScores_Get * prettifying the code * Updated based on PR comments * Fix casing issues in example files name * Fixing sample files and remove some enum options * Updated readme.md file * Remove trailing whitespace * Update specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json Co-Authored-By: Chen Lahav * Update specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json Co-Authored-By: Chen Lahav * Update specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json Co-Authored-By: Chen Lahav * Update specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json Co-Authored-By: Chen Lahav * Update specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json Co-Authored-By: Chen Lahav * Update specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/GetSecureScoresSingle_example.json Co-Authored-By: Chen Lahav * Fixed PR comments * Fix definitions renaming * Fix examples * Trying to fix model validation * Changed example type * Updating from master (Resolving conflicts) * Converting all EOL to CRLF + remove trailing blanks * Removed Scope paths, updated examples * Replaced scope with sub id in example * updated secureScoresControls id in examples * example files ids and type fixes Co-authored-by: Gideon Romm Co-authored-by: Chen Lahav * Fix operation Ids for Metadata, so they show up correctly in the REST… (#9414) * Fix operation Ids for Metadata, so they show up correctly in the REST docs toc. * Fix operation id for AvailableServiceTiers * Separate Python readme (#9416) * Updated default tag to latest stable version. (#9085) * Updated default tag to newest stable version. * Modified swagger to include next link property and azure resource properties. * Addressed CI errors. Co-authored-by: Jacob Hill * add time trigger for PR author (#9468) * add time trigger for PR author * add reviewed-changesRequired * api-version 2020-05 of mixedreality for go SDK (#9474) * api-version 2020-05 * fix * [Datafactory] Enable Type Conversion in Copy Activity (#9471) Co-authored-by: David Zhao * kubernetes - fixed client name (#9421) * fixed client name * updated name * Create swagger for a new API: AutoDismissAlertsRules (#7292) * Create swagger for a new API: AutoDismissAlertsRules * Add AutoDismiss rule name parameter to alerts API. Fix some descriptions. * Remove CompromisedEntity from the examples * update readmeFile * Renaming auto dismiss to suppression * Update PutAlertsSuppressionRule_example.json * Fixing example - sending read-only property error * Removing read-only fields from examples/AlertsSuppressionRules/PutAlertsSuppressionRule_example.json * ARM CR: changing `UTC` to `Utc` + updating expirationDateUtc description * Adding "ScopeElement" for "allOf" element + fixing examples Co-authored-by: Nitsan Bracha Co-authored-by: Nitsan Bracha * regenerated all-api-versions * update scripts version in PPE pipeline (#9494) Co-authored-by: Jianye Xi * pricing tier swagger (#9094) * pricing tier swagger * remove readonly in sku model * update appplatform json and example * update list sku * revert to data action * update list skus * add resource sku definition * revert sqlparallel read settings (#9497) * add sharepointonlinelist connector * support parallel read of sql sources * revert sqlparallel settings * [CosmosDB] Introducing the apiVersion 04-01-2020 (#9302) * Adding notebooks in 1212 and 0301 * Changes to include EnableFreeTier property in DatabaseAccount * Ran Prettier * Fixed model failures * Revert "Fixed model failures" This reverts commit ecef06e8b9c7b0ad3c36f5fce84bd72ebee1a141. * Revert "Ran Prettier" This reverts commit 9d2cc52313bf9f45b172f6769d57d3be60ea1d6d. * Revert "Changes to include EnableFreeTier property in DatabaseAccount" This reverts commit 62f58ab6c666d8aad4bbecb94f41e3a80c49289a. * Created apiVersion 2020-05-04 with EnableFreeTier property in DatabaseAccount * Replace IpRangeFilter by IpRules * Revert "Replace IpRangeFilter by IpRules" This reverts commit ddb21350fd4cd927fb4333617f19e85cfc46b5f9. * Fixed EnableFreeTier changes * Replace IpRangeFilter by IpRules * Fixes in model * Revert "Fixes in model" This reverts commit 97a6a0b62c6752cb6f75529e068e9c2c70618c06. * correcting examples * fix in ListByResourcegroup * renaming * changing ipAddressOrRange * fix * fix for model * fix for model * fixing * Adding apiProperties * adding swagger-to-sdk for python * introduces AutoscaleSettings * removing .net from swagger-to-sdk to avoid failing CI * added analyticalStorage related changes * changes in models * addressed comments * correcting IpAdressOrRange * nit * Making OptionsResource object readonly * temporarily disabling js in swagger to sdk * Revert "temporarily disabling js in swagger to sdk" This reverts commit 5d68004a50e0d5e2c41ac19ccc1243893053261a. Co-authored-by: Meha Kaushik * regenerated all-api-versions * add optional properties for saved search (#9498) * add optional properties * Update SavedSearches.json * Update SavedSearches.json * Support Infrastructure Encryption - secondary layer of encryption at … (#8773) * Support Infrastructure Encryption - secondary layer of encryption at REST for accounts. Add a boolean property to Microsoft.Storage/storageAccounts resource under encryption attributes to opt-in for a secondary layer of encryption for data at rest. * requireInfrastructureEncryption is optional and defaults to null. * PPE enable avocado0.6.4 (#9493) * add x-ms-api-version for operations that api-version is required as parameter for sdk (#9441) * Merge Mixed Reality Changes to Master (#9502) * Version Iteration for new Releases (#8848) * Version Iteration for new Releases There are going to be 2 significant releases: 1. Public Preview of Remote Rendering in April 6th 2. GA of Spatial Anchors in May * Referring new swagger files in readme.md * Specifying default package version as 2020-05-01 * Fix MV * Fix MV (#9397) Fix MV in Patch examples * Add MSI property to Remote Rendering Account (#9476) * Add MSI property to Remote Rendering Account * Fix typo * Fix examples * Fix case mismatch in examples Co-authored-by: Lei Ni * regenerated all-api-versions * add issue_assignment and rename assignment.yml (#9510) * add issue_assignment and rename assignment.yml => pull_request_assignment.yml * reserve assignment.yml for a period time * [Hub Generated] Review request for Microsoft.ResourceGraph to add version preview/2020-04-01-preview (#9025) * Adds base for updating Microsoft.ResourceGraph from version stable/2019-04-01 to version 2020-04-01-preview * Updates readme * Updates API version in new specs and examples * Push changes * Validation fixes * More validation fixes * Add x-ms-enum * Adds suppression to readme * Prettier fixes * Fix object type * update operation ids * Adding GraphQuery * Fix added paren * Fix addition of 2020 version * Prettier * Move up properties * Insert to properties bag * Add to resource properly * Move to GraphQueryResource * regenerated all-api-versions * Add subscription bound for cost management (#9514) * Dev todo microsoft.sample rp 2020 05 01 (#9513) * New Readme Config File * New Go Language Readme Config File * New Typescript Language Readme Config File * New Python Language Readme Config File * New C# Language Readme Config File * New Ruby Language Readme Config File * New Swagger Spec File * New Swagger Example Spec File * add new swagger.json * regenerated all-api-versions * add usePrivateLinkConnection parameter to data sync APIs (#9454) * add private link connection parameter to data sync * add usePrivateLinkConnection parameter to examples * allow usePrivateLinkConnection to be read * add usePrivateLinkConnection property to example returns * remove old unreferenced example files * correct swagger version * add syncMemberAzureDatabaseResourceId parameters to examples * fix readme.md * prettify examples * regenerated all-api-versions * Eyes on setting (#9355) * try * commit * commot * try * validation * [Ready For Review] Add APIs for preparing Azure Notebook from AML workspace, and return required info to user for notebook initialization (#9058) * Add Identity to createWorkpace example * swagger change for provisioning Notebook * new line at the end of the file * fixup * address comments * change listresourcepreparationerrors from post to get * address comments * fix ResourceId values in example and fix casing issue * fix casing * remove listResourcePreparationErrors API and add the errors in GetWorkspace * remove an extra coma * remove prepareResourceErrors API * fix errors reported by pipeline * fix prettier check * fix computes examples * one more fix for existing examples * remove identity * address comments * add description to NotebookResourceInfo.resourceId * fix spell check and prettier check * Cli codegen onboard operationsmanagement (#8874) * Cli onboard blockchain (#9530) * Cli onboard hardwaresecuritymodules (#9532) * Policy compliance data enable pagination (#7909) * initial commit * Events for 2019-09-01 * fix oav errors * Update 2019-10 tag with 2019-10-01-policyevents * add file to input list * add policyevents to 2018-07-01-preview version * fix path in readme * add examples in events, add parameters * specfication files * fix avocado * fix typo * Fix prettier * Update description for apiversion param * fix typo and description * Revert Lint warning * Remove metadata from events and add missing compliancestates in examples * Add the missing x-ms-pageable Co-authored-by: Namrata Jagasia Co-authored-by: Phoenix He * regenerated all-api-versions * Logic pipeline (#9372) * netapp trenton pipeline * logic pipeline test Co-authored-by: root * updated the tags for fix doc generation issue. (#9528) Co-authored-by: v-ajnava * [T2] removed duplicated schemas in storage (#9527) * duplicated schemas in storage * trying to fix storage duplication * [Hub Generated] Review request for Microsoft.AlertsManagement to add version preview/2019-05-05-preview (#9540) * Added missing Alert Modification Events * Added Subscription value to Scope Type Enum * EventGrid: Update 2020-04-01-preview swagger to use enum as string for parentType (#9545) * update swagger * fix prettier Co-authored-by: Ashraf Hamad * update @azure/oad version to fix breaking issue (#9551) Co-authored-by: Jianye Xi * [Synapse Data Plane]Add vnet feature to data plane (#8753) * Add vnet feature to data plane * Support multiple client * 1. Add x-ms-pageable to list api Co-authored-by: Zhenyu Zhou * Microsoft.Batch 2020-05-01 (#9452) * Adds base for updating Microsoft.Batch from version stable/2020-03-01 to version 2020-05-01 * Updates readme * Updates API version in new specs and examples * Updates for Microsoft.Batch 2020-05-01 This version adds System Managed Identity to Batch accounts and allows for setting Encryption properties on a Batch account. * Fix swagger errors with private endpoint APIs * updating peering az specification (#9489) * regenerated all-api-versions * test for deviceprovisioningservices (#9350) * Update readme.cli.md * test for deviceprovisioningservices * [Computer Vision 3.0] Update Read Language parameter description to include new languages (#9548) * [AMS] update AMS stable version to include Edge list api (#9492) * [AMS] update AMS stable version to include Edge list api * fix an example * fix better descriptions. * more descriptive description * Add New ApiVersion 2020-03-01 (#9480) * Update SavedSearches.json (#9550) * Link workspace (#8994) * create 2020-04-01-preview version * add LinkedWorkspace * remove tailing whitespace * fix build error * address comments * fix updateAmlCompute example * fix build * address comments Co-authored-by: Richard Li * Add capabilities for cognitive services. (#9491) * Added operations api in Microsoft.OffAzure GA version (#9465) * Create swagger.json Added swagger for vmwaresite, hypervsite, serversite * Update swagger.json Addition of Importsite resource * Referred swagger in readme.md * changed readme to have 2 api-versions * Updated readme * Updated ip address name * Create migrate.json * deleted preview changes * Fixed new version * fixed job definition, get and put site * Update migrate.json * Update migrate.json * Added examples. Removed server and import stacks * Removed extra code * Made it in accordance with private preview PR * Examples added * fixed comments * added tags * Resolved conflicts * fixed file * Fixed spellings * fixed spellings * added examples * fixed example * fixed examples * fixed examples * fixed discrption * fixed prettier check * fixed enums * prettier check * Update readme.md * Added operations list * Create migrate.json * added OperationDisplay definition * error fixed * Update migrate.json * fixed errors * Update Operations_List.json * Update migrate.json * Removed parameters * Ran Prettier check * Update migrate.json * Update migrate.json * prettier check * Added api-version parameter under convertToSinglePlacementGroup for VMSS (#9555) * Update isFollowed property to boolean (#9500) * feat: update java readme (#9570) * Update secureScore.json (#9517) * Update secureScore.json Revert enum custom value and fix SDK creation * Trying to prevent "Breaking changes" when removed * [Hub Generated] Review request for Microsoft.DigitalTwins to add version preview/2020-03-01-preview (#9459) * swagger change * remove integration examples * Enable excel in public swagger (#8875) * Enable excel in public swagger * update * rollback dataflow change Co-authored-by: zhanyu2014 * Remove sample todo resource provider (#9572) * Operationalinsights tables, wokspace capping and sku (#9505) * Workspace tables * Pretty * Fixes * Fix * Fixes * Add missing properties for capping and SKU * Fixes * Fix * PR fixes - change PUT to PATCH * Unrequire properties in /tabels PATCH * Adding the documentations for 5 new lint rules (#9569) * Adding 5 new lint rules * update * update created date * fix typo Co-authored-by: Jianye Xi * Optional 'workspace' property (#9495) Co-authored-by: Liran Chen * enable trenton package in prod (#9582) Co-authored-by: Xiaoxu Qi * [Hub Generated] Review request for Microsoft.ManagedServices to add version preview/2020-02-01-preview (#8913) * Adds base for updating Microsoft.ManagedServices from version stable/2019-09-01 to version 2020-02-01-preview * Updates readme * Updates API version in new specs and examples * Added all changes from PR 1138 to a new API version folder * Removed readOnly: true from multiFactorAuthProvider * Added principalIdDisplayName and delegatedRoleDefinitionsId to Authorization object + changed description of maximumActivationDuration to reflect ISO 8601 format * Made changes reflecting Chris Eggert's suggestions * Fixed camel case mistake * Fixed registrationDefinitionIdParameter references * Adds base for updating Microsoft.ManagedServices from version stable/2019-09-01 to version 2020-02-01-preview * Updates readme * Updates API version in new specs and examples * Updated read.md * Fixed wrong tag in readme * regenerated all-api-versions * Add reboot parameters. (#9426) * Add reboot parameters. * Add examples and remove required on rebootType. * Fix prettier errors. * Azure Spring Cloud: Support API to enable/disable MSI (#8966) * Azure Spring Cloud: Support API to enable/disable MSI * Fix issue Co-authored-by: Xiaoyun Ding * [Azure SignalR service]Support Private Link and add new api-version (#9377) * Run prettier * Adding new apiVersion 2020-05-01 and support PrivateLink * Using the same schema for SignalR PUT api * No changes, to trigger pipeline build * Using shared definition to avoid duplication * resolve comments * fix avocado * Removing legacy file * add readme file for alertsmanagement (#9578) * update package name and output folder in readme.typescript.md * add trenton readme file for alertsmanagement * update override for type * Get buildID for package version (#9594) Co-authored-by: Xiaoxu Qi * Changes for EA invoice scenarios (#9508) * Added invoice download APIs. Added billing account-level invoice APIs for supporting EA invoices. * Fixed billing subscription invoice download scope * Added invoice rebillDetails * Reduced changes to those for supporting EA invoices * Reduced changes to those for supporting EA invoices 2 * Reduced changes to those for supporting EA invoices 3 * PR feedback * Added Cleared value for invoice status. * Changed invoice status Cleared to Void * Removed documents/source property from invoice example * documentation updates (#9583) * documentation updates * Reverting user impersonate value * Add readme.md for typescript sdk generation (#9339) * Update links in PULL_REQUEST_TEMPLATE.md (#9529) * Update links * Default unchecked * Update specificationRepositoryConfiguration.json (#9345) * Creating Labeler for Compute Updates (#9554) * Create label.yml * Create pr-labeler.yml * Update pr-labeler.yml * Update pr-labeler.yml * Rename pr-labeler.yml to labeler.yml * Update and rename label.yml to labelr.yml * Update labeler.yml * Update labelr.yml * Rename labelr.yml to labeler.yml * Update labeler.yml * Update labeler.yml * Update labeler.yml * Update labeler.yml * Update labeler.yml * Update labeler.yml * labeler for compute update * Update labeler.yml * Rename labeler.yml to ComputeReviewLabeler.yml * Update and rename labeler.yml to computeReviewLabeler.yml * Rename ComputeReviewLabeler.yml to computeReviewLabeler.yml * Update CODEOWNERS * Dev containerservice microsoft.container service 2020 04 01 (#9484) * Adds base for updating Microsoft.ContainerService from version stable/2020-03-01 to version 2020-04-01 * Updates readme * Updates API version in new specs and examples * Support Node Image Version (#8865) * Add deprecated field to ContainerService GetAccessProfile 2020/04/01 API swagger (#9083) * Remove Low option from 04-01 API version (#9084) * Add a max surge upgrade setting (#9331) * [AKS] Apply patch from 0301 API version to 0401 (#9412) Co-authored-by: Xiaofang Zhang Co-authored-by: ruchikaguptaa Co-authored-by: Paul Miller Co-authored-by: Marwan Ahmed * Remove ISO8601 date format, ad current implementation uses another fo… (#9591) * Remove ISO8601 date format, ad current implementation uses another format and it breaks CLI. * One more date format change * [Hub Generated] Review request for Microsoft.AzureActiveDirectory to add version preview/2020-05-01-preview (#9458) * New Readme Config File * New Go Language Readme Config File * New Typescript Language Readme Config File * New Python Language Readme Config File * New C# Language Readme Config File * New Ruby Language Readme Config File * New Swagger Spec File * New Swagger Example Spec File * making changes * Fixing errors * Fixing errors * Fixing build errors * Fixing pretty print * Adding Examples to the swagger review * Fixing semantic issues * removing code * removing required flags * Fixing Lint issues * Fixing Lint issues * Fixing build failures * Fixing build errors * grammer error fix * PR comments * fixing build * Fixing build errors * Fixing grammer * PR comments * Failing Validation Co-authored-by: animesh * regenerated all-api-versions * Cli onboard desktopvirtualization (#9531) * cli validation for desktopvirtualization * WIP * rename filter * correct example * rename extension * revert host-pool PATCH example * add expiredTime in RegistrationInfoPatch Co-authored-by: Changlong Liu * regenerated all-api-versions * BillingRP - Introducing the stable version (#9541) * BillingRP swagger * Changes for the GA version Changes for the GA version * Incorporated review comments Incorporated review comments * Fixed Prettier Check failures Fixed Prettier Check failures * Fixed Prettier Check failures Fixed Prettier Check failures * Added BillingSubscription patch Added BillingSubscription patch Co-authored-by: Anirban Sarkar * Speaker Recognition v2 (#9587) * Speaker Recognition v2 Split service into 2 APIs; Speaker Identification and Speaker Verification * Spelling mistakes fixed * Prettier run * add item name * Remove go support for now will add it later when we figure out the issue * regenerated all-api-versions * Update API specs 2020-04-01 (#9383) * Update API specs 2020-04-01 * Fix place * Fix version * Comments * Fix json * copy check files * Include old examples * Copy file over * Add files * Change version * Try reverting 2020-05-01 changes * Revert 2020-05-01 changes to test * Move version to end of file * Revert "Move version to end of file" This reverts commit 1c972299239680a2d350fabc4c177dda16eb9117. * Revert "Revert 2020-05-01 changes to test" This reverts commit ff0936aadbdf0842916fc9390b9395c7b232ad49. * Revert "Try reverting 2020-05-01 changes" This reverts commit f270e0d0e6e4be79bdccea36a6a1b50671354d0d. * Remove extra ``` * revert breaking 2020-05-01 change * Fix case * regenerated all-api-versions * Add async operation's api to storage cache RP (#9483) * Add basicpublishingcredentialspolicies to Microsoft.Web 2019-08-01 (#9250) * Add basicpublishingcredentialspolicies to Microsoft.Web stable 2019-08-01 * Made new resource a proxy only resource * Added missing reference * Addressing comments * Added examples * Removed description as a required field for SearchIndexerSkillset (#9588) * Removed color and imageType from the visualFeature enumeration in the V2 SDK. These weren't referenced in the examples. * Removed description as a required field for SearchIndexerSkillset * add secondly (#9225) * Removed TextExtractionAlgorithm from OCRSkill (#9604) * Removed color and imageType from the visualFeature enumeration in the V2 SDK. These weren't referenced in the examples. * Removed property TextExtractionAlgorithm (which is obsolete) and added property LineEnding to OCRSkill * Fixed bug with json escape characters and quoted default values in descriptions * Backing out changes for LineEnding, so we can get the TextExtractionAlgorithm removal in * Changed skill-related enums to strings for values that may change (#9621) * Removed color and imageType from the visualFeature enumeration in the V2 SDK. These weren't referenced in the examples. * Changed skill-related enums to be strings for values that may change in the future * Add checkTrialAvailability endpoint to Microsoft.AVS manifest (#9618) Co-authored-by: David Ricciardi * update 2019-06-01-preview ManagedDatabases swagger file (#9535) * update 2019-06-01-preview ManagedDatabases swagger file * added newline to eof * Update script version for PPE pipeline (#9616) * Add free-form object spec for testing purpose. * Revert "Add free-form object spec for testing purpose." This reverts commit b711d809b6ae964fcbe7d04f31fec76db8798438. * Update script version for ppe pipeline. * added dismiss alerts and get single alert. (#9434) * [DataFactory] - Add xml dataset (#9615) * Add xml dataset * Fixed typo * Fixed typo * Fixed typo * Fixed prettier check issues * Removed namespaces in xml ReadSettings Co-authored-by: Shawn Xiao (IM) * add linked service and schema linked service to data flow source/sink (#9605) * add alert link to security alert arm model (#9566) * add alert link to security alert arm model * Add alert link to example file * Change to lowercase Co-authored-by: Amir Keren * EventHub: fixed the Cluster PUT API (#9596) * fixed the Cluster PUT API * fix examples * examples fix * example fixes * corrected example cluster_put Co-authored-by: v-ajnava * [AKS] re-apply the changes to making the count field optional to fix regressions (#9610) * Swagger for the new ARM resource PrivateLinkHub (#9482) * Swagger for the new ARM resource PrivateLinkHub * fix review comments * Added descriptions * prettier fixes * Add reference to json in readme * Add Patch operation * Added enum for Provisioning State * update example * regenerated all-api-versions * Fix output folder in peering (#9631) * Add Readme File for Container Registry (#9632) * Fix linter doc mistake (#9630) * update @azure/oad version to fix breaking issue * Adding 5 new lint rules * fix typo * fix typo Co-authored-by: Jianye Xi * Move serverVulnerabilityAssessment API to stable-2020-01-01 (#9097) * Move serverVulnerabilityAssessment API to stable-2020-01-01 * remove preview version * Removed API that is not reachable * fix conflicts * Add serverVA in missing parts * Add missing serverVA * revert readme * ASC: Move VA to 2020-01-01 * update GC Swagger spec to match with most recent service interface (#9595) * update Guestconfiguration Swagger spec to match with most recent service Api interface * fix auto check-Part1 * roll back style change * fix auto check-Part2 * fix auto check-Part3 * fix auto check-Part4 * fix auto check-Part5 * fix auto check-Part6 - readonly * fix auto check-Part7 * fix auto check-Part8 * fix auto check-Part9 -- error code * roll back to Part5 * roll back to Part5.1 * roll back to Part5.2 * roll back to Part5.3 * roll back to Part5.4 Co-authored-by: ge huang * Merge 7.2 into master (#9590) * Adding 7.2-preview version (#8397) * Adding 7.2-preview version Signed-off-by: vasanthrajams * Resolve PR feedback * Fix output-folder for go code generation Co-authored-by: Heath Stewart * full backup restore yaml changes (#8685) * Adding the required swagger file changes for full HSM backup Signed-off-by: vasanthrajams * Resolved a few semantic errors in pipeline Signed-off-by: vasanthrajams * Fixed incremental github pipeline model validation erors Signed-off-by: vasanthrajams * Fixed review comments & ci pipeline * spell check fix * pretty fix * Adding required headers as per azure async operations guidelines Signed-off-by: vasanthrajams * Fixed minor typos Signed-off-by: vasanthrajams Co-authored-by: vasanthrajams * selective key restore (#8781) * selective key restore * moved selective key restore to keys.json * fixed github pipeline checks * example missing folder property * Resolved review comments * minor fix * review comments * pretty check fix Co-authored-by: vasanthrajams * Additional 7.2 preview changes (#9141) * Additional 7.2 preview changes * Corrections and Feedback updates * Remove ProtectedKey * Patch export sample * Fix validation errors * Fix more validation errors * More validation fixes * Add 6 more AES-CBC algorithms (#9317) * Add 6 more algorithms * Add new words to fix the spelling * Adding 7.2-preview version (#8397) * Adding 7.2-preview version Signed-off-by: vasanthrajams * Resolve PR feedback * Fix output-folder for go code generation Co-authored-by: Heath Stewart * selective key restore (#8781) * selective key restore * moved selective key restore to keys.json * fixed github pipeline checks * example missing folder property * Resolved review comments * minor fix * review comments * pretty check fix Co-authored-by: vasanthrajams * Additional 7.2 preview changes (#9141) * Additional 7.2 preview changes * Corrections and Feedback updates * Remove ProtectedKey * Patch export sample * Fix validation errors * Fix more validation errors * More validation fixes * Add 6 more AES-CBC algorithms (#9317) * Add 6 more algorithms * Add new words to fix the spelling * fixing validation failures * key-version example fix * model validation Co-authored-by: Heath Stewart Co-authored-by: vasanthrajams Co-authored-by: Hervey Wilson Co-authored-by: Rick Qing Xu * monitor readme fix (#9635) * [Hub Generated] Review request for Microsoft.Consumption to add version stable/2019-10-01 (#9418) * added forecast api and all of it's scopes * removed extra external forecast example links * updated budgets api to reflect current version * fixed filter properties * fixed typos * cleaned up description * removed OR from budgetFilter * Revert "removed extra external forecast example links" This reverts commit b491abae116fd1e484b0b9d18fbe4bd86aec0fd2. * Revert "added forecast api and all of it's scopes" This reverts commit 6de98db14004d5701c56c42adcade4ee583c011b. * fixed Budgets as per PM's suggestions * renamed x-ms-enum name to avoid conflict * [DataFactory] Add GlobalParameters and update waitTimeInSeconds in WaitActivity (#9362) * Update data type of waitTimeInSeconds in WaitActivity * add global parameters Co-authored-by: Kang Tao * update identity type enum (#9649) Co-authored-by: Richard Li * Revert "Fix Parameter Description for validate resource move (#8524)" (#9580) This reverts commit cb0a81fefacc56fca338e3a2658a9390b305fa61. * Correcting the swagger to accept downloadToken similar to other download operations (#9651) Correcting the swagger to accept downloadToken similar to other download operations Co-authored-by: Anirban Sarkar * renaming operationIds fro Cluster put and patch as per guidelines (#9639) Co-authored-by: v-ajnava * Updating documentation of Quota APIs. Removing Summary field. (#9641) * Updating operationId to group the opearions in a logical way and the generate APIs are grouped together based on the operations. * 1. Updating schema for autoQuotaRequest 2. Updating examples. * Updates to data model and examples. * Model Update. * Data Model Fix. * Fixing Data Model for AQI. * Removing duplicate definitions. * Adding type=object for emailAction. * Putting the similar definitions together. * Model Fix. * Fixing AQI examples. * Adding descriptions for enum. * Fixing Spell Check error. * Removing used object: phoneActions. Updating the comments for Put and Patch, that both can be used to update quota. * Updating the Put operatonId as _CreateOrUpdate. * Making Tag information same - QuotaInformation. * Updating example for commit. * 1. Updating description of Quota APIs. 2. Removing Summary, as summary and description was combined in the doc. It had repeated statements. * 1. Updating descriptions. 2. Adding BatchML examples and making the example names as - MachineLearningServices. * Upadatin serviceLimitsRequests in path. * Update CODEOWNERS (#9669) * add deleteFilesAfterCompletion to binary sources. add listAfter/listBefore to adls gen1 source (#9472) Co-authored-by: Haoran Sun * Fix bad output-folder (#9658) * enable rest-api-specs-scripts@0.10.2 (#9671) * Update API specs 2020-05-01 (#9542) * update 2020-05-01 version * Add samples * Update version * Update example * Fix case * regenerated all-api-versions * Event Grid: 2020-06-01 Swagger (#9629) * [HDInsight]-Add livyspark api spec for hdi. (#9469) * Add livyspark api spec for hdi. * Prettier check * Update code style. * fix comments * prettier check * Update the code in order to unify the naming rules. * updated AppServicePlan doc (#9679) * Kusto: update java readme (#9576) * Updating Patch API description. (#9676) * Updating operationId to group the opearions in a logical way and the generate APIs are grouped together based on the operations. * 1. Updating schema for autoQuotaRequest 2. Updating examples. * Updates to data model and examples. * Model Update. * Data Model Fix. * Fixing Data Model for AQI. * Removing duplicate definitions. * Adding type=object for emailAction. * Putting the similar definitions together. * Model Fix. * Fixing AQI examples. * Adding descriptions for enum. * Fixing Spell Check error. * Removing used object: phoneActions. Updating the comments for Put and Patch, that both can be used to update quota. * Updating the Put operatonId as _CreateOrUpdate. * Making Tag information same - QuotaInformation. * Updating example for commit. * 1. Updating description of Quota APIs. 2. Removing Summary, as summary and description was combined in the doc. It had repeated statements. * 1. Updating descriptions. 2. Adding BatchML examples and making the example names as - MachineLearningServices. * Upadatin serviceLimitsRequests in path. * Updating Patch API description. * Patch description updated. * Update data share examples for consumer invitations (#9668) * update examples for consumer invitations with correct id * run prettier * Remove lt rv1 WaitForARMFeedback (#9247) * add readme.az for databoxedge (#9683) * add readme.az * add cli_extension * validate CLI codegen for databox (#9211) * validate databox * repo: azure-cli-extensions * relocate python config Co-authored-by: Changlong Liu * updated resources readme (#9638) * Update InfrastructureEncryption property description for PostgreSQL and MySQL (#9390) * Update InfrastructureEncryption property description for PostgreSQL and MySQL * Update InfrastructureEncryption property description for PostgreSQL and MySQL * Update allowed range for nodeCount (#9602) * Update allowed range for nodeCount * Remove minimum * Remove features mode (#9645) * Documentation fix (#9693) * Tables swagger fixes (#9584) * According to this PR https://github.com/Azure/azure-sdk-for-net/pull/7235 having Vision.FormRecognizer folder was mistake. (#8422) But this readme still contains vision and if you try to regenerate code in azure-sdk-for-net repository they would be created in Vision.FormRecognizer rather than just FormRecognizer. * init (#9667) * Onboard python track2 codegen (#9708) * align eTag with server (#9687) * align with server * revert for certain * IngestionMode Flag (#9654) * IngestionMode Flag * fix for missing bracket * diganostic with an A * Update property range due to tier sensitive. (#9422) Signed-off-by: Pan Li * fix swagger bug (#9709) * Update GraphQuery location property readOnly=false (#9568) * remove location readOnly property * set location readOnly false * Update bms.json (#9711) Azure Backup Health * Azure Digital Twins 2020-05-31-preview (#9622) * Azure Digital Twins 2020-05-31-preview swagger. * Updates. * Updates. * Update host name. * Add custom words. * Fix host name so that verification tools work. * Prettier updates. * Try file name without spaces. * Update md files. * Add missing api-version. * Fix readme.go.md. * [Synapse] - Update data plane Swagger specs (#9534) * Update Synapse Swagger data plane specs * Fix notebook * Create three clients in Readme * Update Readme for managed Vnet * Rename scheme name * Minor change * Update example * Rename development to artifact Co-authored-by: Dongwei Wang Co-authored-by: Laurent Mazuel * New API version for Iot Hub Get Endpoint Health (#9680) * Adds base for updating Microsoft.Devices from version stable/2020-03-01 to version 2020-04-01 * Updates readme * Updates API version in new specs and examples * initial version * camel case * reviewed comments Co-authored-by: Juan Carpio Castellanos * remove whitespace (#9703) * remove whitespace * fix example Co-authored-by: Richard Li * Fix VirtualMachineScaleSetIPConfigurationProperties Load Balancer description (#9675) * add codegen config for GuesConfiguration (#9692) * add codegen config * enable pipeline * [Hub Generated] Review request for Microsoft.Databricks to add version stable/2018-04-01 (#9657) * 1.Breaking Change - Removing duplicate autoQuotaIncreaseState from supportTicketAction. (#9724) 2. Removing state=enabledForPreview. 3. Updating Example. * Add sql parallel read properties (#9712) * add httpRequestTimeout to odata based connector activities * add httpRequestTimeout to odata based connector activities * add sql parallel read properties * Custom vision 3 3 (#9522) * Establish base from previous version to compare against * Alphabetize paths * API Updates * Add missing error messages * Fix file type * Spelling fix * Run prettier * Update all apis * Changing aspects/opinions to optional properties from required proper… (#9702) * Changing aspects/opinions to optional properties from required properties * removing (Optional) description Co-authored-by: josuh * Adding the missing api-version parameter for move and validate move APIs. It is already part of the examples. (#9732) * Correcting the swagger to accept downloadToken similar to other download operations Correcting the swagger to accept downloadToken similar to other download operations * Adding the missing api-version parameter for move and validate move apis. IT is already part of the examples. Adding the missing api-version parameter for move and validate move apis. IT is already part of the examples. Co-authored-by: Anirban Sarkar * Add Missing Json in Readme for Monitor (#9730) * Delete labeler (#9738) * Delete computeReviewLabeler.yml * Delete computeReviewLabeler.yml * Update CODEOWNERS * enable t2 generation (#9749) * enable t2 generation (#9756) * Added the allowed values to $select, $expand and $filter queries unde… (#9585) * Added the allowed values to $select, $expand and $filter queries under VMSS and to $select query for Avset * Adding allowed values in the corresponding descriptions field * changing the examples * DiskRP Swagger changes for 2020-05-01 (#9552) * baseline commit for disk.json * changes related to disk access, changes in disk encryption set for new api version, new examples related to disk access * adding few more examples, more changes to disk.json * prettier commit * few fixes * added more examples and fixed readme.md, fixed typos in disk.json * fixing readme * prettier fixes * fix ref to example * adding network access policy and diskAccessId to snapshots * fix readme.md * fixing enum descriptions * fixing enum description * fixing descriptions * fixing validations * fix swagger api version * reverting des change to make sourceVault optional * fix field name actionsRequired * fixing descryptions for encryption at rest * consolidating enums and fixing type * [Resources] Add new API version (#9487) * Initial commit with the old version * Add error proprty to DeploymentOperationProperties * Add enum values for provisioningState * Update provisioningState description * Update statusMessage property * Update api-version and parameters in examples * Update readme.md to refer to the new resources swagger * Prettier fix; we can Python sdk too * Added id and relativePath parameters to TemplateLink * update csharp and java read me files for the new API * Address Pr feedback * Examples for TemplateSpecs deployment * Unblock Java SDK generation * Fix examples for templatespecs * prettier fixes Co-authored-by: Filiz Topatan Co-authored-by: Gokul Premraj * Add multiapi support (#9759) * fixed examples and BudgetCategory as PM suggested (#9776) * Fix Error Response Structure (#9733) Co-authored-by: Zhenyu Zhou * Adding new resource type azureADMetrics (#9636) * Adds base for updating Microsoft.Aadiam from version preview/2020-03-01-preview to version 2020-07-01-preview * Updates readme * Updates API version in new specs and examples * added azureADHealth * rough commit (without examples) for azureADHealth * changed Ad to AD * added examples for azureadhealth * removed private link files from 2020-07-01 preview * examples updated for azureadhealth * removed alltenants and tenants params from examples * Fix Linting errors * Update readme to make avocado fix * minor fix * custom word addition * Update examples to match spec * Make PrivateLinkPolicyName parameter have same values to solve LintDiff error * Make subscriptionIdParameter identical in all json files * error fixes for all model errors * fixed model validation error * additional suppressions for pascal case and operations * added azureadhealth in readme to fix avocado error * added privatelink api version along with azureadhealth * changed api version to the filepath version * modified for corrections on AzureADHealthGet * aded changes to match spec and example * reverted passing commit from before * renamed to azureadmetrics * Readme changes * azureadmetrics custom word change * azureadmetrics file updates * properties * quick prettier fix * minor change to run tests again * addressing comments * location and tag changes * delete doesnt take in param * removed duplicate tag def * syntax check * comment changes, except the provisioningState change * provisioningstate property addition * provisioningState example fixes * properties fix * semantic validation error fix Co-authored-by: Hyewon Lee Co-authored-by: Abbe Blank * enable t2 generation (#9755) * enable t2 generation (#9752) * test support (#9741) * enable t2 generation (#9751) * Adding swagger for Template Specs (#9778) * Adding swagger for Template Specs * Running prettier to fix whitespace/newline alignments * enabling track2 generation (#9754) * Updates for FE changes Co-authored-by: Zach Rathbun Co-authored-by: TinaHu1 <51737887+TinaHu1@users.noreply.github.com> Co-authored-by: Alex Aloni Co-authored-by: Alex Dubinkov Co-authored-by: azuresdkci Co-authored-by: Arcturus Co-authored-by: shurd Co-authored-by: Sam Hurd Co-authored-by: annatisch Co-authored-by: datr93 <43795914+datr93@users.noreply.github.com> Co-authored-by: John Stairs Co-authored-by: Landon Smith Co-authored-by: navysingla <47647464+navysingla@users.noreply.github.com> Co-authored-by: Jiashuo Li Co-authored-by: Xiangyu Luo Co-authored-by: Lei Ni Co-authored-by: Zim Kalinowski Co-authored-by: Steve Stein Co-authored-by: Himanshu Chhabra Co-authored-by: Tosin Adewale Co-authored-by: Tosin Adewale Co-authored-by: Ruoxuan Wang <52271048+ruowan@users.noreply.github.com> Co-authored-by: changlong-liu <59815250+changlong-liu@users.noreply.github.com> Co-authored-by: Changlong Liu Co-authored-by: Tanyi Chen Co-authored-by: elabicha <61994320+elabicha@users.noreply.github.com> Co-authored-by: Phoenix He Co-authored-by: Cameron Taggart Co-authored-by: jspearman3 Co-authored-by: Praneeth Sanapathi Co-authored-by: Praneeth Sanapathi Co-authored-by: Ran Wang Co-authored-by: JianyeXi <59603451+jianyexi@users.noreply.github.com> Co-authored-by: Jianye Xi Co-authored-by: ayfathim Co-authored-by: 陈箭飞 <32889038+chenjianfei2017@users.noreply.github.com> Co-authored-by: root Co-authored-by: Vivian Liu Co-authored-by: Allen Zhang Co-authored-by: Ashraf Hamad Co-authored-by: Ashraf Hamad Co-authored-by: Feiyu Shi <44449256+feiyushi@users.noreply.github.com> Co-authored-by: Vishnu Priya Ananthu Sundaram Co-authored-by: Yoram Singer <37076505+yoramsinger@users.noreply.github.com> Co-authored-by: Priyaranjan Pandey Co-authored-by: xiaoxu qi Co-authored-by: Xiaoxu Qi Co-authored-by: Junbo Wang Co-authored-by: Donald Liu <32778916+PakDLiu@users.noreply.github.com> Co-authored-by: ityankel <47292630+ityankel@users.noreply.github.com> Co-authored-by: Marcin Jastrzebski Co-authored-by: Avinash Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com> Co-authored-by: srilatha inavolu Co-authored-by: ivkule <59470194+ivkule@users.noreply.github.com> Co-authored-by: NourEldin Yasser <65115481+a-noyass@users.noreply.github.com> Co-authored-by: John Call Co-authored-by: Thomas Reis Co-authored-by: bob Co-authored-by: Paviya (Elle) Tojaroon Co-authored-by: Elle Tojaroon Co-authored-by: giromm2ms <52413295+giromm2ms@users.noreply.github.com> Co-authored-by: Gideon Romm Co-authored-by: Chen Lahav Co-authored-by: Jacob Hill Co-authored-by: Jacob Hill Co-authored-by: David Zhao <31305478+davidzhaoyue@users.noreply.github.com> Co-authored-by: David Zhao Co-authored-by: yibirnba <52132191+yibirnba@users.noreply.github.com> Co-authored-by: Nitsan Bracha Co-authored-by: Nitsan Bracha Co-authored-by: Zihong Co-authored-by: Zhiyong Yang Co-authored-by: Meha Kaushik Co-authored-by: Meha Kaushik Co-authored-by: Arik Olsh <47111029+arolshan@users.noreply.github.com> Co-authored-by: Anthony Kunnel Jose Co-authored-by: erich-wang Co-authored-by: Arthur Ning <57385816+akning-ms@users.noreply.github.com> Co-authored-by: Fernando Fonseca Co-authored-by: liemilyg <45784009+liemilyg@users.noreply.github.com> Co-authored-by: zhaomuzhi Co-authored-by: najagasi <49212852+najagasi@users.noreply.github.com> Co-authored-by: Namrata Jagasia Co-authored-by: Ajit Navasare Co-authored-by: v-ajnava Co-authored-by: orieldar Co-authored-by: aim-for-better Co-authored-by: Zhenyu Zhou Co-authored-by: Mark Young Co-authored-by: giakas Co-authored-by: ankushbindlish2 <34896519+ankushbindlish2@users.noreply.github.com> Co-authored-by: Richard Li Co-authored-by: Richard Li Co-authored-by: Yang Yuan Co-authored-by: pajind Co-authored-by: angaivor Co-authored-by: Zach Rathbun Co-authored-by: TinaHu1 <51737887+TinaHu1@users.noreply.github.com> Co-authored-by: Alex Aloni Co-authored-by: Alex Dubinkov Co-authored-by: azuresdkci Co-authored-by: Arcturus Co-authored-by: shurd Co-authored-by: Sam Hurd Co-authored-by: annatisch Co-authored-by: datr93 <43795914+datr93@users.noreply.github.com> Co-authored-by: John Stairs Co-authored-by: Landon Smith Co-authored-by: navysingla <47647464+navysingla@users.noreply.github.com> Co-authored-by: Jiashuo Li Co-authored-by: Xiangyu Luo Co-authored-by: Lei Ni Co-authored-by: Zim Kalinowski Co-authored-by: Steve Stein Co-authored-by: Himanshu Chhabra Co-authored-by: Tosin Adewale Co-authored-by: Tosin Adewale Co-authored-by: Ruoxuan Wang <52271048+ruowan@users.noreply.github.com> Co-authored-by: changlong-liu <59815250+changlong-liu@users.noreply.github.com> Co-authored-by: Changlong Liu Co-authored-by: Tanyi Chen Co-authored-by: elabicha <61994320+elabicha@users.noreply.github.com> Co-authored-by: Phoenix He Co-authored-by: Cameron Taggart Co-authored-by: jspearman3 Co-authored-by: Praneeth Sanapathi Co-authored-by: Praneeth Sanapathi Co-authored-by: Ran Wang Co-authored-by: JianyeXi <59603451+jianyexi@users.noreply.github.com> Co-authored-by: Jianye Xi Co-authored-by: ayfathim Co-authored-by: 陈箭飞 <32889038+chenjianfei2017@users.noreply.github.com> Co-authored-by: root Co-authored-by: Vivian Liu Co-authored-by: Allen Zhang Co-authored-by: Ashraf Hamad Co-authored-by: Ashraf Hamad Co-authored-by: Feiyu Shi <44449256+feiyushi@users.noreply.github.com> Co-authored-by: Vishnu Priya Ananthu Sundaram Co-authored-by: Yoram Singer <37076505+yoramsinger@users.noreply.github.com> Co-authored-by: Priyaranjan Pandey Co-authored-by: xiaoxu qi Co-authored-by: Xiaoxu Qi Co-authored-by: Junbo Wang Co-authored-by: Donald Liu <32778916+PakDLiu@users.noreply.github.com> Co-authored-by: ityankel <47292630+ityankel@users.noreply.github.com> Co-authored-by: Marcin Jastrzebski Co-authored-by: Avinash Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com> Co-authored-by: srilatha inavolu Co-authored-by: ivkule <59470194+ivkule@users.noreply.github.com> Co-authored-by: NourEldin Yasser <65115481+a-noyass@users.noreply.github.com> Co-authored-by: John Call Co-authored-by: Thomas Reis Co-authored-by: bob Co-authored-by: Paviya (Elle) Tojaroon Co-authored-by: Elle Tojaroon Co-authored-by: giromm2ms <52413295+giromm2ms@users.noreply.github.com> Co-authored-by: Gideon Romm Co-authored-by: Chen Lahav Co-authored-by: Jacob Hill Co-authored-by: Jacob Hill Co-authored-by: David Zhao <31305478+davidzhaoyue@users.noreply.github.com> Co-authored-by: David Zhao Co-authored-by: yibirnba <52132191+yibirnba@users.noreply.github.com> Co-authored-by: Nitsan Bracha Co-authored-by: Nitsan Bracha Co-authored-by: Zihong Co-authored-by: Zhiyong Yang Co-authored-by: Meha Kaushik Co-authored-by: Meha Kaushik Co-authored-by: Arik Olsh <47111029+arolshan@users.noreply.github.com> Co-authored-by: Anthony Kunnel Jose Co-authored-by: erich-wang Co-authored-by: Arthur Ning <57385816+akning-ms@users.noreply.github.com> Co-authored-by: Fernando Fonseca Co-authored-by: liemilyg <45784009+liemilyg@users.noreply.github.com> Co-authored-by: zhaomuzhi Co-authored-by: najagasi <49212852+najagasi@users.noreply.github.com> Co-authored-by: Namrata Jagasia Co-authored-by: Ajit Navasare Co-authored-by: v-ajnava Co-authored-by: orieldar Co-authored-by: aim-for-better Co-authored-by: Zhenyu Zhou Co-authored-by: Mark Young Co-authored-by: giakas Co-authored-by: ankushbindlish2 <34896519+ankushbindlish2@users.noreply.github.com> Co-authored-by: Richard Li Co-authored-by: Richard Li Co-authored-by: Yang Yuan Co-authored-by: pajind Co-authored-by: srcharug <62158390+srcharug@users.noreply.github.com> Co-authored-by: docohe <54349195+docohe@users.noreply.github.com> Co-authored-by: Nate Lehman Co-authored-by: yuzhangyi <44692931+yuzhangyi@users.noreply.github.com> Co-authored-by: zhanyu2014 Co-authored-by: Lei Ni <7233663+leni-msft@users.noreply.github.com> Co-authored-by: Liran Chen <1437075+liranc@users.noreply.github.com> Co-authored-by: Liran Chen Co-authored-by: Saif Kayani Co-authored-by: Lakshmi Priya Sekar Co-authored-by: Xiaoyun Ding Co-authored-by: Xiaoyun Ding Co-authored-by: chunyu3 Co-authored-by: jbuls <48029054+jbuls@users.noreply.github.com> Co-authored-by: sarajang <37909871+sarajang@users.noreply.github.com> Co-authored-by: Theodore Chang Co-authored-by: Frank Gao <4760010+gtxistxgao@users.noreply.github.com> Co-authored-by: Xiaofang Zhang Co-authored-by: ruchikaguptaa Co-authored-by: Paul Miller Co-authored-by: Marwan Ahmed Co-authored-by: animeshseth90 <64622013+animeshseth90@users.noreply.github.com> Co-authored-by: animesh Co-authored-by: Anirban Sarkar <33848291+asarkar84@users.noreply.github.com> Co-authored-by: Anirban Sarkar Co-authored-by: Youssef Shahin Co-authored-by: digavino <48699384+digavino@users.noreply.github.com> Co-authored-by: brpanask <64860651+brpanask@users.noreply.github.com> Co-authored-by: Shubham Dhond Co-authored-by: Jennifer Marsman Co-authored-by: Xia ZHU <398289931@qq.com> Co-authored-by: David Co-authored-by: David Ricciardi Co-authored-by: xaliciayang <59986952+xaliciayang@users.noreply.github.com> Co-authored-by: Ray Chen Co-authored-by: sashahdo <64434373+sashahdo@users.noreply.github.com> Co-authored-by: shawnxzq Co-authored-by: Shawn Xiao (IM) Co-authored-by: Richard Zhang Co-authored-by: Amir Keren Co-authored-by: Amir Keren Co-authored-by: sugandhaamic <65259091+sugandhaamic@users.noreply.github.com> Co-authored-by: Liang Wang Co-authored-by: Amit Aviram Co-authored-by: Ge Huang Co-authored-by: ge huang Co-authored-by: vasanthrajams <60414148+vasanthrajams@users.noreply.github.com> Co-authored-by: Heath Stewart Co-authored-by: vasanthrajams Co-authored-by: Hervey Wilson Co-authored-by: Rick Qing Xu Co-authored-by: kangtao Co-authored-by: Kang Tao Co-authored-by: Rahul Singh <53578268+rahuls-microsoft@users.noreply.github.com> Co-authored-by: Kamil Sobol <61715331+kasobol-msft@users.noreply.github.com> Co-authored-by: rickysun93 Co-authored-by: Haoran Sun Co-authored-by: Shangwei Sun <63389531+sunsw1994@users.noreply.github.com> Co-authored-by: gkgaurav31 Co-authored-by: Chuang <54572251+xccc-msft@users.noreply.github.com> Co-authored-by: bradrich-msft <53872276+bradrich-msft@users.noreply.github.com> Co-authored-by: Shinil Mannadath Co-authored-by: Dongwei Wang Co-authored-by: Raouf Merouche Co-authored-by: Ivan Matantsev Co-authored-by: tofriedl <50571149+tofriedl@users.noreply.github.com> Co-authored-by: Pan Li Co-authored-by: xuzhang3 <57888764+xuzhang3@users.noreply.github.com> Co-authored-by: lapradh <66009265+lapradh@users.noreply.github.com> Co-authored-by: Brian Crawford Co-authored-by: Dongwei Wang Co-authored-by: Laurent Mazuel Co-authored-by: jucarpio <57114852+jucarpio@users.noreply.github.com> Co-authored-by: Juan Carpio Castellanos Co-authored-by: Cecile Robert-Michon Co-authored-by: Rodge Fu Co-authored-by: Subrahmanyam Mandavilli Co-authored-by: Andrew <30499261+areddish@users.noreply.github.com> Co-authored-by: Joohee Suh <58048046+josuhazure@users.noreply.github.com> Co-authored-by: josuh Co-authored-by: chetmaddula <57730350+chetmaddula@users.noreply.github.com> Co-authored-by: Filiz Topatan Co-authored-by: Filiz Topatan Co-authored-by: Gokul Premraj Co-authored-by: Hyewon Lee Co-authored-by: Hyewon Lee Co-authored-by: Abbe Blank Co-authored-by: stuartko <47676853+stuartko@users.noreply.github.com> --- .../v2.1-preview.1/FormRecognizer.json | 1967 +++++++++++++++++ .../v2.1-preview.1/examples/AnalyzeBatch.json | 16 + .../examples/AnalyzeOperationResult.json | 25 + .../examples/BusinessCardBatch.json | 17 + .../examples/BusinessCardBatchResult.json | 24 + .../examples/ComposeModels.json | 21 + .../v2.1-preview.1/examples/CopyModel.json | 25 + .../examples/CopyModelAuthorization.json | 20 + .../examples/CopyOperationResult.json | 23 + .../CopyOperationResultWithErrors.json | 28 + .../v2.1-preview.1/examples/DeleteModel.json | 11 + .../v2.1-preview.1/examples/GetModel.json | 59 + .../v2.1-preview.1/examples/GetModels.json | 43 + .../examples/GetModelsSummary.json | 20 + .../v2.1-preview.1/examples/LayoutBatch.json | 16 + .../examples/LayoutBatchResult.json | 22 + .../examples/ReceiptsBatch.json | 15 + .../examples/ReceiptsBatchResult.json | 24 + .../v2.1-preview.1/examples/TrainBatch.json | 18 + .../examples/TrainBatchWithSubFolders.json | 23 + .../data-plane/FormRecognizer/readme.go.md | 4 +- .../data-plane/FormRecognizer/readme.md | 9 +- 22 files changed, 2427 insertions(+), 3 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/FormRecognizer.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/AnalyzeBatch.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/AnalyzeOperationResult.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/BusinessCardBatch.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/BusinessCardBatchResult.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ComposeModels.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyModel.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyModelAuthorization.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyOperationResult.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyOperationResultWithErrors.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/DeleteModel.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModel.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModels.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModelsSummary.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/LayoutBatch.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/LayoutBatchResult.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ReceiptsBatch.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ReceiptsBatchResult.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/TrainBatch.json create mode 100644 specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/TrainBatchWithSubFolders.json diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/FormRecognizer.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/FormRecognizer.json new file mode 100644 index 000000000000..9c401eb68afe --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/FormRecognizer.json @@ -0,0 +1,1967 @@ +{ + "swagger": "2.0", + "info": { + "version": "2.1-preview.1", + "title": "Form Recognizer Client", + "description": "Extracts information from forms and images into structured data." + }, + "securityDefinitions": { + "apim_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/formrecognizer/v2.1-preview.1", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "paths": { + "/custom/models": { + "post": { + "summary": "Train Custom Model", + "description": "Create and train a custom model. The request must include a source parameter that is either an externally accessible Azure storage blob container Uri (preferably a Shared Access Signature Uri) or valid path to a data folder in a locally mounted drive. When local paths are specified, they must follow the Linux/Unix path format and be an absolute path rooted to the input mount configuration setting value e.g., if '{Mounts:Input}' configuration setting value is '/input' then a valid source path would be '/input/contosodataset'. All data to be trained is expected to be under the source folder or sub folders under it. Models are trained using documents that are of the following content type - 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff'. Other type of content is ignored.", + "operationId": "TrainCustomModelAsync", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "trainRequest", + "in": "body", + "description": "Training request parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TrainRequest" + } + } + ], + "responses": { + "201": { + "description": "Request is queued successfully.", + "headers": { + "Location": { + "type": "string", + "description": "Location and ID of the model being trained. The status of model training is specified in the status property at the model location." + } + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Train custom model": { + "$ref": "./examples/TrainBatch.json" + }, + "Train custom model with subfolder filter options": { + "$ref": "./examples/TrainBatchWithSubFolders.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/custom/models/{modelId}": { + "get": { + "summary": "Get Custom Model", + "description": "Get detailed information about a custom model.", + "operationId": "GetCustomModel", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "Model identifier.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "includeKeys", + "in": "query", + "description": "Include list of extracted keys in model information.", + "required": false, + "default": false, + "type": "boolean", + "x-nullable": false + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Model" + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get custom model": { + "$ref": "./examples/GetModel.json" + } + } + }, + "delete": { + "summary": "Delete Custom Model", + "description": "Mark model for deletion. Model artifacts will be permanently removed within a predetermined period.", + "operationId": "DeleteCustomModel", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "Model identifier.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "204": { + "description": "Successfully marked model for deletion. Model artifacts will be removed within a predefined time period." + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete custom model": { + "$ref": "./examples/DeleteModel.json" + } + } + } + }, + "/custom/models/{modelId}/analyze": { + "post": { + "summary": "Analyze Form", + "description": "Extract key-value pairs, tables, and semantic values from a given document. The input document must be of one of the supported content types - 'application/pdf', 'image/jpeg', 'image/png' or 'image/tiff'. Alternatively, use 'application/json' type to specify the location (Uri or local path) of the document to be analyzed.", + "operationId": "AnalyzeWithCustomModel", + "consumes": [ + "application/pdf", + "application/json", + "image/jpeg", + "image/png", + "image/tiff" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "Model identifier.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "includeTextDetails", + "in": "query", + "description": "Include text lines and element references in the result.", + "required": false, + "default": false, + "type": "boolean", + "x-nullable": false + }, + { + "$ref": "#/parameters/FileStream" + } + ], + "responses": { + "202": { + "description": "Request is queued successfully.", + "headers": { + "Operation-Location": { + "type": "string", + "description": "URL containing the resultId used to track the progress and obtain the result of the analyze operation." + } + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Analyze form with custom model": { + "$ref": "./examples/AnalyzeBatch.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/custom/models/{modelId}/analyzeResults/{resultId}": { + "get": { + "summary": "Get Analyze Form Result", + "description": "Obtain current status and the result of the analyze form operation.", + "operationId": "GetAnalyzeFormResult", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "Model identifier.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "resultId", + "in": "path", + "description": "Analyze operation result identifier.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AnalyzeOperationResult" + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get analyze form result": { + "$ref": "./examples/AnalyzeOperationResult.json" + } + } + } + }, + "/custom/models/{modelId}/copy": { + "post": { + "summary": "Copy Custom Model", + "description": "Copy custom model stored in this resource (the source) to user specified target Form Recognizer resource.", + "operationId": "CopyCustomModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "Model identifier.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "copyRequest", + "in": "body", + "description": "Copy request parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CopyRequest" + } + } + ], + "responses": { + "202": { + "description": "Copy request is queued successfully.", + "headers": { + "Operation-Location": { + "type": "string", + "description": "URL containing the resultId used to track the progress and obtain the result of the copy operation." + } + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Copy custom model": { + "$ref": "./examples/CopyModel.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/custom/models/{modelId}/copyResults/{resultId}": { + "get": { + "summary": "Get Custom Model Copy Result", + "description": "Obtain current status and the result of a custom model copy operation.", + "operationId": "GetCustomModelCopyResult", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "modelId", + "in": "path", + "description": "Model identifier.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "resultId", + "in": "path", + "description": "Copy operation result identifier.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CopyOperationResult" + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get copy custom model result": { + "$ref": "./examples/CopyOperationResult.json" + }, + "Get copy custom model result with failures": { + "$ref": "./examples/CopyOperationResultWithErrors.json" + } + } + } + }, + "/custom/models/copyAuthorization": { + "post": { + "summary": "Generate Copy Authorization", + "description": "Generate authorization to copy a model into the target Form Recognizer resource.", + "operationId": "GenerateModelCopyAuthorization", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "201": { + "description": "Copy request is authorized successfully.", + "headers": { + "Location": { + "type": "string", + "description": "Location and ID of the model being copied. The status of model copy is specified in the status property at the model location." + } + }, + "schema": { + "$ref": "#/definitions/CopyAuthorizationResult" + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Copy custom model": { + "$ref": "./examples/CopyModelAuthorization.json" + } + } + } + }, + "/custom/models/compose": { + "post": { + "tags": [ + "Form" + ], + "summary": "Compose trained with labels models into one composed model.", + "description": "Compose request would include list of models ids.\r\nIt would validate what all models either trained with labels model or composed model.\r\nIt would validate limit of models put together.", + "operationId": "ComposeCustomModelsAsync", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "composeRequest", + "in": "body", + "description": "Compose models", + "required": true, + "schema": { + "$ref": "#/definitions/ComposeRequest" + } + } + ], + "responses": { + "201": { + "description": "Request is queued successfully.", + "headers": { + "Location": { + "type": "string", + "description": "Location and ID of the composed model. The status of composed model is specified in the status property at the model location." + } + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Compose custom models": { + "$ref": "./examples/ComposeModels.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/prebuilt/businessCard/analyze": { + "post": { + "summary": "Analyze Business Card", + "description": "Extract field text and semantic values from a given business card document. The input document must be of one of the supported content types - 'application/pdf', 'image/jpeg', 'image/png' or 'image/tiff'. Alternatively, use 'application/json' type to specify the location (Uri) of the document to be analyzed.", + "operationId": "AnalyzeBusinessCardAsync", + "consumes": [ + "application/pdf", + "application/json", + "image/jpeg", + "image/png", + "image/tiff" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "includeTextDetails", + "in": "query", + "description": "Include text lines and element references in the result.", + "required": false, + "default": false, + "type": "boolean", + "x-nullable": false + }, + { + "name": "locale", + "in": "query", + "description": "Locale of the business card. Supported locales include: en-AU, en-CA, en-GB, en-IN, en-US(default).", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/FileStream" + } + ], + "responses": { + "202": { + "description": "Request is queued successfully.", + "headers": { + "Operation-Location": { + "type": "string", + "description": "URL containing the resultId used to track the progress and obtain the result of the analyze operation." + } + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Analyze Business Card": { + "$ref": "./examples/BusinessCardBatch.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/prebuilt/businessCard/analyzeResults/{resultId}": { + "get": { + "summary": "Get Analyze Business Card Result", + "description": "Track the progress and obtain the result of the analyze business card operation.", + "operationId": "GetAnalyzeBusinessCardResult", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "resultId", + "in": "path", + "description": "Analyze operation result identifier.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AnalyzeOperationResult" + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get analyze business card result": { + "$ref": "./examples/BusinessCardBatchResult.json" + } + } + } + }, + "/prebuilt/receipt/analyze": { + "post": { + "summary": "Analyze Receipt", + "description": "Extract field text and semantic values from a given receipt document. The input document must be of one of the supported content types - 'application/pdf', 'image/jpeg', 'image/png' or 'image/tiff'. Alternatively, use 'application/json' type to specify the location (Uri) of the document to be analyzed.", + "operationId": "AnalyzeReceiptAsync", + "consumes": [ + "application/pdf", + "application/json", + "image/jpeg", + "image/png", + "image/tiff" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "includeTextDetails", + "in": "query", + "description": "Include text lines and element references in the result.", + "required": false, + "default": false, + "type": "boolean", + "x-nullable": false + }, + { + "name": "locale", + "in": "query", + "description": "Locale of the receipt. Supported locales include: en-AU, en-CA, en-GB, en-IN, en-US(default).", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/FileStream" + } + ], + "responses": { + "202": { + "description": "Request is queued successfully.", + "headers": { + "Operation-Location": { + "type": "string", + "description": "URL containing the resultId used to track the progress and obtain the result of the analyze operation." + } + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Analyze receipt": { + "$ref": "./examples/ReceiptsBatch.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/prebuilt/receipt/analyzeResults/{resultId}": { + "get": { + "summary": "Get Analyze Receipt Result", + "description": "Track the progress and obtain the result of the analyze receipt operation.", + "operationId": "GetAnalyzeReceiptResult", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "resultId", + "in": "path", + "description": "Analyze operation result identifier.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AnalyzeOperationResult" + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get analyze receipt result": { + "$ref": "./examples/ReceiptsBatchResult.json" + } + } + } + }, + "/layout/analyze": { + "post": { + "summary": "Analyze Layout", + "description": "Extract text and layout information from a given document. The input document must be of one of the supported content types - 'application/pdf', 'image/jpeg', 'image/png' or 'image/tiff'. Alternatively, use 'application/json' type to specify the location (Uri or local path) of the document to be analyzed.", + "operationId": "AnalyzeLayoutAsync", + "consumes": [ + "application/pdf", + "application/json", + "image/jpeg", + "image/png", + "image/tiff" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/FileStream" + } + ], + "responses": { + "202": { + "description": "Request is queued successfully.", + "headers": { + "Operation-Location": { + "type": "string", + "description": "URL containing the resultId used to track the progress and obtain the result of the analyze operation." + } + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Analyze layout": { + "$ref": "./examples/LayoutBatch.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/layout/analyzeResults/{resultId}": { + "get": { + "summary": "Get Analyze Layout Result", + "description": "Track the progress and obtain the result of the analyze layout operation", + "operationId": "GetAnalyzeLayoutResult", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "resultId", + "in": "path", + "description": "Analyze operation result identifier.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AnalyzeOperationResult" + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get analyze layout result": { + "$ref": "./examples/LayoutBatchResult.json" + } + } + } + } + }, + "x-ms-paths": { + "/custom/models?op=full": { + "get": { + "summary": "List Custom Models", + "description": "Get information about all custom models", + "operationId": "ListCustomModels", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "op", + "in": "query", + "description": "Specify whether to return summary or full list of models.", + "required": true, + "type": "string", + "enum": [ + "full" + ] + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Models" + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "modelList" + }, + "x-ms-examples": { + "List custom models": { + "$ref": "./examples/GetModels.json" + } + } + } + }, + "/custom/models?op=summary": { + "get": { + "summary": "Get Custom Models", + "description": "Get information about all custom models", + "operationId": "GetCustomModels", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "op", + "in": "query", + "description": "Specify whether to return summary or full list of models.", + "required": true, + "type": "string", + "enum": [ + "summary" + ] + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Models" + } + }, + "default": { + "description": "Response entity accompanying non-successful responses containing additional details about the error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get models summary": { + "$ref": "./examples/GetModelsSummary.json" + } + } + } + } + }, + "definitions": { + "OperationStatus": { + "type": "string", + "description": "Status of the queued operation.", + "enum": [ + "notStarted", + "running", + "succeeded", + "failed" + ], + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": false + }, + "x-nullable": false + }, + "CopyAuthorizationResult": { + "description": "Request parameter that contains authorization claims for copy operation.", + "required": [ + "modelId", + "accessToken", + "expirationDateTimeTicks" + ], + "type": "object", + "properties": { + "modelId": { + "description": "Model identifier.", + "type": "string" + }, + "accessToken": { + "description": "Token claim used to authorize the request.", + "type": "string" + }, + "expirationDateTimeTicks": { + "description": "The time when the access token expires. The date is represented as the number of seconds from 1970-01-01T0:0:0Z UTC until the expiration time.", + "type": "integer", + "format": "int64" + } + } + }, + "CopyRequest": { + "description": "Request parameter to copy an existing custom model from the source resource to a target resource referenced by the resource ID.", + "required": [ + "targetResourceId", + "targetResourceRegion", + "copyAuthorization" + ], + "type": "object", + "properties": { + "targetResourceId": { + "description": "Azure Resource Id of the target Form Recognizer resource where the model is copied to.", + "maxLength": 1024, + "type": "string", + "pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.CognitiveServices/accounts/[^/]*$", + "x-ms-azure-resource": true + }, + "targetResourceRegion": { + "description": "Location of the target Azure resource. A valid Azure region name supported by Cognitive Services.", + "type": "string", + "pattern": "^[a-z0-9]+$", + "minLength": 1, + "maxLength": 24 + }, + "copyAuthorization": { + "description": "Entity that encodes claims to authorize the copy request.", + "$ref": "#/definitions/CopyAuthorizationResult" + } + } + }, + "CopyOperationResult": { + "description": "Status and result of the queued copy operation.", + "type": "object", + "required": [ + "status", + "createdDateTime", + "lastUpdatedDateTime" + ], + "properties": { + "status": { + "description": "Operation status.", + "$ref": "#/definitions/OperationStatus" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date and time (UTC) when the copy operation was submitted.", + "type": "string", + "x-nullable": false + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Date and time (UTC) when the status was last updated.", + "type": "string", + "x-nullable": false + }, + "copyResult": { + "description": "Results of the copy operation.", + "$ref": "#/definitions/CopyResult" + } + } + }, + "CopyResult": { + "description": "Custom model copy result.", + "type": "object", + "required": [ + "modelId" + ], + "properties": { + "modelId": { + "description": "Identifier of the target model.", + "type": "string", + "format": "uuid" + }, + "errors": { + "description": "Errors returned during the copy operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorInformation" + } + } + } + }, + "AnalyzeOperationResult": { + "description": "Status and result of the queued analyze operation.", + "type": "object", + "required": [ + "status", + "createdDateTime", + "lastUpdatedDateTime" + ], + "properties": { + "status": { + "description": "Operation status.", + "$ref": "#/definitions/OperationStatus" + }, + "createdDateTime": { + "format": "date-time", + "description": "Date and time (UTC) when the analyze operation was submitted.", + "type": "string", + "x-nullable": false + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Date and time (UTC) when the status was last updated.", + "type": "string", + "x-nullable": false + }, + "analyzeResult": { + "description": "Results of the analyze operation.", + "$ref": "#/definitions/AnalyzeResult" + } + } + }, + "ModelName": { + "description": "Optional user defined model name (max length: 1024).", + "type": "string", + "x-nullable": false + }, + "TrainRequest": { + "description": "Request parameter to train a new custom model.", + "required": [ + "source" + ], + "type": "object", + "properties": { + "source": { + "description": "Source path containing the training documents.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "sourceFilter": { + "$ref": "#/definitions/TrainSourceFilter", + "description": "Filter to apply to the documents in the source path for training." + }, + "useLabelFile": { + "description": "Use label file for training a model.", + "type": "boolean", + "default": false + }, + "modelName": { + "$ref": "#/definitions/ModelName" + } + } + }, + "TrainSourceFilter": { + "description": "Filter to apply to the documents in the source path for training.", + "type": "object", + "properties": { + "prefix": { + "description": "A case-sensitive prefix string to filter documents in the source path for training. For example, when using a Azure storage blob Uri, use the prefix to restrict sub folders for training.", + "maxLength": 1024, + "minLength": 0, + "type": "string" + }, + "includeSubFolders": { + "description": "A flag to indicate if sub folders within the set of prefix folders will also need to be included when searching for content to be preprocessed.", + "type": "boolean", + "default": false, + "x-nullable": false + } + } + }, + "TrainResult": { + "description": "Custom model training result.", + "type": "object", + "required": [ + "trainingDocuments" + ], + "properties": { + "trainingDocuments": { + "description": "List of the documents used to train the model and any errors reported in each document.", + "type": "array", + "items": { + "$ref": "#/definitions/TrainingDocumentInfo" + } + }, + "fields": { + "description": "List of fields used to train the model and the train operation error reported by each.", + "type": "array", + "items": { + "$ref": "#/definitions/FormFieldsReport" + } + }, + "averageModelAccuracy": { + "description": "Average accuracy.", + "type": "number", + "x-nullable": false + }, + "modelId": { + "description": "Model identifier.", + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "errors": { + "description": "Errors returned during the training operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorInformation" + } + } + } + }, + "SourcePath": { + "description": "Uri or local path to source data.", + "type": "object", + "properties": { + "source": { + "description": "File source path.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + } + } + }, + "Attributes": { + "description": "Optional model attributes.", + "type": "object", + "properties": { + "isComposed": { + "description": "Is this model composed? (default: false).", + "type": "boolean", + "default": false, + "x-nullable": false + } + } + }, + "ModelInfo": { + "description": "Basic custom model information.", + "type": "object", + "required": [ + "modelId", + "status", + "createdDateTime", + "lastUpdatedDateTime" + ], + "properties": { + "modelId": { + "description": "Model identifier.", + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "status": { + "description": "Status of the model.", + "enum": [ + "creating", + "ready", + "invalid" + ], + "type": "string", + "x-ms-enum": { + "name": "ModelStatus", + "modelAsString": false + }, + "x-nullable": false + }, + "createdDateTime": { + "format": "date-time", + "description": "Date and time (UTC) when the model was created.", + "type": "string", + "x-nullable": false + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Date and time (UTC) when the status was last updated.", + "type": "string", + "x-nullable": false + }, + "modelName": { + "$ref": "#/definitions/ModelName" + }, + "attributes": { + "$ref": "#/definitions/Attributes" + } + } + }, + "Models": { + "description": "Response to the list custom models operation.", + "type": "object", + "properties": { + "summary": { + "description": "Summary of all trained custom models.", + "type": "object", + "required": [ + "count", + "limit", + "lastUpdatedDateTime" + ], + "properties": { + "count": { + "description": "Current count of trained custom models.", + "type": "integer", + "x-nullable": false + }, + "limit": { + "description": "Max number of models that can be trained for this account.", + "type": "integer", + "x-nullable": false + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Date and time (UTC) when the summary was last updated.", + "type": "string", + "x-nullable": false + } + } + }, + "modelList": { + "description": "Collection of trained custom models.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelInfo" + } + }, + "nextLink": { + "description": "Link to the next page of custom models.", + "type": "string" + } + } + }, + "Model": { + "description": "Response to the get custom model operation.", + "type": "object", + "required": [ + "modelInfo" + ], + "properties": { + "modelInfo": { + "$ref": "#/definitions/ModelInfo" + }, + "keys": { + "$ref": "#/definitions/KeysResult" + }, + "trainResult": { + "description": "Training result for custom model.", + "$ref": "#/definitions/TrainResult" + }, + "composedTrainResults": { + "type": "array", + "description": "Training result for composed model.", + "items": { + "$ref": "#/definitions/TrainResult" + } + } + } + }, + "KeysResult": { + "description": "Keys extracted by the custom model.", + "type": "object", + "required": [ + "clusters" + ], + "properties": { + "clusters": { + "description": "Object mapping clusterIds to a list of keys.", + "type": "object", + "additionalProperties": { + "type": "array", + "uniqueItems": true, + "items": { + "type": "string" + } + } + } + } + }, + "TrainingDocumentInfo": { + "description": "Report for a custom model training document.", + "type": "object", + "required": [ + "documentName", + "pages", + "errors", + "status" + ], + "properties": { + "documentName": { + "description": "Training document name.", + "type": "string" + }, + "pages": { + "format": "int32", + "description": "Total number of pages trained.", + "type": "integer", + "x-nullable": false + }, + "errors": { + "description": "List of errors.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorInformation" + } + }, + "status": { + "description": "Status of the training operation.", + "enum": [ + "succeeded", + "partiallySucceeded", + "failed" + ], + "type": "string", + "x-ms-enum": { + "name": "TrainStatus", + "modelAsString": false + }, + "x-nullable": false + } + } + }, + "FormFieldsReport": { + "description": "Report for a custom model training field.", + "type": "object", + "required": [ + "fieldName", + "accuracy" + ], + "properties": { + "fieldName": { + "description": "Training field name.", + "type": "string" + }, + "accuracy": { + "description": "Estimated extraction accuracy for this field.", + "type": "number", + "x-nullable": false + } + } + }, + "ErrorResponse": { + "type": "object", + "required": [ + "error" + ], + "properties": { + "error": { + "$ref": "#/definitions/ErrorInformation" + } + } + }, + "ErrorInformation": { + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "ComposeRequest": { + "description": "Request contract for compose operation.", + "required": [ + "modelIds" + ], + "type": "object", + "properties": { + "modelIds": { + "description": "List of model ids to compose.", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string", + "format": "uuid" + } + }, + "modelName": { + "$ref": "#/definitions/ModelName" + } + } + }, + "AnalyzeResult": { + "description": "Analyze operation result.", + "type": "object", + "required": [ + "version", + "readResults" + ], + "properties": { + "version": { + "description": "Version of schema used for this result.", + "type": "string" + }, + "readResults": { + "description": "Text extracted from the input.", + "type": "array", + "items": { + "$ref": "#/definitions/ReadResult" + } + }, + "pageResults": { + "description": "Page-level information extracted from the input.", + "type": "array", + "items": { + "$ref": "#/definitions/PageResult" + } + }, + "documentResults": { + "description": "Document-level information extracted from the input.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentResult" + } + }, + "errors": { + "description": "List of errors reported during the analyze operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorInformation" + } + } + } + }, + "ReadResult": { + "description": "Text extracted from a page in the input document.", + "type": "object", + "required": [ + "page", + "angle", + "width", + "height", + "unit" + ], + "properties": { + "page": { + "description": "The 1-based page number in the input document.", + "type": "integer", + "minimum": 1, + "x-nullable": false + }, + "angle": { + "description": "The general orientation of the text in clockwise direction, measured in degrees between (-180, 180].", + "type": "number", + "minimum": -180, + "maximum": 180, + "exclusiveMinimum": true, + "x-nullable": false + }, + "width": { + "description": "The width of the image/PDF in pixels/inches, respectively.", + "type": "number", + "minimum": 0, + "x-nullable": false + }, + "height": { + "description": "The height of the image/PDF in pixels/inches, respectively.", + "type": "number", + "minimum": 0, + "x-nullable": false + }, + "unit": { + "description": "The unit used by the width, height and boundingBox properties. For images, the unit is \"pixel\". For PDF, the unit is \"inch\".", + "type": "string", + "enum": [ + "pixel", + "inch" + ], + "x-ms-enum": { + "name": "LengthUnit", + "modelAsString": false + }, + "x-nullable": false + }, + "language": { + "description": "The detected language on the page overall.", + "$ref": "#/definitions/Language" + }, + "lines": { + "description": "When includeTextDetails is set to true, a list of recognized text lines. The maximum number of lines returned is 300 per page. The lines are sorted top to bottom, left to right, although in certain cases proximity is treated with higher priority. As the sorting order depends on the detected text, it may change across images and OCR version updates. Thus, business logic should be built upon the actual line location instead of order.", + "type": "array", + "items": { + "$ref": "#/definitions/TextLine" + } + }, + "selectionMarks": { + "description": "List of selection marks extracted from the page.", + "type": "array", + "items": { + "$ref": "#/definitions/SelectionMark" + } + } + } + }, + "Language": { + "description": "Language code", + "type": "string", + "enum": [ + "en", + "es" + ], + "x-ms-enum": { + "name": "Language", + "modelAsString": true + }, + "x-nullable": false + }, + "TextLine": { + "description": "An object representing an extracted text line.", + "type": "object", + "required": [ + "text", + "boundingBox", + "words" + ], + "properties": { + "text": { + "description": "The text content of the line.", + "type": "string" + }, + "boundingBox": { + "description": "Bounding box of an extracted line.", + "$ref": "#/definitions/BoundingBox" + }, + "language": { + "description": "The detected language of this line, if different from the overall page language.", + "$ref": "#/definitions/Language" + }, + "words": { + "description": "List of words in the text line.", + "type": "array", + "items": { + "$ref": "#/definitions/TextWord" + } + } + } + }, + "TextWord": { + "description": "An object representing a word.", + "type": "object", + "required": [ + "boundingBox", + "text" + ], + "properties": { + "text": { + "description": "The text content of the word.", + "type": "string" + }, + "boundingBox": { + "description": "Bounding box of an extracted word.", + "$ref": "#/definitions/BoundingBox" + }, + "confidence": { + "description": "Confidence value.", + "$ref": "#/definitions/Confidence" + } + } + }, + "BoundingBox": { + "description": "Quadrangle bounding box, with coordinates specified relative to the top-left of the original image. The eight numbers represent the four points, clockwise from the top-left corner relative to the text orientation. For image, the (x, y) coordinates are measured in pixels. For PDF, the (x, y) coordinates are measured in inches.", + "type": "array", + "minItems": 8, + "maxItems": 8, + "items": { + "type": "number", + "x-nullable": false + } + }, + "PageResult": { + "description": "Extracted information from a single page.", + "type": "object", + "required": [ + "page" + ], + "properties": { + "page": { + "description": "Page number.", + "type": "integer", + "format": "int32", + "minimum": 1, + "x-nullable": false + }, + "clusterId": { + "description": "Cluster identifier.", + "type": "integer", + "format": "int32", + "minimum": 0, + "x-nullable": false + }, + "keyValuePairs": { + "description": "List of key-value pairs extracted from the page.", + "type": "array", + "items": { + "$ref": "#/definitions/KeyValuePair" + } + }, + "tables": { + "description": "List of data tables extracted from the page.", + "type": "array", + "items": { + "$ref": "#/definitions/DataTable" + } + } + } + }, + "KeyValuePair": { + "description": "Information about the extracted key-value pair.", + "type": "object", + "required": [ + "key", + "value", + "confidence" + ], + "properties": { + "label": { + "description": "A user defined label for the key/value pair entry.", + "type": "string" + }, + "key": { + "description": "Information about the extracted key in a key-value pair.", + "$ref": "#/definitions/KeyValueElement" + }, + "value": { + "description": "Information about the extracted value in a key-value pair.", + "$ref": "#/definitions/KeyValueElement" + }, + "confidence": { + "description": "Confidence value.", + "$ref": "#/definitions/Confidence" + } + } + }, + "KeyValueElement": { + "description": "Information about the extracted key or value in a key-value pair.", + "type": "object", + "required": [ + "text" + ], + "properties": { + "type": { + "$ref": "#/definitions/KeyValueType" + }, + "text": { + "description": "The text content of the key or value.", + "type": "string" + }, + "boundingBox": { + "description": "Bounding box of the key or value.", + "$ref": "#/definitions/BoundingBox" + }, + "elements": { + "description": "When includeTextDetails is set to true, a list of references to the text elements constituting this key or value.", + "type": "array", + "items": { + "$ref": "#/definitions/ElementReference" + } + } + } + }, + "KeyValueType": { + "type": "string", + "description": "Semantic data type of the key value element.", + "enum": [ + "string", + "selectionMark" + ], + "x-ms-enum": { + "name": "KeyValueType", + "modelAsString": true + }, + "x-nullable": false + }, + "ElementReference": { + "description": "Reference to a line, word or selection mark.", + "type": "string" + }, + "SelectionMark": { + "description": "Information about the extracted selection mark.", + "type": "object", + "required": [ + "boundingBox", + "confidence", + "state" + ], + "properties": { + "boundingBox": { + "description": "Bounding box of the selection mark.", + "$ref": "#/definitions/BoundingBox" + }, + "confidence": { + "description": "Confidence value.", + "$ref": "#/definitions/Confidence" + }, + "state": { + "description": "State of the selection mark.", + "type": "string", + "enum": [ + "selected", + "unselected" + ] + } + } + }, + "DataTable": { + "description": "Information about the extracted table contained in a page.", + "type": "object", + "required": [ + "rows", + "columns", + "cells" + ], + "properties": { + "rows": { + "description": "Number of rows.", + "type": "integer", + "minimum": 1, + "x-nullable": false + }, + "columns": { + "description": "Number of columns.", + "type": "integer", + "minimum": 1, + "x-nullable": false + }, + "cells": { + "description": "List of cells contained in the table.", + "type": "array", + "items": { + "$ref": "#/definitions/DataTableCell" + } + } + } + }, + "DataTableCell": { + "description": "Information about the extracted cell in a table.", + "type": "object", + "required": [ + "rowIndex", + "columnIndex", + "text", + "boundingBox", + "confidence" + ], + "properties": { + "rowIndex": { + "description": "Row index of the cell.", + "type": "integer", + "minimum": 0, + "x-nullable": false + }, + "columnIndex": { + "description": "Column index of the cell.", + "type": "integer", + "minimum": 0, + "x-nullable": false + }, + "rowSpan": { + "description": "Number of rows spanned by this cell.", + "type": "integer", + "minimum": 1, + "default": 1, + "x-nullable": false + }, + "columnSpan": { + "description": "Number of columns spanned by this cell.", + "type": "integer", + "minimum": 1, + "default": 1, + "x-nullable": false + }, + "text": { + "description": "Text content of the cell.", + "type": "string" + }, + "boundingBox": { + "description": "Bounding box of the cell.", + "$ref": "#/definitions/BoundingBox" + }, + "confidence": { + "description": "Confidence value.", + "$ref": "#/definitions/Confidence" + }, + "elements": { + "description": "When includeTextDetails is set to true, a list of references to the text elements constituting this table cell.", + "type": "array", + "items": { + "$ref": "#/definitions/ElementReference" + } + }, + "isHeader": { + "description": "Is the current cell a header cell?", + "type": "boolean", + "default": false, + "x-nullable": false + }, + "isFooter": { + "description": "Is the current cell a footer cell?", + "type": "boolean", + "default": false, + "x-nullable": false + } + } + }, + "DocumentResult": { + "description": "A set of extracted fields corresponding to the input document.", + "type": "object", + "required": [ + "docType", + "pageRange", + "fields" + ], + "properties": { + "docType": { + "description": "Document type.", + "type": "string" + }, + "modelId": { + "description": "Model identifier.", + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "pageRange": { + "description": "First and last page number where the document is found.", + "type": "array", + "minItems": 2, + "maxItems": 2, + "items": { + "type": "integer", + "minimum": 1, + "x-nullable": false + } + }, + "docTypeConfidence": { + "description": "Predicted document type confidence.", + "$ref": "#/definitions/Confidence" + }, + "fields": { + "description": "Dictionary of named field values.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/FieldValue" + } + } + } + }, + "FieldValue": { + "description": "Recognized field value.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "Type of field value.", + "$ref": "#/definitions/FieldValueType" + }, + "valueString": { + "description": "String value.", + "type": "string" + }, + "valueDate": { + "description": "Date value.", + "format": "date", + "type": "string", + "x-nullable": false + }, + "valueTime": { + "description": "Time value.", + "format": "time", + "type": "string", + "x-nullable": false + }, + "valuePhoneNumber": { + "description": "Phone number value.", + "type": "string" + }, + "valueNumber": { + "description": "Floating point value.", + "type": "number", + "x-nullable": false + }, + "valueInteger": { + "description": "Integer value.", + "type": "integer", + "x-nullable": false + }, + "valueArray": { + "description": "Array of field values.", + "type": "array", + "items": { + "$ref": "#/definitions/FieldValue" + } + }, + "valueObject": { + "description": "Dictionary of named field values.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/FieldValue" + } + }, + "valueSelectionMark": { + "description": "Selection mark value.", + "type": "string", + "enum": [ + "selected", + "unselected" + ], + "x-nullable": false + }, + "text": { + "description": "Text content of the extracted field.", + "type": "string" + }, + "boundingBox": { + "description": "Bounding box of the field value, if appropriate.", + "$ref": "#/definitions/BoundingBox" + }, + "confidence": { + "description": "Confidence score.", + "$ref": "#/definitions/Confidence" + }, + "elements": { + "description": "When includeTextDetails is set to true, a list of references to the text elements constituting this field.", + "type": "array", + "items": { + "$ref": "#/definitions/ElementReference" + } + }, + "page": { + "description": "The 1-based page number in the input document.", + "type": "integer", + "minimum": 1, + "x-nullable": false + } + } + }, + "FieldValueType": { + "type": "string", + "description": "Semantic data type of the field value.", + "enum": [ + "string", + "date", + "time", + "phoneNumber", + "number", + "integer", + "array", + "object", + "selectionMark" + ], + "x-ms-enum": { + "name": "FieldValueType", + "modelAsString": false + }, + "x-nullable": false + }, + "Confidence": { + "description": "Confidence value.", + "type": "number", + "minimum": 0, + "maximum": 1, + "x-nullable": false + } + }, + "parameters": { + "Endpoint": { + "name": "endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "FileStream": { + "name": "fileStream", + "description": ".json, .pdf, .jpg, .png or .tiff type file stream.", + "x-ms-parameter-location": "method", + "in": "body", + "schema": { + "$ref": "#/definitions/SourcePath" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/AnalyzeBatch.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/AnalyzeBatch.json new file mode 100644 index 000000000000..01eb4730ed08 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/AnalyzeBatch.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "modelId": "{modelId}", + "body": {} + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/formrecognizer/v2.1-preview.1/custom/models/{modelId}/analyzeResults/{resultId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/AnalyzeOperationResult.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/AnalyzeOperationResult.json new file mode 100644 index 000000000000..5b8a65ac0a6b --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/AnalyzeOperationResult.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "modelId": "{modelId}", + "resultId": "{result Id}", + "body": {} + }, + "responses": { + "200": { + "body": { + "status": "running", + "createdDateTime": "2019-05-01T10:53:21Z", + "lastUpdatedDateTime": "2019-05-01T10:53:23Z", + "analyzeResult": { + "version": "v2.1", + "readResults": [], + "pageResults": [], + "documentResults": [], + "errors": [] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/BusinessCardBatch.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/BusinessCardBatch.json new file mode 100644 index 000000000000..6521a5fa2244 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/BusinessCardBatch.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "body": { + "source": "http://www.example.com/image.jpg" + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/formrecognizer/v2.1-preview.1/prebuilt/businessCard/analyzeResults/{resultId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/BusinessCardBatchResult.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/BusinessCardBatchResult.json new file mode 100644 index 000000000000..2cf7aa15db22 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/BusinessCardBatchResult.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "resultId": "{result Id}", + "body": {} + }, + "responses": { + "200": { + "body": { + "status": "running", + "createdDateTime": "2019-05-01T10:53:21Z", + "lastUpdatedDateTime": "2019-05-01T10:53:23Z", + "analyzeResult": { + "version": "v2.1", + "readResults": [], + "pageResults": [], + "documentResults": [], + "errors": [] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ComposeModels.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ComposeModels.json new file mode 100644 index 000000000000..0fecac98f79b --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ComposeModels.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "body": {}, + "composeRequest": { + "modelIds": [ + "4afb20d6-3ed0-4cde-ba40-dbd6207268dd", + "6f841356-aa32-42c9-a739-2182c47b79c9" + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "{endpoint}/formrecognizer/v2.1-preview.1/custom/models/{modelId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyModel.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyModel.json new file mode 100644 index 000000000000..34d6aacb688e --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyModel.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "modelId": "{modelId}", + "body": {}, + "copyRequest": { + "targetResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{resourceName}", + "targetResourceRegion": "westus2", + "copyAuthorization": { + "modelId": "{modelId}", + "accessToken": "{accessToken}", + "expirationDateTimeTicks": 637190189980000000 + } + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/formrecognizer/v2.1-preview.1/custom/models/{modelId}/copyResults/{resultId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyModelAuthorization.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyModelAuthorization.json new file mode 100644 index 000000000000..2acc95b1fce5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyModelAuthorization.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "body": {} + }, + "responses": { + "201": { + "headers": { + "Location": "{endpoint}/formrecognizer/v2.1-preview.1/custom/models/{modelId}" + }, + "body": { + "modelId": "{modelId}", + "accessToken": "{accessToken}", + "expirationDateTimeTicks": 637190189980000000 + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyOperationResult.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyOperationResult.json new file mode 100644 index 000000000000..f7b7b1163884 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyOperationResult.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "modelId": "{modelId}", + "resultId": "{resultId}", + "body": {} + }, + "responses": { + "200": { + "body": { + "status": "succeeded", + "createdDateTime": "2020-01-01T00:00:00Z", + "lastUpdatedDateTime": "2020-01-01T00:01:00Z", + "copyResult": { + "modelId": "{modelId}", + "errors": [] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyOperationResultWithErrors.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyOperationResultWithErrors.json new file mode 100644 index 000000000000..853dd73e595e --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/CopyOperationResultWithErrors.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "modelId": "{modelId}", + "resultId": "{resultId}", + "body": {} + }, + "responses": { + "200": { + "body": { + "status": "failed", + "createdDateTime": "2020-01-01T00:00:00Z", + "lastUpdatedDateTime": "2020-01-01T00:01:00Z", + "copyResult": { + "modelId": "{modelId}", + "errors": [ + { + "code": "ResourceResolverError", + "message": "{ErrorMessage}" + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/DeleteModel.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/DeleteModel.json new file mode 100644 index 000000000000..c945ec953dd4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/DeleteModel.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "modelId": "{modelId}", + "body": {} + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModel.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModel.json new file mode 100644 index 000000000000..df1c4b66b252 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModel.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "modelId": "{modelId}", + "body": {} + }, + "responses": { + "200": { + "body": { + "modelInfo": { + "modelId": "f973e3c1-1148-43bb-bea8-49d0603ab3a8", + "modelName": "my composed model", + "status": "ready", + "createdDateTime": "2019-05-01T10:53:21Z", + "lastUpdatedDateTime": "2019-05-01T10:53:23Z", + "attributes": { + "isComposed": true + } + }, + "keys": { + "clusters": { + "0": [ + "Invoice", + "123112313" + ], + "1": [ + "Please remit payment to:", + "Microsoft" + ] + } + }, + "trainResult": { + "trainingDocuments": [], + "fields": [], + "averageModelAccuracy": 0, + "errors": [] + }, + "composedTrainResults": [ + { + "modelId": "4afb20d6-3ed0-4cde-ba40-dbd6207268dd", + "trainingDocuments": [], + "fields": [], + "averageModelAccuracy": 0, + "errors": [] + }, + { + "modelId": "6f841356-aa32-42c9-a739-2182c47b79c9", + "trainingDocuments": [], + "fields": [], + "averageModelAccuracy": 0, + "errors": [] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModels.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModels.json new file mode 100644 index 000000000000..36ee11465e4f --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModels.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "op": "full", + "body": {} + }, + "responses": { + "200": { + "body": { + "summary": { + "count": 2, + "limit": 5000, + "lastUpdatedDateTime": "2019-05-01T10:53:21Z" + }, + "modelList": [ + { + "modelId": "f973e3c1-1148-43bb-bea8-49d0603ab3a8", + "modelName": "test model 1", + "status": "ready", + "createdDateTime": "2019-05-01T10:53:21Z", + "lastUpdatedDateTime": "2019-05-01T10:53:23Z", + "attributes": { + "isComposed": false + } + }, + { + "modelId": "f973e3c1-0001-43bb-bea8-49d0603ab3a8", + "modelName": "test model 2", + "status": "ready", + "createdDateTime": "2019-05-01T10:53:21Z", + "lastUpdatedDateTime": "2019-05-01T10:53:23Z", + "attributes": { + "isComposed": true + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModelsSummary.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModelsSummary.json new file mode 100644 index 000000000000..507495b78206 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/GetModelsSummary.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "op": "summary", + "body": {} + }, + "responses": { + "200": { + "body": { + "summary": { + "count": 5, + "limit": 5000, + "lastUpdatedDateTime": "2019-05-01T10:53:21Z" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/LayoutBatch.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/LayoutBatch.json new file mode 100644 index 000000000000..1495017a7252 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/LayoutBatch.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "language": "en", + "body": {} + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/formrecognizer/v2.1-preview.1/layout/analyzeResults/{resultId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/LayoutBatchResult.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/LayoutBatchResult.json new file mode 100644 index 000000000000..2a258bfe71bc --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/LayoutBatchResult.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "resultId": "{result Id}", + "body": {} + }, + "responses": { + "200": { + "body": { + "status": "succeeded", + "createdDateTime": "2019-05-01T10:53:21Z", + "lastUpdatedDateTime": "2019-05-01T10:53:23Z", + "analyzeResult": { + "version": "v2.1", + "readResults": [], + "pageResults": [] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ReceiptsBatch.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ReceiptsBatch.json new file mode 100644 index 000000000000..0790699b3fac --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ReceiptsBatch.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "body": {} + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/formrecognizer/v2.1-preview.1/prebuilt/receipt/analyzeResults/{resultId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ReceiptsBatchResult.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ReceiptsBatchResult.json new file mode 100644 index 000000000000..2cf7aa15db22 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/ReceiptsBatchResult.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "resultId": "{result Id}", + "body": {} + }, + "responses": { + "200": { + "body": { + "status": "running", + "createdDateTime": "2019-05-01T10:53:21Z", + "lastUpdatedDateTime": "2019-05-01T10:53:23Z", + "analyzeResult": { + "version": "v2.1", + "readResults": [], + "pageResults": [], + "documentResults": [], + "errors": [] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/TrainBatch.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/TrainBatch.json new file mode 100644 index 000000000000..b67143b72085 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/TrainBatch.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "body": {}, + "trainRequest": { + "source": "/input/data1" + } + }, + "responses": { + "201": { + "headers": { + "Location": "{endpoint}/formrecognizer/v2.1-preview.1/custom/models/{modelId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/TrainBatchWithSubFolders.json b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/TrainBatchWithSubFolders.json new file mode 100644 index 000000000000..ec88bff4f0d5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.1/examples/TrainBatchWithSubFolders.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "endpoint": "{endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "body": {}, + "trainRequest": { + "source": "/input/data1", + "sourceFilter": { + "prefix": "", + "includeSubFolders": false + }, + "useLabelFile": false + } + }, + "responses": { + "201": { + "headers": { + "Location": "{endpoint}/formrecognizer/v2.1-preview.1/custom/models/{modelId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/readme.go.md b/specification/cognitiveservices/data-plane/FormRecognizer/readme.go.md index 1f5392f74b54..a3f839b98e64 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/readme.go.md +++ b/specification/cognitiveservices/data-plane/FormRecognizer/readme.go.md @@ -1,4 +1,4 @@ -## Go +### Go These settings apply only when `--go` is specified on the command line. @@ -23,4 +23,4 @@ Please also specify `--go-sdk-folder= Date: Thu, 10 Sep 2020 18:22:55 -0700 Subject: [PATCH 033/164] Dev deviceprovisioningservices microsoft.devices 2020 09 01 preview (#10735) * Adds base for updating Microsoft.Devices from version stable/2020-03-01 to version 2020-09-01-preview * Updates readme * Updates API version in new specs and examples * Add CMK encryption properties * Add sample for CMK * Prettier format * Add example reference * Add encryption to response in example * Removing example for now since this is still WIP --- .../DPSCertificateCreateOrUpdate.json | 30 + .../examples/DPSCheckNameAvailability.json | 18 + .../examples/DPSCreate.json | 65 + ...eateOrUpdatePrivateEndpointConnection.json | 53 + .../examples/DPSDelete.json | 14 + .../examples/DPSDeleteCertificate.json | 14 + .../DPSDeletePrivateEndpointConnection.json | 46 + .../examples/DPSGenerateVerificationCode.json | 26 + .../2020-09-01-preview/examples/DPSGet.json | 33 + .../examples/DPSGetCertificate.json | 27 + .../examples/DPSGetCertificates.json | 30 + .../examples/DPSGetKey.json | 19 + .../examples/DPSGetOperationResult.json | 17 + .../DPSGetPrivateEndpointConnection.json | 28 + .../examples/DPSGetPrivateLinkResources.json | 27 + .../examples/DPSGetValidSku.json | 19 + .../examples/DPSListByResourceGroup.json | 55 + .../examples/DPSListBySubscription.json | 54 + .../examples/DPSListKeys.json | 28 + .../DPSListPrivateEndpointConnections.json | 29 + .../examples/DPSListPrivateLinkResources.json | 30 + .../examples/DPSOperations.json | 293 ++ .../2020-09-01-preview/examples/DPSPatch.json | 41 + .../examples/DPSVerifyCertificate.json | 31 + .../preview/2020-09-01-preview/iotdps.json | 2546 +++++++++++++++++ .../resource-manager/readme.md | 11 +- 26 files changed, 3583 insertions(+), 1 deletion(-) create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSCertificateCreateOrUpdate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSCheckNameAvailability.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSCreate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSCreateOrUpdatePrivateEndpointConnection.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSDelete.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSDeleteCertificate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSDeletePrivateEndpointConnection.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGenerateVerificationCode.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGet.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetCertificate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetCertificates.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetKey.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetOperationResult.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetPrivateEndpointConnection.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetPrivateLinkResources.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetValidSku.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSListByResourceGroup.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSListBySubscription.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSListKeys.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSListPrivateEndpointConnections.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSListPrivateLinkResources.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSOperations.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSPatch.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSVerifyCertificate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/iotdps.json diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSCertificateCreateOrUpdate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSCertificateCreateOrUpdate.json new file mode 100644 index 000000000000..0d44e7116ea7 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSCertificateCreateOrUpdate.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "certificateDescription": { + "certificate": "############################################" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServives/myFirstProvisioningService/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/ProvisioningServices/Certificates", + "etag": "AAAAAAExpNs=" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSCheckNameAvailability.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSCheckNameAvailability.json new file mode 100644 index 000000000000..74cce29667f1 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSCheckNameAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "arguments": { + "name": "test213123" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "Invalid", + "message": "name is valid" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSCreate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSCreate.json new file mode 100644 index 000000000000..01f3b3a90544 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSCreate.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "iotDpsDescription": { + "location": "East US", + "properties": {}, + "sku": { + "name": "S1", + "capacity": 1 + }, + "tags": {} + } + }, + "responses": { + "200": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "authorizationPolicies": [] + }, + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + }, + "201": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "authorizationPolicies": [] + }, + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSCreateOrUpdatePrivateEndpointConnection.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSCreateOrUpdatePrivateEndpointConnection.json new file mode 100644 index 000000000000..94a8d73c220e --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSCreateOrUpdatePrivateEndpointConnection.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection", + "privateEndpointConnection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSDelete.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSDelete.json new file mode 100644 index 000000000000..ddfb3bd52182 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": {}, + "204": {}, + "202": {}, + "404": {} + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSDeleteCertificate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSDeleteCertificate.json new file mode 100644 index 000000000000..21358dfecdf2 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSDeleteCertificate.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSDeletePrivateEndpointConnection.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..e2a7eeb7cb1b --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSDeletePrivateEndpointConnection.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Disconnected", + "description": "Deleted", + "actionsRequired": "None" + } + } + } + }, + "202": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Disconnected", + "description": "Deleted", + "actionsRequired": "None" + } + } + } + }, + "204": {} + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGenerateVerificationCode.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGenerateVerificationCode.json new file mode 100644 index 000000000000..1dde48f61e65 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGenerateVerificationCode.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=" + }, + "responses": { + "200": { + "body": { + "name": "cert", + "properties": { + "verificationCode": "##################################", + "subject": "CN=andbucdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "##############################", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:26:56 GMT" + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGet.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGet.json new file mode 100644 index 000000000000..d7879f8bff2e --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "authorizationPolicies": [] + }, + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetCertificate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetCertificate.json new file mode 100644 index 000000000000..eee88e44a0cf --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetCertificate.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert" + }, + "responses": { + "200": { + "body": { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/andbuc-hub/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/ProvisioningServices/Certificates", + "etag": "AAAAAAExpNs=" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetCertificates.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetCertificates.json new file mode 100644 index 000000000000..0087f4a66764 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetCertificates.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/andbuc-hub/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/ProvisioningServices/Certificates", + "etag": "AAAAAAExpNs=" + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetKey.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetKey.json new file mode 100644 index 000000000000..e75a9b585328 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetKey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "keyName": "testKey" + }, + "responses": { + "200": { + "body": { + "keyName": "testKey", + "primaryKey": "##################################", + "secondaryKey": "################################", + "rights": "RegistrationStatusWrite" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetOperationResult.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetOperationResult.json new file mode 100644 index 000000000000..e92100cd61db --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetOperationResult.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "operationId": "MTY5OTNmZDctODI5Yy00N2E2LTkxNDQtMDU1NGIyYzY1ZjRl", + "asyncinfo": "1508265712453" + }, + "responses": { + "200": { + "body": { + "status": "Succeeded" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetPrivateEndpointConnection.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..465769974a22 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetPrivateEndpointConnection.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my request!", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetPrivateLinkResources.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetPrivateLinkResources.json new file mode 100644 index 000000000000..7761f6f3a8ef --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetPrivateLinkResources.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "groupId": "iotDps" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateLinkResources/iotDps", + "name": "iotDps", + "type": "Microsoft.Devices/ProvisioningServices/PrivateLinkResources", + "properties": { + "groupId": "iotDps", + "requiredMembers": [ + "iotDps" + ], + "requiredZoneNames": [ + "privatelink.azure-devices-provisioning.net" + ] + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetValidSku.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetValidSku.json new file mode 100644 index 000000000000..5b6532edb650 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSGetValidSku.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "S1" + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSListByResourceGroup.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSListByResourceGroup.json new file mode 100644 index 000000000000..3f5c3862e31e --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSListByResourceGroup.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012" + }, + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + }, + { + "etag": "AAAAAAAADGk=", + "name": "mySecondProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "mySecondProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012" + }, + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/mySecondProvisioningService", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSListBySubscription.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSListBySubscription.json new file mode 100644 index 000000000000..efb4770967b8 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSListBySubscription.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012" + }, + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + }, + { + "etag": "AAAAAAAADGk=", + "name": "mySecondProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012" + }, + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/mySecondProvisioningService", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSListKeys.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSListKeys.json new file mode 100644 index 000000000000..835328ed57c2 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSListKeys.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "keyName": "key1", + "primaryKey": "#####################################", + "secondaryKey": "###################################", + "rights": "ServiceConfig" + }, + { + "keyName": "key2", + "primaryKey": "#######################################", + "secondaryKey": "####################################=", + "rights": "ServiceConfig" + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSListPrivateEndpointConnections.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSListPrivateEndpointConnections.json new file mode 100644 index 000000000000..31f5993fcaa3 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSListPrivateEndpointConnections.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my request!", + "actionsRequired": "None" + } + } + } + ] + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSListPrivateLinkResources.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSListPrivateLinkResources.json new file mode 100644 index 000000000000..d8518c8255c0 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSListPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateLinkResources/iotDps", + "name": "iotDps", + "type": "Microsoft.Devices/ProvisioningServices/PrivateLinkResources", + "properties": { + "groupId": "iotDps", + "requiredMembers": [ + "iotDps" + ], + "requiredZoneNames": [ + "privatelink.azure-devices-provisioning.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSOperations.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSOperations.json new file mode 100644 index 000000000000..ca69bfa1de2f --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSOperations.json @@ -0,0 +1,293 @@ +{ + "parameters": { + "api-version": "2020-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Devices/register/action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Register Resource Provider" + } + }, + { + "name": "Microsoft.Devices/IotHubs/diagnosticSettings/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Diagnostic Setting" + } + }, + { + "name": "Microsoft.Devices/IotHubs/diagnosticSettings/write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Set Diagnostic Setting" + } + }, + { + "name": "Microsoft.Devices/IotHubs/metricDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read IotHub service metric definitions" + } + }, + { + "name": "Microsoft.Devices/IotHubs/logDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read IotHub service log definitions" + } + }, + { + "name": "Microsoft.Devices/operations/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get All ResourceProvider Operations" + } + }, + { + "name": "Microsoft.Devices/checkNameAvailability/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Check If IotHub name is available" + } + }, + { + "name": "Microsoft.Devices/usages/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Subscription Usages" + } + }, + { + "name": "Microsoft.Devices/iotHubs/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub(s)" + } + }, + { + "name": "Microsoft.Devices/iotHubs/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Create or update IotHub Resource" + } + }, + { + "name": "Microsoft.Devices/iotHubs/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Delete IotHub Resource" + } + }, + { + "name": "Microsoft.Devices/iotHubs/iotHubStats/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub Statistics" + } + }, + { + "name": "Microsoft.Devices/iotHubs/skus/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get valid IotHub Skus" + } + }, + { + "name": "Microsoft.Devices/iotHubs/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get all IotHub Keys" + } + }, + { + "name": "Microsoft.Devices/iotHubs/iotHubKeys/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub Key for the given name" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Create EventHub Consumer Group" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get EventHub Consumer Group(s)" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Delete EventHub Consumer Group" + } + }, + { + "name": "Microsoft.Devices/iotHubs/exportDevices/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Export Devices" + } + }, + { + "name": "Microsoft.Devices/iotHubs/importDevices/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Import Devices" + } + }, + { + "name": "Microsoft.Devices/iotHubs/jobs/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get the Job(s) on IotHub" + } + }, + { + "name": "Microsoft.Devices/iotHubs/quotaMetrics/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Quota Metrics" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routing/routes/$testall/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Routing Rule Test All" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routing/routes/$testnew/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Routing Rule Test Route" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routingEndpointsHealth/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Endpoint Health" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/diagnosticSettings/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Diagnostic Setting" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/diagnosticSettings/write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Set Diagnostic Setting" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/metricDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read DPS service metric definitions" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/logDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read DPS service log definitions" + } + }, + { + "name": "Microsoft.Devices/checkProvisioningServiceNameAvailability/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServives", + "operation": "Check If Provisioning Service name is available" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Get Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Create Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Delete Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/skus/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Delete Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "get security related metadata" + } + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSPatch.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSPatch.json new file mode 100644 index 000000000000..676573e711f2 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSPatch.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "location": "East US", + "type": "Microsoft.Devices/ProvisioningServices", + "ProvisioningServiceTags": { + "tags": { + "foo": "bar" + } + } + }, + "responses": { + "200": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012" + }, + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "tags": { + "foo": "bar" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSVerifyCertificate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSVerifyCertificate.json new file mode 100644 index 000000000000..8593f15b03a6 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/examples/DPSVerifyCertificate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-09-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=", + "request": { + "certificate": "#####################################" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "subject": "CN=andbucdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": true, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:26:56 GMT" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/ProvisioningServices/Certificates", + "etag": "AAAAAAExpTQ=" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/iotdps.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/iotdps.json new file mode 100644 index 000000000000..20b815e53811 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2020-09-01-preview/iotdps.json @@ -0,0 +1,2546 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-09-01-preview", + "x-ms-code-generation-settings": { + "host": "management.azure.com" + }, + "title": "iotDpsClient", + "description": "API for using the Azure IoT Hub Device Provisioning Service features." + }, + "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.Devices/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "DPSOperations": { + "$ref": "./examples/DPSOperations.json" + } + }, + "description": "Lists all of the available Microsoft.Devices REST API operations.", + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}": { + "get": { + "tags": [ + "GET" + ], + "operationId": "DpsCertificate_Get", + "description": "Get the certificate from the provisioning service.", + "x-ms-examples": { + "DPSGetCertificate": { + "$ref": "./examples/DPSGetCertificate.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "certificateName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the certificate to retrieve." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the provisioning service the certificate is associated with." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the certificate." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Metadata for the specified certificate.", + "schema": { + "$ref": "#/definitions/CertificateResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "put": { + "tags": [ + "PUT" + ], + "summary": "Upload the certificate to the provisioning service.", + "description": "Add new certificate or update an existing certificate.", + "operationId": "DpsCertificate_CreateOrUpdate", + "x-ms-examples": { + "DPSCreateOrUpdateCertificate": { + "$ref": "./examples/DPSCertificateCreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group identifier.", + "required": true, + "type": "string" + }, + { + "name": "provisioningServiceName", + "in": "path", + "description": "The name of the provisioning service.", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "in": "path", + "description": "The name of the certificate create or update.", + "required": true, + "type": "string", + "maxLength": 256 + }, + { + "name": "certificateDescription", + "in": "body", + "description": "The certificate body.", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateBodyDescription" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate." + } + ], + "responses": { + "200": { + "description": "If certificate already exist and update was successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/CertificateResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "DELETE" + ], + "operationId": "DpsCertificate_Delete", + "summary": "Delete the Provisioning Service Certificate.", + "description": "Deletes the specified certificate associated with the Provisioning Service", + "x-ms-examples": { + "DPSDeleteCertificate": { + "$ref": "./examples/DPSDeleteCertificate.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the certificate" + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the provisioning service." + }, + { + "name": "certificateName", + "in": "path", + "required": true, + "type": "string", + "description": "This is a mandatory field, and is the logical name of the certificate that the provisioning service will access by." + }, + { + "name": "certificate.name", + "in": "query", + "required": false, + "type": "string", + "description": "This is optional, and it is the Common Name of the certificate." + }, + { + "name": "certificate.rawBytes", + "in": "query", + "required": false, + "type": "string", + "format": "byte", + "description": "Raw data within the certificate." + }, + { + "name": "certificate.isVerified", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if certificate has been verified by owner of the private key." + }, + { + "name": "certificate.purpose", + "in": "query", + "required": false, + "type": "string", + "description": "A description that mentions the purpose of the certificate.", + "enum": [ + "clientAuthentication", + "serverAuthentication" + ], + "x-ms-enum": { + "name": "CertificatePurpose", + "modelAsString": true + } + }, + { + "name": "certificate.created", + "in": "query", + "description": "Time the certificate is created.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "certificate.lastUpdated", + "in": "query", + "required": false, + "type": "string", + "description": "Time the certificate is last updated.", + "format": "date-time" + }, + { + "name": "certificate.hasPrivateKey", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if the certificate contains a private key." + }, + { + "name": "certificate.nonce", + "in": "query", + "required": false, + "type": "string", + "description": "Random number generated to indicate Proof of Possession." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the non-security related metadata of the provisioning service.", + "description": "Get the metadata of the provisioning service without SAS keys.", + "operationId": "IotDpsResource_Get", + "x-ms-examples": { + "DPSGet": { + "$ref": "./examples/DPSGet.json" + } + }, + "parameters": [ + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the provisioning service to retrieve." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Provisioning service description with no keys is included in the response.", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + }, + "default": { + "description": "Default error response", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "put": { + "tags": [ + "PUT" + ], + "summary": "Create or update the metadata of the provisioning service.", + "description": "Create or update the metadata of the provisioning service. The usual pattern to modify a property is to retrieve the provisioning service metadata and security metadata, and then combine them with the modified values in a new body to update the provisioning service.", + "x-ms-long-running-operation": true, + "operationId": "IotDpsResource_CreateOrUpdate", + "x-ms-examples": { + "DPSCreate": { + "$ref": "./examples/DPSCreate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service to create or update." + }, + { + "name": "iotDpsDescription", + "in": "body", + "required": true, + "description": "Description of the provisioning service to create or update.", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The body contains all the non-security properties of the provisioning service. Security-related properties are set to null.", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + }, + "201": { + "description": "This is a long running operation. The operation returns a 201 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. If successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "patch": { + "tags": [ + "PATCH" + ], + "summary": "Update an existing provisioning service's tags.", + "description": "Update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method", + "x-ms-long-running-operation": true, + "operationId": "IotDpsResource_Update", + "x-ms-examples": { + "DPSPatch": { + "$ref": "./examples/DPSPatch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service to create or update." + }, + { + "name": "ProvisioningServiceTags", + "in": "body", + "required": true, + "description": "Updated tag information to set into the provisioning service instance.", + "schema": { + "$ref": "#/definitions/TagsResource" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Provisioning Service was successfully updated", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "DELETE" + ], + "summary": "Delete the Provisioning Service", + "description": "Deletes the Provisioning Service.", + "x-ms-long-running-operation": true, + "operationId": "IotDpsResource_Delete", + "x-ms-examples": { + "DPSDelete": { + "$ref": "./examples/DPSDelete.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service to delete." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "202": { + "description": "The provisioning service resource provider always returns a 202 Accepted status code with valid Location and Retry-After headers. The resource provider also sets the Azure-AsyncOperation header with a URL that points to the operation resource for this operation. Subsequent GET attempts on the resource after a DELETE operation return a resource representation that indicates a transitional provisioning state (such as Terminating). To retrieve the status of the operation, a client can either poll the URL returned in the Location header after the Retry-After interval, get the provisioning service status directly, or query the operation resource." + }, + "200": { + "description": "This is returned as a response to the status polling request for the delete operation. The body contains the resource representation that indicates a transitional provisioning state." + }, + "204": { + "description": "Once the long running delete operation completes successfully, a 204 No Content status code is returned when the status polling request finds the provisioning service metadata in the service and the status of the delete operation is set to a completed state." + }, + "404": { + "description": "After the long running delete operation completes successfully, a 404 Not Found is returned when the status polling request no longer finds the provisioning service metadata in the service." + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates": { + "get": { + "tags": [ + "GET" + ], + "operationId": "DpsCertificate_List", + "description": "Get all the certificates tied to the provisioning service.", + "x-ms-examples": { + "DPSGetCertificates": { + "$ref": "./examples/DPSGetCertificates.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of resource group." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service to retrieve certificates for." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "List of certificate descriptions in a JSON-serialized array.", + "schema": { + "$ref": "#/definitions/CertificateListDescription" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/provisioningServices": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get all the provisioning services in a subscription.", + "description": "List all the provisioning services for a given subscription id.", + "operationId": "IotDpsResource_ListBySubscription", + "x-ms-examples": { + "DPSListBySubscription": { + "$ref": "./examples/DPSListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the provisioning services in the subscription.", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescriptionListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices": { + "get": { + "tags": [ + "GET" + ], + "operationId": "IotDpsResource_ListByResourceGroup", + "description": "Get a list of all provisioning services in the given resource group.", + "x-ms-examples": { + "DPSListByResourceGroup": { + "$ref": "./examples/DPSListByResourceGroup.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "List of provisioning services in the resource group.", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescriptionListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/operationresults/{operationId}": { + "get": { + "tags": [ + "GET" + ], + "operationId": "IotDpsResource_GetOperationResult", + "description": "Gets the status of a long running operation, such as create, update or delete a provisioning service.", + "x-ms-examples": { + "DPSGetOperationResult": { + "$ref": "./examples/DPSGetOperationResult.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "Operation id corresponding to long running operation. Use this to poll for the status." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service that the operation is running on." + }, + { + "name": "asyncinfo", + "in": "query", + "description": "Async header used to poll on the status of the operation, obtained while creating the long running operation.", + "required": true, + "type": "string", + "default": "true" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The status of the long running operation.", + "schema": { + "$ref": "#/definitions/AsyncOperationResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/skus": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the list of valid SKUs for a provisioning service.", + "description": "Gets the list of valid SKUs and tiers for a provisioning service.", + "operationId": "IotDpsResource_listValidSkus", + "x-ms-examples": { + "DPSGetValidSku": { + "$ref": "./examples/DPSGetValidSku.json" + } + }, + "parameters": [ + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of resource group." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the valid SKUs for this provisioning service.", + "schema": { + "$ref": "#/definitions/IotDpsSkuDefinitionListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/generateVerificationCode": { + "post": { + "tags": [ + "POST" + ], + "operationId": "DpsCertificate_GenerateVerificationCode", + "description": "Generate verification code for Proof of Possession.", + "x-ms-examples": { + "DPSGenerateVerificationCode": { + "$ref": "./examples/DPSGenerateVerificationCode.json" + } + }, + "parameters": [ + { + "name": "certificateName", + "in": "path", + "required": true, + "type": "string", + "description": "The mandatory logical name of the certificate, that the provisioning service uses to access." + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "name of resource group." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service." + }, + { + "name": "certificate.name", + "in": "query", + "required": false, + "type": "string", + "description": "Common Name for the certificate." + }, + { + "name": "certificate.rawBytes", + "in": "query", + "required": false, + "type": "string", + "format": "byte", + "description": "Raw data of certificate." + }, + { + "name": "certificate.isVerified", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if the certificate has been verified by owner of the private key." + }, + { + "name": "certificate.purpose", + "in": "query", + "required": false, + "type": "string", + "description": "Description mentioning the purpose of the certificate.", + "enum": [ + "clientAuthentication", + "serverAuthentication" + ], + "x-ms-enum": { + "name": "CertificatePurpose", + "modelAsString": true + } + }, + { + "name": "certificate.created", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "Certificate creation time." + }, + { + "name": "certificate.lastUpdated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "Certificate last updated time." + }, + { + "name": "certificate.hasPrivateKey", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if the certificate contains private key." + }, + { + "name": "certificate.nonce", + "in": "query", + "required": false, + "type": "string", + "description": "Random number generated to indicate Proof of Possession." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Generated verification code for that certificate is returned.", + "schema": { + "$ref": "#/definitions/VerificationCodeResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/verify": { + "post": { + "tags": [ + "POST" + ], + "operationId": "DpsCertificate_VerifyCertificate", + "summary": "Verify certificate's private key possession.", + "description": "Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.", + "x-ms-examples": { + "DPSVerifyCertificate": { + "$ref": "./examples/DPSVerifyCertificate.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "certificateName", + "in": "path", + "required": true, + "type": "string", + "description": "The mandatory logical name of the certificate, that the provisioning service uses to access." + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the certificate." + }, + { + "name": "request", + "in": "body", + "required": true, + "description": "The name of the certificate", + "schema": { + "$ref": "#/definitions/VerificationCodeRequest" + } + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group name." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Provisioning service name." + }, + { + "name": "certificate.name", + "in": "query", + "required": false, + "type": "string", + "description": "Common Name for the certificate." + }, + { + "name": "certificate.rawBytes", + "in": "query", + "required": false, + "type": "string", + "format": "byte", + "description": "Raw data of certificate." + }, + { + "name": "certificate.isVerified", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if the certificate has been verified by owner of the private key." + }, + { + "name": "certificate.purpose", + "in": "query", + "required": false, + "description": "Describe the purpose of the certificate.", + "type": "string", + "enum": [ + "clientAuthentication", + "serverAuthentication" + ], + "x-ms-enum": { + "name": "CertificatePurpose", + "modelAsString": true + } + }, + { + "name": "certificate.created", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "Certificate creation time." + }, + { + "name": "certificate.lastUpdated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "Certificate last updated time." + }, + { + "name": "certificate.hasPrivateKey", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if the certificate contains private key." + }, + { + "name": "certificate.nonce", + "in": "query", + "required": false, + "type": "string", + "description": "Random number generated to indicate Proof of Possession." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CertificateResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkProvisioningServiceNameAvailability": { + "post": { + "tags": [ + "POST" + ], + "operationId": "IotDpsResource_CheckProvisioningServiceNameAvailability", + "x-ms-examples": { + "DPSCheckName": { + "$ref": "./examples/DPSCheckNameAvailability.json" + } + }, + "summary": "Check if a provisioning service name is available.", + "description": "Check if a provisioning service name is available. This will validate if the name is syntactically valid and if the name is usable", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "arguments", + "in": "body", + "required": true, + "description": "Set the name parameter in the OperationInputs structure to the name of the provisioning service to check.", + "schema": { + "$ref": "#/definitions/OperationInputs" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the provisioning service name is available. If the name is not available, the body contains the reason.", + "schema": { + "$ref": "#/definitions/NameAvailabilityInfo" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/listkeys": { + "post": { + "tags": [ + "POST" + ], + "operationId": "IotDpsResource_ListKeys", + "x-ms-examples": { + "DPSListKeys": { + "$ref": "./examples/DPSListKeys.json" + } + }, + "summary": "Get the security metadata for a provisioning service.", + "description": "List the primary and secondary keys for a provisioning service.", + "parameters": [ + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The provisioning service name to get the shared access keys for." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "resource group name" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of shared access policies, including keys, that you can use to access the provisioning service endpoints.", + "schema": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRuleListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/keys/{keyName}/listkeys": { + "post": { + "tags": [ + "POST" + ], + "operationId": "IotDpsResource_ListKeysForKeyName", + "x-ms-examples": { + "DPSGetKey": { + "$ref": "./examples/DPSGetKey.json" + } + }, + "summary": "Get a shared access policy by name from a provisioning service.", + "description": "List primary and secondary keys for a specific key name", + "parameters": [ + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the provisioning service." + }, + { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "description": "Logical key name to get key-values for." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The name of the resource group that contains the provisioning service.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized shared access policy, including keys, that you can use to access one or more provisioning service endpoints.", + "schema": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule[AccessRightsDescription]" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "GET" + ], + "summary": "List private link resources", + "description": "List private link resources for the given provisioning service", + "operationId": "IotDpsResource_ListPrivateLinkResources", + "x-ms-examples": { + "PrivateLinkResources_List": { + "$ref": "./examples/DPSListPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains the list of private link resources", + "schema": { + "$ref": "#/definitions/PrivateLinkResources" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateLinkResources/{groupId}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the specified private link resource", + "description": "Get the specified private link resource for the given provisioning service", + "operationId": "IotDpsResource_GetPrivateLinkResources", + "x-ms-examples": { + "PrivateLinkResources_List": { + "$ref": "./examples/DPSGetPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/groupId" + } + ], + "responses": { + "200": { + "description": "The body contains the specified of private link resource", + "schema": { + "$ref": "#/definitions/GroupIdInformation" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "GET" + ], + "summary": "List private endpoint connections", + "description": "List private endpoint connection properties", + "operationId": "IotDpsResource_ListPrivateEndpointConnections", + "x-ms-examples": { + "PrivateEndpointConnections_List": { + "$ref": "./examples/DPSListPrivateEndpointConnections.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains the list of private endpoint connection properties", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionsList" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get private endpoint connection", + "description": "Get private endpoint connection properties", + "operationId": "IotDpsResource_GetPrivateEndpointConnection", + "x-ms-examples": { + "PrivateEndpointConnection_Get": { + "$ref": "./examples/DPSGetPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/privateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "The body contains the private endpoint connection properties", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "PUT" + ], + "summary": "Create or update private endpoint connection", + "description": "Create or update the status of a private endpoint connection with the specified name", + "operationId": "IotDpsResource_CreateOrUpdatePrivateEndpointConnection", + "x-ms-examples": { + "PrivateEndpointConnection_CreateOrUpdate": { + "$ref": "./examples/DPSCreateOrUpdatePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/privateEndpointConnectionName" + }, + { + "name": "privateEndpointConnection", + "in": "body", + "description": "The private endpoint connection with updated properties", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "201": { + "description": "This is a long running operation. The operation returns a 201 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. If successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "200": { + "description": "This is returned as a response to the status polling request for the update operation.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "DELETE" + ], + "summary": "Delete private endpoint connection", + "description": "Delete private endpoint connection with the specified name", + "operationId": "IotDpsResource_DeletePrivateEndpointConnection", + "x-ms-examples": { + "PrivateEndpointConnection_Delete": { + "$ref": "./examples/DPSDeletePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/privateEndpointConnectionName" + } + ], + "responses": { + "202": { + "description": "This is a long running operation. The operation returns a 202 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "200": { + "description": "This is returned as a response to the status polling request for the delete operation.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "204": { + "description": "PrivateEndpoint does not exist." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + } + }, + "definitions": { + "AsyncOperationResult": { + "type": "object", + "description": "Result of a long running operation.", + "properties": { + "status": { + "description": "current status of a long running operation.", + "type": "string" + }, + "error": { + "description": "Error message containing code, description and details", + "$ref": "#/definitions/ErrorMesssage" + } + } + }, + "ErrorMesssage": { + "description": "Error response containing message and code.", + "type": "object", + "properties": { + "code": { + "description": "standard error code", + "type": "string" + }, + "message": { + "description": "standard error description", + "type": "string" + }, + "details": { + "description": "detailed summary of error", + "type": "string" + } + } + }, + "CertificateListDescription": { + "description": "The JSON-serialized array of Certificate objects.", + "type": "object", + "properties": { + "value": { + "description": "The array of Certificate objects.", + "type": "array", + "items": { + "$ref": "#/definitions/CertificateResponse" + } + } + } + }, + "CertificateBodyDescription": { + "description": "The JSON-serialized X509 Certificate.", + "type": "object", + "properties": { + "certificate": { + "description": "Base-64 representation of the X509 leaf certificate .cer file or just .pem file content.", + "type": "string" + } + } + }, + "CertificateResponse": { + "description": "The X509 Certificate.", + "type": "object", + "properties": { + "properties": { + "description": "properties of a certificate", + "$ref": "#/definitions/CertificateProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "description": "The name of the certificate.", + "type": "string", + "readOnly": true + }, + "etag": { + "description": "The entity tag.", + "type": "string", + "readOnly": true + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + } + }, + "x-ms-azure-resource": true + }, + "CertificateProperties": { + "description": "The description of an X509 CA Certificate.", + "type": "object", + "properties": { + "subject": { + "description": "The certificate's subject name.", + "type": "string", + "readOnly": true + }, + "expiry": { + "description": "The certificate's expiration date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "thumbprint": { + "description": "The certificate's thumbprint.", + "type": "string", + "readOnly": true + }, + "isVerified": { + "description": "Determines whether certificate has been verified.", + "type": "boolean", + "readOnly": true + }, + "created": { + "description": "The certificate's creation date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "updated": { + "description": "The certificate's last update date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + } + } + }, + "IotDpsSkuInfo": { + "type": "object", + "description": "List of possible provisioning service SKUs.", + "properties": { + "name": { + "description": "Sku name.", + "enum": [ + "S1" + ], + "type": "string", + "x-ms-enum": { + "name": "IotDpsSku", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "readOnly": true, + "description": "Pricing tier name of the provisioning service." + }, + "capacity": { + "format": "int64", + "type": "integer", + "description": "The number of units to provision" + } + } + }, + "ProvisioningServiceDescription": { + "description": "The description of the provisioning service.", + "type": "object", + "properties": { + "etag": { + "description": "The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.", + "type": "string" + }, + "properties": { + "description": "Service specific properties for a provisioning service", + "$ref": "#/definitions/IotDpsPropertiesDescription" + }, + "sku": { + "description": "Sku info for a provisioning Service.", + "$ref": "#/definitions/IotDpsSkuInfo" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "sku", + "properties" + ] + }, + "IotDpsPropertiesDescription": { + "description": "the service specific properties of a provisioning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope", + "type": "object", + "properties": { + "state": { + "description": "Current state of the provisioning service.", + "enum": [ + "Activating", + "Active", + "Deleting", + "Deleted", + "ActivationFailed", + "DeletionFailed", + "Transitioning", + "Suspending", + "Suspended", + "Resuming", + "FailingOver", + "FailoverFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "state", + "modelAsString": true + } + }, + "encryption": { + "description": "The encryption properties for the IoT DPS instance.", + "$ref": "#/definitions/EncryptionPropertiesDescription" + }, + "publicNetworkAccess": { + "type": "string", + "description": "Whether requests from Public Network are allowed", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PublicNetworkAccess" + } + }, + "ipFilterRules": { + "description": "The IP filter rules.", + "type": "array", + "items": { + "$ref": "#/definitions/IpFilterRule" + } + }, + "privateEndpointConnections": { + "description": "Private endpoint connections created on this IotHub", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "provisioningState": { + "description": "The ARM provisioning state of the provisioning service.", + "type": "string" + }, + "iotHubs": { + "type": "array", + "description": "List of IoT hubs associated with this provisioning service.", + "items": { + "$ref": "#/definitions/IotHubDefinitionDescription" + } + }, + "allocationPolicy": { + "enum": [ + "Hashed", + "GeoLatency", + "Static" + ], + "type": "string", + "description": "Allocation policy to be used by this provisioning service.", + "x-ms-enum": { + "name": "AllocationPolicy", + "modelAsString": true + } + }, + "serviceOperationsHostName": { + "description": "Service endpoint for provisioning service.", + "type": "string", + "readOnly": true + }, + "deviceProvisioningHostName": { + "type": "string", + "description": "Device endpoint for this provisioning service.", + "readOnly": true + }, + "idScope": { + "type": "string", + "description": "Unique identifier of this provisioning service.", + "readOnly": true + }, + "authorizationPolicies": { + "description": "List of authorization keys for a provisioning service.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule[AccessRightsDescription]" + } + } + } + }, + "IotHubDefinitionDescription": { + "type": "object", + "description": "Description of the IoT hub.", + "properties": { + "applyAllocationPolicy": { + "description": "flag for applying allocationPolicy or not for a given iot hub.", + "type": "boolean" + }, + "allocationWeight": { + "description": "weight to apply for a given iot h.", + "format": "int32", + "type": "integer" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Host name of the IoT hub." + }, + "connectionString": { + "type": "string", + "description": "Connection string of the IoT hub." + }, + "location": { + "type": "string", + "description": "ARM region of the IoT hub." + } + }, + "required": [ + "connectionString", + "location" + ] + }, + "EncryptionPropertiesDescription": { + "description": "The encryption properties for the IoT DPS instance.", + "type": "object", + "properties": { + "keySource": { + "description": "The source of the key.", + "type": "string" + }, + "keyVaultProperties": { + "description": "The properties of the KeyVault key.", + "type": "array", + "items": { + "$ref": "#/definitions/KeyVaultKeyProperties" + } + } + } + }, + "KeyVaultKeyProperties": { + "description": "The properties of the KeyVault key.", + "type": "object", + "properties": { + "keyIdentifier": { + "type": "string", + "description": "The identifier of the key." + } + } + }, + "IpFilterRule": { + "description": "The IP filter rules for a provisioning Service.", + "type": "object", + "properties": { + "filterName": { + "description": "The name of the IP filter rule.", + "type": "string" + }, + "action": { + "description": "The desired action for requests captured by this rule.", + "enum": [ + "Accept", + "Reject" + ], + "type": "string", + "x-ms-enum": { + "name": "IpFilterActionType", + "modelAsString": false + } + }, + "ipMask": { + "description": "A string that contains the IP address range in CIDR notation for the rule.", + "type": "string" + }, + "target": { + "description": "Target for requests captured by this rule.", + "enum": [ + "all", + "serviceApi", + "deviceApi" + ], + "type": "string", + "x-ms-enum": { + "name": "IpFilterTargetType", + "modelAsString": false + } + } + }, + "required": [ + "filterName", + "action", + "ipMask" + ] + }, + "PrivateLinkResources": { + "description": "The available private link resources for a provisioning service", + "type": "object", + "properties": { + "value": { + "description": "The list of available private link resources for a provisioning service", + "type": "array", + "items": { + "$ref": "#/definitions/GroupIdInformation" + } + } + } + }, + "GroupIdInformation": { + "description": "The group information for creating a private endpoint on a provisioning service", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "description": "The properties for a group information object", + "$ref": "#/definitions/GroupIdInformationProperties" + } + }, + "required": [ + "properties" + ] + }, + "GroupIdInformationProperties": { + "description": "The properties for a group information object", + "type": "object", + "properties": { + "groupId": { + "type": "string", + "description": "The group id" + }, + "requiredMembers": { + "description": "The required members for a specific group id", + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "description": "The required DNS zones for a specific group id", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PrivateEndpointConnectionsList": { + "description": "The list of private endpoint connections for a provisioning service", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "PrivateEndpointConnection": { + "description": "The private endpoint connection of a provisioning service", + "x-ms-azure-resource": true, + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "description": "The properties of a private endpoint connection", + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + } + }, + "required": [ + "properties" + ] + }, + "PrivateEndpointConnectionProperties": { + "description": "The properties of a private endpoint connection", + "type": "object", + "properties": { + "privateEndpoint": { + "description": "The private endpoint property of a private endpoint connection", + "$ref": "#/definitions/PrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "description": "The current state of a private endpoint connection", + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "description": "The private endpoint property of a private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The current state of a private endpoint connection", + "type": "object", + "properties": { + "status": { + "description": "The status of a private endpoint connection", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The description for the current state of a private endpoint connection" + }, + "actionsRequired": { + "type": "string", + "description": "Actions required for a private endpoint connection" + } + }, + "required": [ + "status", + "description" + ] + }, + "SharedAccessSignatureAuthorizationRule[AccessRightsDescription]": { + "type": "object", + "description": "Description of the shared access key.", + "properties": { + "keyName": { + "type": "string", + "description": "Name of the key." + }, + "primaryKey": { + "type": "string", + "description": "Primary SAS key value." + }, + "secondaryKey": { + "type": "string", + "description": "Secondary SAS key value." + }, + "rights": { + "description": "Rights that this key has.", + "enum": [ + "ServiceConfig", + "EnrollmentRead", + "EnrollmentWrite", + "DeviceConnect", + "RegistrationStatusRead", + "RegistrationStatusWrite" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessRightsDescription", + "modelAsString": true + } + } + }, + "required": [ + "keyName", + "rights" + ] + }, + "Resource": { + "description": "The common properties of an Azure resource.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "location": { + "type": "string", + "description": "The resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "x-ms-azure-resource": true, + "required": [ + "location" + ] + }, + "OperationListResult": { + "description": "Result of the request to list provisioning service operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "Provisioning service operations supported by the Microsoft.Devices resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "Provisioning Service REST API operation.", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{read | write | action | delete}" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft Devices." + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource Type: ProvisioningServices." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Name of the operation." + } + } + } + } + }, + "ErrorDetails": { + "description": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "httpStatusCode": { + "description": "The HTTP status code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "The error details.", + "type": "string", + "readOnly": true + } + } + }, + "SharedAccessSignatureAuthorizationRuleListResult": { + "type": "object", + "description": "List of shared access keys.", + "properties": { + "value": { + "description": "The list of shared access policies.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule[AccessRightsDescription]" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "IotDpsSkuDefinitionListResult": { + "type": "object", + "description": "List of available SKUs.", + "properties": { + "value": { + "description": "The list of SKUs", + "type": "array", + "items": { + "$ref": "#/definitions/IotDpsSkuDefinition" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "IotDpsSkuDefinition": { + "type": "object", + "description": "Available SKUs of tier and units.", + "properties": { + "name": { + "description": "Sku name.", + "enum": [ + "S1" + ], + "type": "string", + "x-ms-enum": { + "name": "IotDpsSku", + "modelAsString": true + } + } + } + }, + "OperationInputs": { + "description": "Input values for operation results call.", + "type": "object", + "properties": { + "name": { + "description": "The name of the Provisioning Service to check.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "NameAvailabilityInfo": { + "type": "object", + "description": "Description of name availability.", + "properties": { + "nameAvailable": { + "description": "specifies if a name is available or not", + "type": "boolean" + }, + "reason": { + "description": "specifies the reason a name is unavailable", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "x-ms-enum": { + "name": "NameUnavailabilityReason", + "modelAsString": true + } + }, + "message": { + "description": "message containing a detailed reason name is unavailable", + "type": "string" + } + } + }, + "TagsResource": { + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "A container holding only the Tags for a resource, allowing the user to update the tags on a Provisioning Service instance." + }, + "ProvisioningServiceDescriptionListResult": { + "type": "object", + "description": "List of provisioning service descriptions.", + "properties": { + "value": { + "description": "List of provisioning service descriptions.", + "type": "array", + "items": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + }, + "nextLink": { + "description": "the next link", + "type": "string", + "readOnly": true + } + } + }, + "VerificationCodeResponse": { + "type": "object", + "description": "Description of the response of the verification code.", + "properties": { + "name": { + "type": "string", + "description": "Name of certificate.", + "readOnly": true + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "Request etag." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "type": "object", + "properties": { + "verificationCode": { + "type": "string", + "description": "Verification code." + }, + "subject": { + "type": "string", + "description": "Certificate subject." + }, + "expiry": { + "type": "string", + "description": "Code expiry." + }, + "thumbprint": { + "type": "string", + "description": "Certificate thumbprint." + }, + "isVerified": { + "type": "boolean", + "description": "Indicate if the certificate is verified by owner of private key." + }, + "created": { + "type": "string", + "description": "Certificate created time." + }, + "updated": { + "type": "string", + "description": "Certificate updated time." + } + } + } + }, + "x-ms-azure-resource": true + }, + "VerificationCodeRequest": { + "type": "object", + "description": "The JSON-serialized leaf certificate", + "properties": { + "certificate": { + "description": "base-64 representation of X509 certificate .cer file or just .pem file content.", + "type": "string" + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription identifier.", + "required": true, + "type": "string" + }, + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the API.", + "required": true, + "type": "string" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "description": "The name of the resource group that contains the provisioning service.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the provisioning service.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "groupId": { + "name": "groupId", + "in": "path", + "description": "The name of the private link resource", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "privateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/readme.md b/specification/deviceprovisioningservices/resource-manager/readme.md index 7622f050ce2a..02fbc7964bbe 100644 --- a/specification/deviceprovisioningservices/resource-manager/readme.md +++ b/specification/deviceprovisioningservices/resource-manager/readme.md @@ -26,9 +26,18 @@ These are the global settings for the API. ``` yaml openapi-type: arm -tag: package-2020-03 +tag: package-preview-2020-09 ``` + +### Tag: package-preview-2020-09 + +These settings apply only when `--tag=package-preview-2020-09` is specified on the command line. + +```yaml $(tag) == 'package-preview-2020-09' +input-file: + - Microsoft.Devices/preview/2020-09-01-preview/iotdps.json +``` ### Tag: package-2020-03 These settings apply only when `--tag=package-2020-03` is specified on the command line. From ac61cdbaac1c9fb4c9d11c41734a0dcb458cdc25 Mon Sep 17 00:00:00 2001 From: Alfredo Santamaria Date: Thu, 10 Sep 2020 19:29:04 -0700 Subject: [PATCH 034/164] remove unsupported reversproxy and useTestExtension (#10728) Co-authored-by: Alfredo Santamaria Gomez --- .../ManagedClusterPatchOperation_example.json | 6 ++---- ...anagedClusterPutOperation_example_max.json | 12 ++++------- .../2020-01-01-preview/managedcluster.json | 21 ++----------------- .../preview/2020-01-01-preview/nodetype.json | 5 +---- 4 files changed, 9 insertions(+), 35 deletions(-) diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/ManagedClusterPatchOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/ManagedClusterPatchOperation_example.json index 596c355ccaa7..02924f1656e1 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/ManagedClusterPatchOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/ManagedClusterPatchOperation_example.json @@ -186,8 +186,7 @@ } } }, - "clusterUpgradeMode": "Automatic", - "reverseProxyEndpointPort": 19081 + "clusterUpgradeMode": "Automatic" } } }, @@ -287,8 +286,7 @@ } } }, - "clusterUpgradeMode": "Automatic", - "reverseProxyEndpointPort": 19081 + "clusterUpgradeMode": "Automatic" } } } diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/ManagedClusterPutOperation_example_max.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/ManagedClusterPutOperation_example_max.json index 6bd51c60283f..1f8f1f9fe8d9 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/ManagedClusterPutOperation_example_max.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/ManagedClusterPutOperation_example_max.json @@ -90,8 +90,7 @@ } } }, - "clusterUpgradeMode": "Manual", - "reverseProxyEndpointPort": 19081 + "clusterUpgradeMode": "Manual" } } }, @@ -195,8 +194,7 @@ } } }, - "clusterUpgradeMode": "Manual", - "reverseProxyEndpointPort": 19081 + "clusterUpgradeMode": "Manual" } } }, @@ -299,8 +297,7 @@ } } }, - "clusterUpgradeMode": "Manual", - "reverseProxyEndpointPort": 19081 + "clusterUpgradeMode": "Manual" } } }, @@ -403,8 +400,7 @@ } } }, - "clusterUpgradeMode": "Manual", - "reverseProxyEndpointPort": 19081 + "clusterUpgradeMode": "Manual" } } } diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json index b5ba10c91469..45af9872d23f 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json @@ -460,7 +460,7 @@ }, "issuerThumbprint": { "type": "string", - "description": "Issuer thumbprint for the certificate. Its only use ehn CommonName is used." + "description": "Issuer thumbprint for the certificate. Its only use CommonName is used." } }, "description": "Client Certificate definition." @@ -566,9 +566,6 @@ "type": "object", "description": "The manged cluster resource\n", "allOf": [ - { - "description": "The managed cluster resource properties" - }, { "$ref": "#/definitions/Resource" }, @@ -680,10 +677,6 @@ }, "description": "The list of custom fabric settings to configure the cluster." }, - "useTestExtension": { - "type": "boolean", - "description": "Use service fabric test vm extension, by default it's false." - }, "provisioningState": { "$ref": "#/definitions/ManagedResourceProvisioningState", "description": "The provisioning state of the managed cluster resource.", @@ -700,11 +693,6 @@ "clusterUpgradeDescription": { "$ref": "#/definitions/ClusterUpgradePolicy", "description": "Describes the policy used when upgrading the cluster." - }, - "reverseProxyEndpointPort": { - "type": "integer", - "format": "int32", - "description": "The endpoint used by reverse proxy." } }, "description": "Describes the managed cluster resource properties." @@ -757,11 +745,6 @@ "clusterUpgradeDescription": { "$ref": "#/definitions/ClusterUpgradePolicy", "description": "Describes the policy used when upgrading the cluster." - }, - "reverseProxyEndpointPort": { - "type": "integer", - "format": "int32", - "description": "The endpoint used by reverse proxy." } }, "description": "Describes the managed cluster resource properties." @@ -790,7 +773,7 @@ "properties": { "name": { "$ref": "#/definitions/SkuName", - "description": "Sku Name. Basic will hav a minimum of 3 seed nodes and Standard a minimum of 5. Basic only allows 1 node type." + "description": "Sku Name. Basic will have a minimum of 3 seed nodes and Standard a minimum of 5. Basic only allows 1 node type." } }, "description": "Sku definition" diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/nodetype.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/nodetype.json index 04f22ffa6b1b..708998a6869e 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/nodetype.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/nodetype.json @@ -539,9 +539,6 @@ "definitions": { "NodeType": { "allOf": [ - { - "description": "The node type definition" - }, { "$ref": "#/definitions/ManagedProxyResource" } @@ -588,7 +585,7 @@ "vmInstanceCount": { "type": "integer", "format": "int32", - "description": "The number of nodes in the node type. This count should match the capacity property in the corresponding VirtualMachineScaleSet resource.", + "description": "The number of nodes in the node type.", "minimum": 1, "maximum": 2147483647 }, From e08f0fbd7a8ddc181781bb0f7d4be7a91466aa53 Mon Sep 17 00:00:00 2001 From: ramagott <43017192+ramagott@users.noreply.github.com> Date: Thu, 10 Sep 2020 19:32:54 -0700 Subject: [PATCH 035/164] Adding ComputeInstance to preview swagger (#10654) * Adding ComputeInstance to preview swagger * Adding examples for few operations * Adding POBO changes --- .../examples/createComputeInstance.json | 59 +++ .../createComputeInstanceMinimal.json | 47 ++ .../examples/getComputeInstance.json | 59 +++ .../examples/restartComputeInstance.json | 12 + .../examples/startComputeInstance.json | 12 + .../examples/stopComputeInstance.json | 12 + .../machineLearningServices.json | 428 ++++++++++++++++++ 7 files changed, 629 insertions(+) create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/createComputeInstance.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/createComputeInstanceMinimal.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/getComputeInstance.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/restartComputeInstance.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/startComputeInstance.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/stopComputeInstance.json diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/createComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/createComputeInstance.json new file mode 100644 index 000000000000..5548500d58c7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/createComputeInstance.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-09-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "properties": { + "vmSize": "STANDARD_NC6", + "subnet": "test-subnet-resource-id", + "applicationSharingPolicy": "Personal", + "sshSettings": { + "sshPublicAccess": "Disabled" + }, + "computeInstanceAuthorizationType": "personal", + "personalComputeInstanceSettings": { + "assignedUser": { + "objectId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/createComputeInstanceMinimal.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/createComputeInstanceMinimal.json new file mode 100644 index 000000000000..472b0af583df --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/createComputeInstanceMinimal.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-09-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "properties": { + "vmSize": "STANDARD_NC6" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/getComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/getComputeInstance.json new file mode 100644 index 000000000000..567eac6173e2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/getComputeInstance.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "ComputeInstance", + "createdOn": "2017-09-26T22:28:08.327Z", + "provisioningState": "Succeeded", + "properties": { + "vmSize": "STANDARD_NC6", + "subnet": "test-subnet-resource-id", + "applicationSharingPolicy": "Shared", + "sshSettings": { + "sshPublicAccess": "Enabled", + "adminUserName": "azureuser", + "sshPort": 22 + }, + "computeInstanceAuthorizationType": "personal", + "personalComputeInstanceSettings": { + "assignedUser": { + "objectId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + } + }, + "createdBy": { + "userName": "foobar@microsoft.com", + "userOrgId": "00000000-0000-0000-0000-000000000000", + "userId": "00000000-0000-0000-0000-000000000000" + }, + "connectivityEndpoints": { + "publicIpAddress": "10.0.0.1", + "privateIpAddress": "10.0.0.1" + }, + "applications": [ + { + "displayName": "Jupyter", + "endpointUri": "https://compute123.eastus2.azureml.net/jupyter" + } + ], + "errors": null, + "state": "Running" + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/restartComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/restartComputeInstance.json new file mode 100644 index 000000000000..86ffe54a0079 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/restartComputeInstance.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-09-01-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/startComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/startComputeInstance.json new file mode 100644 index 000000000000..86ffe54a0079 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/startComputeInstance.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-09-01-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/stopComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/stopComputeInstance.json new file mode 100644 index 000000000000..86ffe54a0079 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/stopComputeInstance.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-09-01-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json index 9f72e5405378..dc61a4cb656b 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json @@ -708,6 +708,9 @@ }, "Get a AML Compute": { "$ref": "./examples/getAmlCompute.json" + }, + "Get an ComputeInstance": { + "$ref": "./examples/getComputeInstance.json" } }, "parameters": [ @@ -754,6 +757,12 @@ "Create a AML Compute": { "$ref": "./examples/createBasicAmlCompute.json" }, + "Create an ComputeInstance Compute with minimal inputs": { + "$ref": "./examples/createComputeInstanceMinimal.json" + }, + "Create an ComputeInstance Compute": { + "$ref": "./examples/createComputeInstance.json" + }, "Create AKS Compute": { "$ref": "./examples/createBasicAKSCompute.json" }, @@ -1018,6 +1027,135 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/start": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_Start", + "description": "Posts a start action to a compute instance", + "x-ms-examples": { + "Start ComputeInstance Compute": { + "$ref": "./examples/startComputeInstance.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/stop": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_Stop", + "description": "Posts a stop action to a compute instance", + "x-ms-examples": { + "Stop ComputeInstance Compute": { + "$ref": "./examples/stopComputeInstance.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/restart": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_Restart", + "description": "Posts a restart action to a compute instance", + "x-ms-examples": { + "Restart ComputeInstance Compute": { + "$ref": "./examples/restartComputeInstance.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces/skus": { "get": { "tags": [ @@ -2994,6 +3132,108 @@ ], "x-ms-discriminator-value": "AmlCompute" }, + "ComputeInstance": { + "description": "An Azure Machine Learning compute instance.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "description": "Compute Instance properties", + "type": "object", + "properties": { + "vmSize": { + "description": "Virtual Machine Size", + "type": "string" + }, + "subnet": { + "title": "Subnet.", + "description": "Virtual network subnet resource ID the compute nodes belong to.", + "$ref": "#/definitions/ResourceId" + }, + "applicationSharingPolicy": { + "type": "string", + "default": "Shared", + "title": "Sharing policy for applications on this compute instance", + "description": "Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role.", + "enum": [ + "Personal", + "Shared" + ], + "x-ms-enum": { + "name": "applicationSharingPolicy", + "modelAsString": true + } + }, + "sshSettings": { + "description": "Specifies policy and settings for SSH access.", + "$ref": "#/definitions/ComputeInstanceSshSettings" + }, + "connectivityEndpoints": { + "readOnly": true, + "description": "Describes all connectivity endpoints available for this ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceConnectivityEndpoints" + }, + "applications": { + "type": "array", + "readOnly": true, + "description": "Describes available applications and their endpoints on this ComputeInstance.", + "items": { + "$ref": "#/definitions/ComputeInstanceApplication" + } + }, + "createdBy": { + "readOnly": true, + "description": "Describes information on user who created this ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceCreatedBy" + }, + "errors": { + "readOnly": true, + "title": "Errors.", + "description": "Collection of errors encountered on this ComputeInstance.", + "type": "array", + "items": { + "$ref": "#/definitions/MachineLearningServiceError" + } + }, + "state": { + "description": "The current state of this ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceState", + "readOnly": true + }, + "computeInstanceAuthorizationType": { + "type": "string", + "title": "Compute Instance Authorization type.", + "description": "The Compute Instance Authorization type. Available values are personal (default).", + "default": "personal", + "enum": [ + "personal" + ], + "x-ms-enum": { + "name": "ComputeInstanceAuthorizationType", + "modelAsString": true + } + }, + "personalComputeInstanceSettings": { + "title": "Personal Compute Instance settings.", + "description": "Settings for a personal compute instance.", + "$ref": "#/definitions/PersonalComputeInstanceSettings" + }, + "lastOperation": { + "description": "The last operation on ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceLastOperation", + "readOnly": true + } + } + } + } + } + ], + "x-ms-discriminator-value": "ComputeInstance" + }, "VirtualMachine": { "description": "A Machine Learning compute based on Azure Virtual Machines.", "allOf": [ @@ -3534,6 +3774,7 @@ "enum": [ "AKS", "AmlCompute", + "ComputeInstance", "DataFactory", "VirtualMachine", "HDInsight", @@ -5575,6 +5816,193 @@ } ], "x-ms-discriminator-value": "Custom" + }, + "ComputeInstanceSshSettings": { + "type": "object", + "description": "Specifies policy and settings for SSH access.", + "properties": { + "sshPublicAccess": { + "type": "string", + "default": "Disabled", + "title": "Access policy for SSH", + "description": "State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "sshPublicAccess", + "modelAsString": true + } + }, + "adminUserName": { + "type": "string", + "readOnly": true, + "description": "Describes the admin user name." + }, + "sshPort": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Describes the port for connecting through SSH." + }, + "adminPublicKey": { + "type": "string", + "description": "Specifies the SSH rsa public key file as a string. Use \"ssh-keygen -t rsa -b 2048\" to generate your SSH key pairs." + } + } + }, + "ComputeInstanceState": { + "type": "string", + "description": "Current state of an ComputeInstance.", + "enum": [ + "Creating", + "CreateFailed", + "Deleting", + "Running", + "Restarting", + "JobRunning", + "SettingUp", + "SetupFailed", + "Starting", + "Stopped", + "Stopping", + "UserSettingUp", + "UserSetupFailed", + "Unknown", + "Unusable" + ], + "x-ms-enum": { + "name": "ComputeInstanceState", + "modelAsString": true + } + }, + "ComputeInstanceLastOperation": { + "type": "object", + "description": "The last operation on ComputeInstance.", + "properties": { + "operationName": { + "type": "string", + "description": "Name of the last operation.", + "enum": [ + "Create", + "Start", + "Stop", + "Restart", + "Reimage", + "Delete" + ], + "x-ms-enum": { + "name": "OperationName", + "modelAsString": true + } + }, + "operationTime": { + "type": "string", + "format": "date-time", + "description": "Time of the last operation." + }, + "operationStatus": { + "type": "string", + "description": "Operation status.", + "enum": [ + "InProgress", + "Succeeded", + "CreateFailed", + "StartFailed", + "StopFailed", + "RestartFailed", + "ReimageFailed", + "DeleteFailed" + ], + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": true + } + } + } + }, + "ComputeInstanceApplication": { + "type": "object", + "description": "Defines an Aml Instance application and its connectivity endpoint URI.", + "properties": { + "displayName": { + "type": "string", + "description": "Name of the ComputeInstance application." + }, + "endpointUri": { + "type": "string", + "description": "Application' endpoint URI." + } + } + }, + "ComputeInstanceConnectivityEndpoints": { + "type": "object", + "readOnly": true, + "description": "Defines all connectivity endpoints and properties for an ComputeInstance.", + "properties": { + "publicIpAddress": { + "type": "string", + "readOnly": true, + "description": "Public IP Address of this ComputeInstance." + }, + "privateIpAddress": { + "type": "string", + "readOnly": true, + "description": "Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed)." + } + } + }, + "ComputeInstanceCreatedBy": { + "type": "object", + "readOnly": true, + "description": "Describes information on user who created this ComputeInstance.", + "properties": { + "userName": { + "type": "string", + "readOnly": true, + "description": "Name of the user." + }, + "userOrgId": { + "type": "string", + "readOnly": true, + "description": "Uniquely identifies user' Azure Active Directory organization." + }, + "userId": { + "type": "string", + "readOnly": true, + "description": "Uniquely identifies the user within his/her organization." + } + } + }, + "PersonalComputeInstanceSettings": { + "type": "object", + "properties": { + "assignedUser": { + "$ref": "#/definitions/AssignedUser", + "title": "Assigned User.", + "description": "A user explicitly assigned to a personal compute instance." + } + }, + "description": "Settings for a personal compute instance." + }, + "AssignedUser": { + "type": "object", + "description": "A user that can be assigned to a compute instance.", + "properties": { + "objectId": { + "type": "string", + "description": "User’s AAD Object Id." + }, + "tenantId": { + "type": "string", + "description": "User’s AAD Tenant Id." + } + }, + "required": [ + "objectId", + "tenantId" + ] } } } From 962013a1cf9bf5b87e3aad75a14c7dd620acda62 Mon Sep 17 00:00:00 2001 From: Daniel Orozco <64658732+dagoroz@users.noreply.github.com> Date: Thu, 10 Sep 2020 21:39:48 -0700 Subject: [PATCH 036/164] modify description of properties to be self consistent (#10711) --- .../authorization-RoleAssignmentsCalls.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/authorization-RoleAssignmentsCalls.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/authorization-RoleAssignmentsCalls.json index c6733a4380c0..478c98bc5686 100644 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/authorization-RoleAssignmentsCalls.json +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/authorization-RoleAssignmentsCalls.json @@ -539,7 +539,7 @@ }, "conditionVersion": { "type": "string", - "description": "Version of the condition. Currently accepted values are '1.0' or '2.0'" + "description": "Version of the condition. Currently accepted value is '2.0'" } }, "description": "Role assignment properties with scope." @@ -625,11 +625,11 @@ }, "condition": { "type": "string", - "description": "The conditions on the role assignment" + "description": "The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'" }, "conditionVersion": { "type": "string", - "description": "Version of the condition" + "description": "Version of the condition. Currently accepted value is '2.0'" } }, "required": [ From 242a54e7a7bea7d91a6bc418f63a9984775ce56a Mon Sep 17 00:00:00 2001 From: eitrau <71026356+eitrau@users.noreply.github.com> Date: Fri, 11 Sep 2020 04:54:30 +0000 Subject: [PATCH 037/164] Swagger changes. Remove weekly and monthly options from replicationSchedule enum (#10752) Co-authored-by: Einar Traustason --- .../Microsoft.NetApp/stable/2019-08-01/netapp.json | 2 +- .../Microsoft.NetApp/stable/2019-10-01/netapp.json | 4 +--- .../Microsoft.NetApp/stable/2019-11-01/netapp.json | 4 +--- .../Microsoft.NetApp/stable/2020-02-01/netapp.json | 4 +--- .../Microsoft.NetApp/stable/2020-06-01/netapp.json | 4 +--- 5 files changed, 5 insertions(+), 13 deletions(-) diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-08-01/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-08-01/netapp.json index a3a8d6aa40a1..e71fd281e583 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-08-01/netapp.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-08-01/netapp.json @@ -1998,7 +1998,7 @@ "title": "replicationSchedule", "type": "string", "description": "Schedule", - "example": "10minutely, hourly, daily, weekly, monthly" + "example": "10minutely, hourly, daily" }, "remoteVolumeResourceId": { "title": "remoteVolumeResourceId", diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-10-01/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-10-01/netapp.json index 6a0529befb33..57334c79c13a 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-10-01/netapp.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-10-01/netapp.json @@ -2241,9 +2241,7 @@ "enum": [ "_10minutely", "hourly", - "daily", - "weekly", - "monthly" + "daily" ], "x-ms-enum": { "name": "ReplicationSchedule", diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-11-01/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-11-01/netapp.json index d5e2a155ee23..5c54e45f30f8 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-11-01/netapp.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2019-11-01/netapp.json @@ -2272,9 +2272,7 @@ "enum": [ "_10minutely", "hourly", - "daily", - "weekly", - "monthly" + "daily" ], "x-ms-enum": { "name": "ReplicationSchedule", diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-02-01/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-02-01/netapp.json index 3c8cef2ef1fa..91bd33676782 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-02-01/netapp.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-02-01/netapp.json @@ -2301,9 +2301,7 @@ "enum": [ "_10minutely", "hourly", - "daily", - "weekly", - "monthly" + "daily" ], "x-ms-enum": { "name": "ReplicationSchedule", diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/netapp.json index b5c85f46fcf8..c6fce9bbcc39 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/netapp.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/netapp.json @@ -3606,9 +3606,7 @@ "enum": [ "_10minutely", "hourly", - "daily", - "weekly", - "monthly" + "daily" ], "x-ms-enum": { "name": "ReplicationSchedule", From 7845c40070f04189d01c648e77de555cbf6ae61c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 11 Sep 2020 13:34:33 +0800 Subject: [PATCH 038/164] Bump node-fetch from 2.6.0 to 2.6.1 (#10760) Bumps [node-fetch](https://github.com/bitinn/node-fetch) from 2.6.0 to 2.6.1. - [Release notes](https://github.com/bitinn/node-fetch/releases) - [Changelog](https://github.com/node-fetch/node-fetch/blob/master/docs/CHANGELOG.md) - [Commits](https://github.com/bitinn/node-fetch/compare/v2.6.0...v2.6.1) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 88dedb0afaca..47e96443676a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -3717,9 +3717,9 @@ } }, "node-fetch": { - "version": "2.6.0", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.0.tgz", - "integrity": "sha512-8dG4H5ujfvFiqDmVu9fQ5bOHUC15JMjMY/Zumv26oOvvVJjM67KF8koCWIabKQ1GJIa9r2mMZscBq/TbdOcmNA==", + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.1.tgz", + "integrity": "sha512-V4aYg89jEoVRxRb2fJdAg8FHvI7cEyYdVAh94HH0UIK8oJxUfkjlDQN9RbMx+bEjP7+ggMiFRprSti032Oipxw==", "dev": true }, "node-object-hash": { From 044826c1e06f13aa6cfd9264c7f275d0f001c477 Mon Sep 17 00:00:00 2001 From: Pradeep Kintali <50682039+pradeepkintali@users.noreply.github.com> Date: Thu, 10 Sep 2020 22:50:04 -0700 Subject: [PATCH 039/164] PostgreSQL Flexible Server New API Swagger Changes (#10586) * PostgreSQL Flexible Server New API Swagger Changes * Fixed LintDiff errors. * Added Pagination for Capabilities API * Set Server Properties for Update as flatten. * Added sku properties as required. * Updated the HA enabled property and added new property * Added Virtual Network Subnet usage API changes * Updated the CMW API Contracts * Removed CMK API changes * Removed Unused Entities * Resolved code review comments * Fix prettier issues. * Added CMK API's * remove readonly property for custom window property * Fixed lint diff errors * Fixed server update for haEnabled property * Updated the Operation id for Location capabilities * Remove Readonly tag on publicNetworkAccess * Fix for standbyAvailabilityZone propertyName * Added readonly attribute to publicNetworkAccess --- .../examples/CapabilitiesByLocation.json | 180 +++++ .../CustomerMaintenanceWindowCreate.json | 46 -- .../CustomerMaintenanceWindowDelete.json | 14 - .../CustomerMaintenanceWindowGet.json | 24 - ...CustomerMaintenanceWindowListByServer.json | 27 - .../examples/ServerCreate.json | 43 +- .../ServerCreatePointInTimeRestore.json | 8 +- .../examples/ServerGet.json | 10 +- .../examples/ServerGetWithVnet.json | 7 +- .../examples/ServerKeyCreateOrUpdate.json | 43 ++ .../examples/ServerKeyDelete.json | 14 + .../examples/ServerKeyGet.json | 24 + .../examples/ServerKeyList.json | 27 + .../examples/ServerList.json | 38 +- .../examples/ServerListByResourceGroup.json | 28 +- .../examples/ServerUpdate.json | 3 +- ...erUpdateWithCustomerMaintenanceWindow.json | 59 ++ .../examples/VirtualNetworkSubnetUsage.json | 26 + .../2020-02-14-privatepreview/postgresql.json | 686 +++++++++++++----- 19 files changed, 993 insertions(+), 314 deletions(-) create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CapabilitiesByLocation.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowCreate.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowDelete.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowGet.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerKeyCreateOrUpdate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerKeyDelete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerKeyGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerKeyList.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerUpdateWithCustomerMaintenanceWindow.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/VirtualNetworkSubnetUsage.json diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CapabilitiesByLocation.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CapabilitiesByLocation.json new file mode 100644 index 000000000000..9921b8a4c681 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CapabilitiesByLocation.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "api-version": "2020-02-14-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "locationName": "WestUS" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "zone": "none", + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768 + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536 + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072 + } + ] + } + ], + "supportedServerVersions": [ + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_B1s", + "vCores": 1, + "supportedIops": 320, + "supportedMemoryPerVcoreMB": 1024 + }, + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048 + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048 + } + ] + } + ] + } + ] + }, + { + "zone": "1", + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768 + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536 + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072 + } + ] + } + ], + "supportedServerVersions": [ + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_B1s", + "vCores": 1, + "supportedIops": 320, + "supportedMemoryPerVcoreMB": 1024 + }, + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048 + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048 + } + ] + } + ] + } + ] + }, + { + "zone": "2", + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768 + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536 + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072 + } + ] + } + ], + "supportedServerVersions": [ + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_B1s", + "vCores": 1, + "supportedIops": 320, + "supportedMemoryPerVcoreMB": 1024 + }, + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048 + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048 + } + ] + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowCreate.json deleted file mode 100644 index 648e0befb9a2..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowCreate.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "parameters": { - "maintenanceWindowName": "customerMaintenanceWindow", - "serverName": "testserver", - "resourceGroupName": "testrg", - "api-version": "2020-02-14-privatepreview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", - "parameters": { - "properties": { - "dayOfWeek": 1, - "startHour": 0, - "startMinute": 30, - "durationInMinutes": 30 - } - } - }, - "responses": { - "201": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/prkinteastus/maintenanceWindows/customerMaintenanceWindow", - "name": "customerMaintenanceWindow", - "properties": { - "dayOfWeek": 1, - "startHour": 0, - "startMinute": 30, - "durationInMinutes": 30 - }, - "type": "Microsoft.DBforPostgreSQL/flexibleServers/maintenanceWindows" - } - }, - "200": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/prkinteastus/maintenanceWindows/customerMaintenanceWindow", - "name": "customerMaintenanceWindow", - "properties": { - "dayOfWeek": 1, - "startHour": 0, - "startMinute": 30, - "durationInMinutes": 30 - }, - "type": "Microsoft.DBforPostgreSQL/flexibleServers/maintenanceWindows" - } - }, - "202": {} - } -} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowDelete.json deleted file mode 100644 index cafa0a76ed07..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowDelete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "maintenanceWindowName": "customerMaintenanceWindow", - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2020-02-14-privatepreview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowGet.json deleted file mode 100644 index 8febc0a4b487..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowGet.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "maintenanceWindowName": "customerMaintenanceWindow", - "serverName": "testserver", - "resourceGroupName": "testrg", - "api-version": "2020-02-14-privatepreview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/prkinteastus/maintenanceWindows/customerMaintenanceWindow", - "name": "customerMaintenanceWindow", - "properties": { - "dayOfWeek": 1, - "startHour": 0, - "startMinute": 30, - "durationInMinutes": 30 - }, - "type": "Microsoft.DBforPostgreSQL/flexibleServers/maintenanceWindows" - } - } - } -} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowListByServer.json deleted file mode 100644 index aff335545a5c..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowListByServer.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "serverName": "testserver", - "resourceGroupName": "testrg", - "api-version": "2020-02-14-privatepreview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/prkinteastus/maintenanceWindows/customerMaintenanceWindow", - "name": "customerMaintenanceWindow", - "properties": { - "dayOfWeek": 1, - "startHour": 0, - "startMinute": 30, - "durationInMinutes": 30 - }, - "type": "Microsoft.DBforPostgreSQL/flexibleServers/maintenanceWindows" - } - ] - } - } - } -} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerCreate.json index ebb30c443b02..857216019136 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerCreate.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerCreate.json @@ -14,12 +14,9 @@ "administratorLogin": "cloudsa", "administratorLoginPassword": "password", "version": "12", - "standbyCount": 0, - "vnetInjArgs": { - "delegatedSubnetName": "test-subnet", - "delegatedVnetID": "6ed504a3-24b8-4ba8-ac1f-7a1780195437", - "delegatedVnetName": "test-vnet", - "delegatedVnetResourceGroup": "test-vnet-rg" + "haEnabled": "Enabled", + "delegatedSubnetArguments": { + "subnetArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet" }, "storageProfile": { "storageMB": 524288, @@ -47,17 +44,22 @@ "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", "displayName": "demosingleserver", "publicNetworkAccess": "Enabled", - "standbyCount": 0, - "vnetInjArgs": { - "delegatedSubnetName": "test-subnet", - "delegatedVnetID": "6ed504a3-24b8-4ba8-ac1f-7a1780195437", - "delegatedVnetName": "test-vnet" + "haEnabled": "Enabled", + "delegatedSubnetArguments": { + "subnetArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet" }, "storageProfile": { "storageMB": 524288, "backupRetentionDays": 7 }, - "availabilityZone": "1" + "availabilityZone": "1", + "standbyAvailabilityZone": "2", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0, + "customWindow": "Disabled" + } }, "location": "westus", "tags": { @@ -82,17 +84,22 @@ "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", "displayName": "demosingleserver", "publicNetworkAccess": "Enabled", - "standbyCount": 0, - "vnetInjArgs": { - "delegatedSubnetName": "test-subnet", - "delegatedVnetID": "6ed504a3-24b8-4ba8-ac1f-7a1780195437", - "delegatedVnetName": "test-vnet" + "haEnabled": "Enabled", + "delegatedSubnetArguments": { + "subnetArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet" }, "storageProfile": { "storageMB": 524288, "backupRetentionDays": 7 }, - "availabilityZone": "1" + "availabilityZone": "1", + "standbyAvailabilityZone": "2", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0, + "customWindow": "Disabled" + } }, "location": "westus", "tags": { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerCreatePointInTimeRestore.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerCreatePointInTimeRestore.json index a1218b930091..803ad0031622 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerCreatePointInTimeRestore.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerCreatePointInTimeRestore.json @@ -28,8 +28,8 @@ "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", "displayName": "demosingleserver", "publicNetworkAccess": "Enabled", - "standbyCount": 0, - "vnetInjArgs": {}, + "haEnabled": "Disabled", + "delegatedSubnetArguments": {}, "storageProfile": { "storageMB": 524288, "backupRetentionDays": 7 @@ -59,8 +59,8 @@ "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", "displayName": "demosingleserver", "publicNetworkAccess": "Enabled", - "standbyCount": 0, - "vnetInjArgs": {}, + "haEnabled": "Disabled", + "delegatedSubnetArguments": {}, "storageProfile": { "storageMB": 524288, "backupRetentionDays": 7 diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerGet.json index 90c6c3275d72..219f82e99064 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerGet.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerGet.json @@ -24,7 +24,15 @@ "storageMB": 524288, "backupRetentionDays": 7 }, - "availabilityZone": "1" + "haEnabled": "Enabled", + "availabilityZone": "1", + "standbyAvailabilityZone": "2", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0, + "customWindow": "Disabled" + } }, "location": "westus", "tags": { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerGetWithVnet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerGetWithVnet.json index bfb6f8603d5e..d1f727e6dab8 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerGetWithVnet.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerGetWithVnet.json @@ -20,11 +20,8 @@ "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", "displayName": "demosingleserver", "publicNetworkAccess": "Disabled", - "vnetInjArgs": { - "delegatedSubnetName": "test-subnet", - "delegatedVnetID": "6ed504a3-24b8-4ba8-ac1f-7a1780195437", - "delegatedVnetName": "test-vnet", - "delegatedVnetResourceGroup": "test-vnet-rg" + "delegatedSubnetArguments": { + "subnetArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet" }, "storageProfile": { "storageMB": 524288, diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerKeyCreateOrUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerKeyCreateOrUpdate.json new file mode 100644 index 000000000000..c42b5c076cc6 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerKeyCreateOrUpdate.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "serverName": "testserver", + "keyName": "someVault_someKey_01234567890123456789012345678901", + "api-version": "2020-02-14-privatepreview", + "parameters": { + "properties": { + "serverKeyType": "AzureKeyVault", + "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/keys/someVault_someKey_01234567890123456789012345678901", + "name": "omeVault_someKey_01234567890123456789012345678901", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/keys", + "kind": "azurekeyvault", + "properties": { + "serverKeyType": "AzureKeyVault", + "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901", + "creationDate": "2017-05-01T00:00:00.0Z" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/keys/someVault_someKey_01234567890123456789012345678901", + "name": "omeVault_someKey_01234567890123456789012345678901", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/keys", + "kind": "azurekeyvault", + "properties": { + "serverKeyType": "AzureKeyVault", + "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901", + "creationDate": "2017-05-01T00:00:00.0Z" + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerKeyDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerKeyDelete.json new file mode 100644 index 000000000000..769fa6985a14 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerKeyDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "serverName": "testserver", + "keyName": "someVault_someKey_01234567890123456789012345678901", + "api-version": "2020-02-14-privatepreview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerKeyGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerKeyGet.json new file mode 100644 index 000000000000..87fdede04e58 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerKeyGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "serverName": "testserver", + "keyName": "someVault_someKey_01234567890123456789012345678901", + "api-version": "2020-02-14-privatepreview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/keys/someVault_someKey_01234567890123456789012345678901", + "name": "someVault_someKey_01234567890123456789012345678901", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/keys", + "kind": "azurekeyvault", + "properties": { + "serverKeyType": "AzureKeyVault", + "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901", + "creationDate": "2019-12-01T00:00:00.0Z" + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerKeyList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerKeyList.json new file mode 100644 index 000000000000..f0923ae1877b --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerKeyList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "serverName": "testserver", + "api-version": "2020-02-14-privatepreview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/keys/someVault_someKey_01234567890123456789012345678901", + "name": "someVault_someKey_01234567890123456789012345678901", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/keys", + "kind": "azurekeyvault", + "properties": { + "serverKeyType": "AzureKeyVault", + "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901", + "creationDate": "2019-12-01T00:00:00.0Z" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerList.json index 494a116c5baa..6331599d553d 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerList.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerList.json @@ -25,7 +25,15 @@ "storageMB": 524288, "backupRetentionDays": 7 }, - "availabilityZone": "1" + "haEnabled": "Enabled", + "availabilityZone": "1", + "standbyAvailabilityZone": "2", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0, + "customWindow": "Disabled" + } }, "location": "westus", "tags": { @@ -52,7 +60,14 @@ "storageMB": 524288, "backupRetentionDays": 7 }, - "availabilityZone": "2" + "haEnabled": "Disabled", + "availabilityZone": "2", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 10, + "startMinute": 30, + "customWindow": "Enabled" + } }, "location": "westus", "tags": { @@ -79,7 +94,14 @@ "storageMB": 524288, "backupRetentionDays": 7 }, - "availabilityZone": "3" + "haEnabled": "Disabled", + "availabilityZone": "3", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0, + "customWindow": "Disabled" + } }, "location": "westus", "tags": { @@ -106,7 +128,15 @@ "storageMB": 524288, "backupRetentionDays": 7 }, - "availabilityZone": "1" + "haEnabled": "Enabled", + "availabilityZone": "1", + "standbyAvailabilityZone": "2", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0, + "customWindow": "Disabled" + } }, "location": "westus", "tags": { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerListByResourceGroup.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerListByResourceGroup.json index f2861579356f..ccc95d5b83ec 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerListByResourceGroup.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerListByResourceGroup.json @@ -26,7 +26,15 @@ "storageMB": 524288, "backupRetentionDays": 7 }, - "availabilityZone": "1" + "haEnabled": "Enabled", + "availabilityZone": "1", + "standbyAvailabilityZone": "2", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 10, + "startMinute": 30, + "customWindow": "Enabled" + } }, "location": "westus", "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/pgtestsvc1", @@ -50,7 +58,14 @@ "storageMB": 524288, "backupRetentionDays": 7 }, - "availabilityZone": "2" + "haEnabled": "Disabled", + "availabilityZone": "2", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0, + "customWindow": "Disabled" + } }, "location": "westus", "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc2", @@ -74,7 +89,14 @@ "storageMB": 524288, "backupRetentionDays": 7 }, - "availabilityZone": "3" + "haEnabled": "Disabled", + "availabilityZone": "3", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 10, + "startMinute": 30, + "customWindow": "Enabled" + } }, "location": "westus", "tags": { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerUpdate.json index 9be524337d1a..cd18ac62f1c0 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerUpdate.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerUpdate.json @@ -38,7 +38,8 @@ "storageMB": 524288, "backupRetentionDays": 20 }, - "vnetInjArgs": {}, + "delegatedSubnetArguments": {}, + "haEnabled": "Disabled", "availabilityZone": "1" }, "location": "westus", diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerUpdateWithCustomerMaintenanceWindow.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerUpdateWithCustomerMaintenanceWindow.json new file mode 100644 index 000000000000..0bf2308701ca --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerUpdateWithCustomerMaintenanceWindow.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2020-02-14-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "properties": { + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 8, + "startMinute": 0, + "customWindow": "Enabled" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "version": "12", + "state": "Ready", + "haState": "NotEnabled", + "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", + "displayName": "demosingleserver", + "publicNetworkAccess": "Enabled", + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 20 + }, + "delegatedSubnetArguments": {}, + "haEnabled": "Disabled", + "availabilityZone": "1", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 8, + "startMinute": 0, + "customWindow": "Enabled" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/VirtualNetworkSubnetUsage.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/VirtualNetworkSubnetUsage.json new file mode 100644 index 000000000000..79466a840f2b --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/VirtualNetworkSubnetUsage.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2020-02-14-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "locationName": "WestUS", + "parameters": { + "virtualNetworkArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/testvnet" + } + }, + "responses": { + "200": { + "body": { + "delegatedSubnetsUsage": [ + { + "subnetName": "test-subnet-1", + "usage": 2 + }, + { + "subnetName": "test-subnet-2", + "usage": 3 + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/postgresql.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/postgresql.json index f64a25a4b225..830dbfac5a09 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/postgresql.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/postgresql.json @@ -105,6 +105,9 @@ "x-ms-examples": { "ServerUpdate": { "$ref": "./examples/ServerUpdate.json" + }, + "ServerUpdateWithCustomerMaintenanceWindow": { + "$ref": "./examples/ServerUpdateWithCustomerMaintenanceWindow.json" } }, "description": "Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.", @@ -793,18 +796,13 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/flexibleServers/{serverName}/maintenanceWindows/{maintenanceWindowName}": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/flexibleServers/{serverName}/keys": { + "get": { "tags": [ - "CustomerMaintenanceWindow" + "ServerKeys" ], - "operationId": "CustomerMaintenanceWindow_CreateOrUpdate", - "x-ms-examples": { - "CustomerMaintenanceWindowCreate": { - "$ref": "./examples/CustomerMaintenanceWindowCreate.json" - } - }, - "description": "Creates a new customer maintenance window.", + "description": "Gets a list of Server keys.", + "operationId": "ServerKeys_List", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" @@ -812,6 +810,45 @@ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of PostgreSQL Server keys.", + "schema": { + "$ref": "#/definitions/ServerKeyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List the keys for a PostgreSQL Server.": { + "$ref": "./examples/ServerKeyList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/flexibleServers/{serverName}/keys/{keyName}": { + "get": { + "tags": [ + "ServerKeys" + ], + "description": "Gets a PostgreSQL Server key.", + "operationId": "ServerKeys_Get", + "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, @@ -819,34 +856,88 @@ "$ref": "#/parameters/ServerNameParameter" }, { - "$ref": "#/parameters/MaintenanceWindowNameParameter" + "name": "keyName", + "in": "path", + "description": "The name of the PostgreSQL Server key to be retrieved.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified PostgreSQL Server key.", + "schema": { + "$ref": "#/definitions/ServerKey" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get the PostgreSQL Server key": { + "$ref": "./examples/ServerKeyGet.json" + } + } + }, + "put": { + "tags": [ + "ServerKeys" + ], + "description": "Creates or updates a PostgreSQL Server key.", + "operationId": "ServerKeys_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "keyName", + "in": "path", + "description": "The name of the PostgreSQL Server key to be operated on (updated or created).", + "required": true, + "type": "string" }, { "name": "parameters", "in": "body", + "description": "The requested PostgreSQL Server key resource state.", "required": true, "schema": { - "$ref": "#/definitions/CustomerMaintenanceWindow" - }, - "description": "The required parameters for creating or updating a customer maintenance window." + "$ref": "#/definitions/ServerKey" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { - "description": "OK", + "description": "Successfully updated the PostgreSQL Server key.", "schema": { - "$ref": "#/definitions/CustomerMaintenanceWindow" + "$ref": "#/definitions/ServerKey" } }, - "201": { - "description": "Created", + "202": { + "description": "Operation in progress", "schema": { - "$ref": "#/definitions/CustomerMaintenanceWindow" + "$ref": "#/definitions/ServerKey" } }, - "202": { - "description": "Accepted" - }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -854,45 +945,49 @@ } } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates or updates a PostgreSQL Server key": { + "$ref": "./examples/ServerKeyCreateOrUpdate.json" + } + } }, "delete": { "tags": [ - "CustomerMaintenanceWindow" + "ServerKeys" ], - "operationId": "CustomerMaintenanceWindow_Delete", - "x-ms-examples": { - "CustomerMaintenanceWindowDelete": { - "$ref": "./examples/CustomerMaintenanceWindowDelete.json" - } - }, - "description": "Deletes a PostgreSQL server Customer maintenance window.", + "description": "Deletes the PostgreSQL Server key with the given name.", + "operationId": "ServerKeys_Delete", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/ServerNameParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + "name": "keyName", + "in": "path", + "description": "The name of the PostgreSQL Server key to be deleted.", + "required": true, + "type": "string" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ServerNameParameter" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/MaintenanceWindowNameParameter" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { - "description": "OK" + "description": "Successfully deleted the PostgreSQL Server key." }, "202": { - "description": "Accepted" + "description": "Operation in progress" }, "204": { - "description": "NoContent" + "description": "The specified PostgreSQL Server key does not exist." }, "default": { "description": "Error response describing why the operation failed.", @@ -901,19 +996,26 @@ } } }, - "x-ms-long-running-operation": true - }, - "get": { + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete the PostgreSQL Server key": { + "$ref": "./examples/ServerKeyDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSql/checkNameAvailability": { + "post": { "tags": [ - "CustomerMaintenanceWindow" + "CheckNameAvailability" ], - "operationId": "CustomerMaintenanceWindow_Get", + "operationId": "CheckNameAvailability_Execute", "x-ms-examples": { - "CustomerMaintenanceWindowGet": { - "$ref": "./examples/CustomerMaintenanceWindowGet.json" + "NameAvailability": { + "$ref": "./examples/CheckNameAvailability.json" } }, - "description": "Get the Customer maintenance windows of a given PostgreSQL server.", + "description": "Check the availability of name for resource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" @@ -922,20 +1024,20 @@ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/MaintenanceWindowNameParameter" + "name": "nameAvailabilityRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NameAvailabilityRequest" + }, + "description": "The required parameters for checking if resource name is available." } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CustomerMaintenanceWindow" + "$ref": "#/definitions/NameAvailability" } }, "default": { @@ -947,18 +1049,18 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/flexibleServers/{serverName}/maintenanceWindows": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSql/locations/{locationName}/capabilities": { "get": { "tags": [ - "CustomerMaintenanceWindow" + "LocationBasedCapabilities" ], - "operationId": "CustomerMaintenanceWindow_ListByServer", + "operationId": "LocationBasedCapabilities_Execute", "x-ms-examples": { - "CustomerMaintenanceWindowList": { - "$ref": "./examples/CustomerMaintenanceWindowListByServer.json" + "CapabilitiesList": { + "$ref": "./examples/CapabilitiesByLocation.json" } }, - "description": "List all the Customer Maintenance Windows in a given PostgreSQL flexible server.", + "description": "Get capabilities at specified location in a given subscription.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" @@ -967,17 +1069,14 @@ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" + "$ref": "#/parameters/LocationNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CustomerMaintenanceWindowListResult" + "$ref": "#/definitions/CapabilitiesListResult" } }, "default": { @@ -986,21 +1085,24 @@ "$ref": "#/definitions/CloudError" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSql/checkNameAvailability": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSql/locations/{locationName}/checkVirtualNetworkSubnetUsage": { "post": { "tags": [ - "CheckNameAvailability" + "VirtualNetworkSubnetUsage" ], - "operationId": "CheckNameAvailability_Execute", + "operationId": "VirtualNetworkSubnetUsage_Execute", "x-ms-examples": { - "NameAvailability": { - "$ref": "./examples/CheckNameAvailability.json" + "VirtualNetworkSubnetUsageList": { + "$ref": "./examples/VirtualNetworkSubnetUsage.json" } }, - "description": "Check the availability of name for resource", + "description": "Get virtual network subnet usage for a given vNet resource id.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" @@ -1009,20 +1111,23 @@ "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { - "name": "nameAvailabilityRequest", + "$ref": "#/parameters/LocationNameParameter" + }, + { + "name": "parameters", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/NameAvailabilityRequest" + "$ref": "#/definitions/VirtualNetworkSubnetUsageParameter" }, - "description": "The required parameters for checking if resource name is available." + "description": "The required parameters for creating or updating a server." } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/NameAvailability" + "$ref": "#/definitions/VirtualNetworkSubnetUsageResult" } }, "default": { @@ -1069,11 +1174,269 @@ } }, "definitions": { + "ServerKeyListResult": { + "description": "A list of PostgreSQL Server keys.", + "type": "object", + "properties": { + "value": { + "description": "A list of PostgreSQL Server keys.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerKey" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ServerKeyProperties": { + "description": "Properties for a key execution.", + "required": [ + "serverKeyType" + ], + "type": "object", + "properties": { + "serverKeyType": { + "description": "The key type like 'AzureKeyVault'.", + "enum": [ + "AzureKeyVault" + ], + "type": "string", + "x-ms-enum": { + "name": "ServerKeyType", + "modelAsString": true + } + }, + "uri": { + "description": "The URI of the key.", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "description": "The key creation date.", + "type": "string", + "readOnly": true + } + } + }, + "ServerKey": { + "description": "A PostgreSQL Server key.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "kind": { + "description": "Kind of encryption protector used to protect the key.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/ServerKeyProperties", + "description": "Properties of the ServerKey Resource.", + "x-ms-client-flatten": true + } + } + }, + "VirtualNetworkSubnetUsageParameter": { + "type": "object", + "properties": { + "virtualNetworkArmResourceId": { + "type": "string", + "description": "Virtual network resource id." + } + }, + "description": "Virtual network subnet usage parameter" + }, + "VirtualNetworkSubnetUsageResult": { + "type": "object", + "properties": { + "delegatedSubnetsUsage": { + "type": "array", + "items": { + "$ref": "#/definitions/DelegatedSubnetUsage" + }, + "readOnly": true + } + }, + "description": "Virtual network subnet usage data." + }, + "DelegatedSubnetUsage": { + "type": "object", + "properties": { + "subnetName": { + "type": "string", + "readOnly": true, + "description": "name of the subnet" + }, + "usage": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Number of used delegated subnets" + } + }, + "description": "Delegated subnet usage data." + }, + "StorageMBCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "storage MB name", + "readOnly": true + }, + "supportedIops": { + "type": "integer", + "format": "int64", + "description": "supported IOPS", + "readOnly": true + }, + "storageSizeMB": { + "type": "integer", + "format": "int64", + "description": "storage size in MB", + "readOnly": true + } + }, + "description": "storage size in MB capability" + }, + "VcoreCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "vCore name", + "readOnly": true + }, + "vCores": { + "type": "integer", + "format": "int64", + "description": "supported vCores", + "readOnly": true + }, + "supportedIops": { + "type": "integer", + "format": "int64", + "description": "supported IOPS", + "readOnly": true + }, + "supportedMemoryPerVcoreMB": { + "type": "integer", + "format": "int64", + "description": "supported memory per vCore in MB", + "readOnly": true + } + }, + "description": "Vcores capability" + }, + "ServerVersionCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "server version", + "readOnly": true + }, + "supportedVcores": { + "type": "array", + "items": { + "$ref": "#/definitions/VcoreCapability" + }, + "readOnly": true + } + }, + "description": "Server version capabilities." + }, + "StorageEditionCapability": { + "properties": { + "name": { + "type": "string", + "description": "storage edition name", + "readOnly": true + }, + "supportedStorageMB": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageMBCapability" + }, + "readOnly": true + } + }, + "description": "storage edition capability" + }, + "ServerEditionCapability": { + "properties": { + "name": { + "type": "string", + "description": "Server edition name", + "readOnly": true + }, + "supportedStorageEditions": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageEditionCapability" + }, + "readOnly": true + }, + "supportedServerVersions": { + "type": "array", + "items": { + "$ref": "#/definitions/ServerVersionCapability" + }, + "readOnly": true + } + }, + "description": "Server edition capabilities." + }, + "CapabilityProperties": { + "properties": { + "zone": { + "type": "string", + "description": "zone name", + "readOnly": true + }, + "supportedFlexibleServerEditions": { + "type": "array", + "items": { + "$ref": "#/definitions/ServerEditionCapability" + }, + "readOnly": true + } + }, + "description": "Location capabilities." + }, + "CapabilitiesListResult": { + "type": "object", + "properties": { + "value": { + "description": "A list of supported capabilities.", + "type": "array", + "items": { + "$ref": "#/definitions/CapabilityProperties" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + }, + "description": "location capability" + }, "ServerVersion": { "type": "string", "description": "The version of a server.", "enum": [ - "12" + "12", + "11" ], "x-ms-enum": { "name": "ServerVersion", @@ -1162,12 +1525,24 @@ "x-ms-enum": { "name": "ServerPublicNetworkAccessState", "modelAsString": true - } + }, + "readOnly": true }, - "standbyCount": { - "type": "integer", - "format": "int32", - "description": "stand by count value can be either 0 or 1" + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window of a server." + }, + "haEnabled": { + "type": "string", + "description": "stand by count value can be either enabled or disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "HAEnabledEnum", + "modelAsString": false + } }, "sourceServerName": { "type": "string", @@ -1182,23 +1557,21 @@ "type": "string", "description": "availability Zone information of the server." }, - "vnetInjArgs": { + "standbyAvailabilityZone": { + "type": "string", + "description": "availability Zone information of the server.", + "readOnly": true + }, + "byokEnforcement": { + "type": "string", + "description": "Status showing whether the data encryption is enabled with customer-managed keys.", + "readOnly": true + }, + "delegatedSubnetArguments": { "properties": { - "delegatedVnetID": { - "type": "string", - "description": "delegated vNet ID" - }, - "delegatedSubnetName": { - "type": "string", - "description": "delegated subnet name" - }, - "delegatedVnetName": { + "subnetArmResourceId": { "type": "string", - "description": "delegated vNet name" - }, - "delegatedVnetResourceGroup": { - "type": "string", - "description": "delegated vNet resource group name" + "description": "delegated subnet arm resource id." } } }, @@ -1250,6 +1623,31 @@ ], "description": "Represents a server." }, + "MaintenanceWindow": { + "type": "object", + "description": "Maintenance window of a server.", + "properties": { + "customWindow": { + "type": "string", + "description": "indicates whether custom window is enabled or disabled" + }, + "startHour": { + "type": "integer", + "format": "int32", + "description": "start hour for maintenance window" + }, + "startMinute": { + "type": "integer", + "format": "int32", + "description": "start minute for maintenance window" + }, + "dayOfWeek": { + "type": "integer", + "format": "int32", + "description": "day of week for maintenance window" + } + } + }, "ServerPropertiesForUpdate": { "properties": { "administratorLoginPassword": { @@ -1257,19 +1655,25 @@ "format": "password", "description": "The password of the administrator login." }, - "vCores": { - "type": "integer", - "format": "int32", - "description": "Max compute of a server is 64vCores." - }, "storageProfile": { "$ref": "#/definitions/StorageProfile", "description": "Storage profile of a server." }, - "standbyCount": { - "type": "integer", - "format": "int32", - "description": "stand by count value can be either 0 or 1" + "haEnabled": { + "type": "string", + "description": "stand by count value can be either enabled or disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "HAEnabledEnum", + "modelAsString": false + } + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window of a server." } } }, @@ -1285,7 +1689,7 @@ }, "properties": { "$ref": "#/definitions/ServerPropertiesForUpdate", - "x-ms-client-flatten": false, + "x-ms-client-flatten": true, "description": "Properties of the server." }, "tags": { @@ -1410,66 +1814,6 @@ }, "description": "A list of firewall rules." }, - "CustomerMaintenanceWindowProperties": { - "properties": { - "dayOfWeek": { - "type": "integer", - "format": "int32", - "description": "The day of week of the customer maintenance window to start" - }, - "durationInMinutes": { - "type": "integer", - "format": "int32", - "description": "The duration of the customer maintenance window to run." - }, - "startHour": { - "type": "integer", - "format": "int32", - "description": "The starting hour of the customer maintenance window." - }, - "startMinute": { - "type": "integer", - "format": "int32", - "description": "The starting minutes of the customer maintenance window." - } - }, - "required": [ - "dayOfWeek", - "startHour", - "startMinute" - ], - "description": "The properties of a server firewall rule." - }, - "CustomerMaintenanceWindow": { - "properties": { - "properties": { - "$ref": "#/definitions/CustomerMaintenanceWindowProperties", - "x-ms-client-flatten": true, - "description": "The properties of a customer maintenance window." - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" - } - ], - "required": [ - "properties" - ], - "description": "Represents a server firewall rule." - }, - "CustomerMaintenanceWindowListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/CustomerMaintenanceWindow" - }, - "description": "The list of CustomerMaintenanceWindows in a PostgreSQL server." - } - }, - "description": "A list of firewall rules." - }, "ConfigurationProperties": { "properties": { "value": { @@ -1668,6 +2012,14 @@ } }, "parameters": { + "LocationNameParameter": { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the location.", + "x-ms-parameter-location": "method" + }, "ServerNameParameter": { "name": "serverName", "in": "path", From 8d2a964d65d096f65b32a6af2d6c6eb46918f817 Mon Sep 17 00:00:00 2001 From: Page Bowers <40775967+pabowers@users.noreply.github.com> Date: Thu, 10 Sep 2020 23:50:14 -0700 Subject: [PATCH 040/164] [Hub Generated] Review request for Microsoft.BareMetalInfrastructure to add version preview/2020-08-06-preview (#10677) * New Readme Config File * New Go Language Readme Config File * New Typescript Language Readme Config File * New Python Language Readme Config File * New C# Language Readme Config File * New Ruby Language Readme Config File * New Swagger Spec File * New Swagger Example Spec File * started writing basic swagger specs for AzureBareMetalInstances it still needs some work * cleaning up some leftover naming from hana * adding an operationId for listByResourceGroup * changing the folder path to match our namespace * updating a slight naming change * addressing April's nit comments * changing the code generation name to be capitalized to meet python standards * Redoing most of the linting and prettier checks to make sure the api looks good * change json file name back to fix linter * add isDataAction to operation list type * Fixing an incorrectly named operation * rename title to be a client * fix go README.MD to have correct format with namespace * rename the list methods to conform to standards * changed to use common types for the majority of the parameters * use common error type and resource type * Change the error type back so that it complies with correct error response schema --- custom-words.txt | 1 + .../baremetalinfrastructure.json | 835 ++++++++++++++++++ .../AzureBareMetalInstances_Delete.json | 13 + .../examples/AzureBareMetalInstances_Get.json | 47 + .../AzureBareMetalInstances_List.json | 90 ++ ...BareMetalInstances_ListBySubscription.json | 84 ++ .../AzureBareMetalInstances_PatchTags.json | 55 ++ ...reBareMetalInstances_PatchTags_Delete.json | 51 ++ .../AzureBareMetalInstances_Restart.json | 12 + .../AzureBareMetalInstances_Shutdown.json | 12 + .../AzureBareMetalInstances_Start.json | 12 + .../AzureBareMetalOperations_List.json | 35 + .../resource-manager/readme.csharp.md | 15 + .../resource-manager/readme.go.md | 19 + .../resource-manager/readme.md | 79 ++ .../resource-manager/readme.python.md | 21 + .../resource-manager/readme.ruby.md | 19 + .../resource-manager/readme.typescript.md | 13 + 18 files changed, 1413 insertions(+) create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_Delete.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_Get.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_List.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_ListBySubscription.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_PatchTags.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_PatchTags_Delete.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_Restart.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_Shutdown.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_Start.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalOperations_List.json create mode 100644 specification/baremetalinfrastructure/resource-manager/readme.csharp.md create mode 100644 specification/baremetalinfrastructure/resource-manager/readme.go.md create mode 100644 specification/baremetalinfrastructure/resource-manager/readme.md create mode 100644 specification/baremetalinfrastructure/resource-manager/readme.python.md create mode 100644 specification/baremetalinfrastructure/resource-manager/readme.ruby.md create mode 100644 specification/baremetalinfrastructure/resource-manager/readme.typescript.md diff --git a/custom-words.txt b/custom-words.txt index a77f70924266..d290273324d7 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -195,6 +195,7 @@ Baidu bangla Bahasa baremetal +baremetalinfrastructure BATCHAI batchmanaged BAYESIANOPTIMIZATION diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json new file mode 100644 index 000000000000..7e70ac58553f --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json @@ -0,0 +1,835 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-08-06-preview", + "title": "bareMetalInfrastructureClient", + "description": "The BareMetalInfrastructure Management client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}/start": { + "post": { + "description": "The operation to start an AzureBareMetal instance", + "operationId": "AzureBareMetalInstances_Start", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Start an AzureBareMetal instance": { + "$ref": "./examples/AzureBareMetalInstances_Start.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureBareMetalInstanceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}/restart": { + "post": { + "description": "The operation to restart an AzureBareMetal instance", + "operationId": "AzureBareMetalInstances_Restart", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Restart an AzureBareMetal instance": { + "$ref": "./examples/AzureBareMetalInstances_Restart.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureBareMetalInstanceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}/shutdown": { + "post": { + "description": "The operation to shutdown an AzureBareMetal instance", + "operationId": "AzureBareMetalInstances_Shutdown", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Shutdown an AzureBareMetal instance": { + "$ref": "./examples/AzureBareMetalInstances_Shutdown.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureBareMetalInstanceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances": { + "get": { + "tags": [ + "BareMetalInfrastructure" + ], + "operationId": "AzureBareMetalInstances_ListBySubscription", + "summary": "Gets a list of Azure BareMetal instances in the specified subscription.", + "description": "Gets a list of AzureBareMetal instances in the specified subscription. The operations returns various properties of each Azure BareMetal instance.", + "x-ms-examples": { + "List all AzureBareMetal instances in a subscription": { + "$ref": "./examples/AzureBareMetalInstances_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBareMetalInstancesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances": { + "get": { + "operationId": "AzureBareMetalInstances_List", + "description": "Gets a list of AzureBareMetal instances in the specified subscription and resource group", + "x-ms-examples": { + "List all AzureBareMetal instances in a resource group": { + "$ref": "./examples/AzureBareMetalInstances_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBareMetalInstancesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.BareMetalInfrastructure/operations": { + "get": { + "tags": [ + "AzureBareMetal" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "List all management operations supported by the AzureBareMetal RP": { + "$ref": "./examples/AzureBareMetalOperations_List.json" + } + }, + "description": "Gets a list of AzureBareMetal management operations.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}": { + "get": { + "tags": [ + "BareMetalInfrastructure" + ], + "operationId": "AzureBareMetalInstances_Get", + "summary": "Gets an Azure BareMetal instance.", + "description": "Gets an Azure BareMetal instance for the specified subscription, resource group, and instance name.", + "x-ms-examples": { + "Get an AzureBareMetal instance": { + "$ref": "./examples/AzureBareMetalInstances_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureBareMetalInstanceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBareMetalInstance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "BareMetalInfrastructure" + ], + "operationId": "AzureBareMetalInstances_Delete", + "x-ms-long-running-operation": true, + "summary": "Deletes a Azure BareMetal instance.", + "description": "Deletes a Azure BareMetal instance with the specified subscription, resource group, and instance name.", + "x-ms-examples": { + "Delete an AzureBareMetal instance": { + "$ref": "./examples/AzureBareMetalInstances_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureBareMetalInstanceNameParameter" + } + ], + "responses": { + "200": { + "description": "Deleted AzureBareMetalInstance" + }, + "202": { + "description": "Deleting AzureBareMetalInstance" + }, + "204": { + "description": "No AzureBareMetalInstance to delete" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "BareMetalInfrastructure" + ], + "operationId": "AzureBareMetalInstances_Update", + "summary": "Patches the Tags field of a Azure BareMetal instance.", + "description": "Patches the Tags field of a Azure BareMetal instance for the specified subscription, resource group, and instance name.", + "x-ms-examples": { + "Update Tags field of an AzureBareMetal instance": { + "$ref": "./examples/AzureBareMetalInstances_PatchTags.json" + }, + "Delete Tags field of an AzureBareMetal instance": { + "$ref": "./examples/AzureBareMetalInstances_PatchTags_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureBareMetalInstanceNameParameter" + }, + { + "$ref": "#/parameters/TagsParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBareMetalInstance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "AzureBareMetalInstancesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureBareMetalInstance" + }, + "description": "The list of Azure BareMetal instances." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of AzureBareMetal instances." + } + }, + "description": "The response from the List AzureBareMetal Instances operation." + }, + "AzureBareMetalInstance": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureBareMetalInstanceProperties", + "description": "AzureBareMetal instance properties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "description": "AzureBareMetal instance info on Azure (ARM properties and AzureBareMetal properties)" + }, + "AzureBareMetalInstanceProperties": { + "properties": { + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Specifies the hardware settings for the AzureBareMetal instance." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Specifies the storage settings for the AzureBareMetal instance disks." + }, + "osProfile": { + "$ref": "#/definitions/OSProfile", + "description": "Specifies the operating system settings for the AzureBareMetal instance." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Specifies the network settings for the AzureBareMetal instance." + }, + "azureBareMetalInstanceId": { + "readOnly": true, + "type": "string", + "description": "Specifies the AzureBareMetal instance unique ID." + }, + "powerState": { + "readOnly": true, + "type": "string", + "enum": [ + "starting", + "started", + "stopping", + "stopped", + "restarting", + "unknown" + ], + "x-ms-enum": { + "name": "AzureBareMetalInstancePowerStateEnum", + "modelAsString": true + }, + "description": "Resource power state" + }, + "proximityPlacementGroup": { + "readOnly": true, + "type": "string", + "description": "Resource proximity placement group" + }, + "hwRevision": { + "readOnly": true, + "type": "string", + "description": "Hardware revision of an AzureBareMetal instance" + }, + "partnerNodeId": { + "type": "string", + "description": "ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "enum": [ + "Accepted", + "Creating", + "Updating", + "Failed", + "Succeeded", + "Deleting", + "Migrating" + ], + "x-ms-enum": { + "name": "AzureBareMetalProvisioningStatesEnum", + "modelAsString": true + }, + "description": "State of provisioning of the AzureBareMetalInstance" + } + }, + "description": "Describes the properties of an AzureBareMetal instance." + }, + "HardwareProfile": { + "properties": { + "hardwareType": { + "readOnly": true, + "type": "string", + "enum": [ + "Cisco_UCS", + "HPE" + ], + "x-ms-enum": { + "name": "AzureBareMetalHardwareTypeNamesEnum", + "modelAsString": true + }, + "description": "Name of the hardware type (vendor and/or their product name)" + }, + "azureBareMetalInstanceSize": { + "readOnly": true, + "type": "string", + "enum": [ + "S72m", + "S144m", + "S72", + "S144", + "S192", + "S192m", + "S192xm", + "S96", + "S112", + "S224", + "S224m", + "S224om", + "S224oo", + "S224oom", + "S224ooo", + "S384", + "S384m", + "S384xm", + "S384xxm", + "S448", + "S448m", + "S448om", + "S448oo", + "S448oom", + "S448ooo", + "S576m", + "S576xm", + "S672", + "S672m", + "S672om", + "S672oo", + "S672oom", + "S672ooo", + "S768", + "S768m", + "S768xm", + "S896", + "S896m", + "S896om", + "S896oo", + "S896oom", + "S896ooo", + "S960m" + ], + "x-ms-enum": { + "name": "azureBareMetalInstanceSizeNamesEnum", + "modelAsString": true + }, + "description": "Specifies the AzureBareMetal instance SKU." + } + }, + "description": "Specifies the hardware settings for the AzureBareMetal instance." + }, + "Disk": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes." + }, + "lun": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + } + }, + "description": "Specifies the disk information fo the AzureBareMetal instance" + }, + "StorageProfile": { + "properties": { + "nfsIpAddress": { + "readOnly": true, + "type": "string", + "description": "IP Address to connect to storage." + }, + "osDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/Disk" + }, + "description": "Specifies information about the operating system disk used by baremetal instance." + } + }, + "description": "Specifies the storage settings for the AzureBareMetal instance disks." + }, + "OSProfile": { + "properties": { + "computerName": { + "type": "string", + "description": "Specifies the host OS name of the AzureBareMetal instance." + }, + "osType": { + "readOnly": true, + "type": "string", + "description": "This property allows you to specify the type of the OS." + }, + "version": { + "readOnly": true, + "type": "string", + "description": "Specifies version of operating system." + }, + "sshPublicKey": { + "type": "string", + "description": "Specifies the SSH public key used to access the operating system." + } + }, + "description": "Specifies the operating system settings for the AzureBareMetal instance." + }, + "NetworkProfile": { + "properties": { + "networkInterfaces": { + "type": "array", + "items": { + "$ref": "#/definitions/IpAddress" + }, + "description": "Specifies the network interfaces for the AzureBareMetal instance." + }, + "circuitId": { + "readOnly": true, + "type": "string", + "description": "Specifies the circuit id for connecting to express route." + } + }, + "description": "Specifies the network settings for the AzureBareMetal instance disks." + }, + "IpAddress": { + "properties": { + "ipAddress": { + "type": "string", + "description": "Specifies the IP address of the network interface." + } + }, + "description": "Specifies the IP address of the network interface." + }, + "OperationList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of AzureBareMetal operations" + } + }, + "description": "List of AzureBareMetal operations" + }, + "Operation": { + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the operation being performed on this particular object. This name should match the action name that appears in RBAC / the event service." + }, + "display": { + "$ref": "#/definitions/Display", + "description": "Displayed AzureBareMetal operation information" + }, + "isDataAction": { + "description": "indicates whether an operation is a data action or not.", + "type": "boolean" + } + }, + "description": "AzureBareMetal operation information" + }, + "Result": { + "description": "Sample result definition", + "properties": { + "sampleProperty": { + "type": "string", + "description": "Sample property of type string" + } + } + }, + "Display": { + "type": "object", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "The localized friendly form of the resource provider name. This form is also expected to include the publisher/company responsible. Use Title Casing. Begin with \"Microsoft\" for 1st party services." + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "The localized friendly form of the resource type related to this action/operation. This form should match the public documentation for the resource provider. Use Title Casing. For examples, refer to the “name” section." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "The localized friendly name for the operation as shown to the user. This name should be concise (to fit in drop downs), but clear (self-documenting). Use Title Casing and include the entity/resource to which it applies." + }, + "description": { + "readOnly": true, + "type": "string", + "description": "The localized friendly description for the operation as shown to the user. This description should be thorough, yet concise. It will be used in tool-tips and detailed views." + }, + "origin": { + "readOnly": true, + "type": "string", + "description": "The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is 'user,system'" + } + }, + "description": "Detailed BareMetal operation information" + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDefinition", + "description": "The error details." + } + } + }, + "ErrorDefinition": { + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Internal error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDefinition" + }, + "readOnly": true + } + } + }, + "Tags": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags field of the AzureBareMetal instance." + } + }, + "description": "Tags field of the AzureBareMetal instance." + } + }, + "parameters": { + "AzureBareMetalInstanceNameParameter": { + "name": "azureBareMetalInstanceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the Azure BareMetal on Azure instance.", + "x-ms-parameter-location": "method" + }, + "TagsParameter": { + "name": "tagsParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Tags" + }, + "description": "Request body that only contains the new Tags field", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_Delete.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_Delete.json new file mode 100644 index 000000000000..f4506a990d9a --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-08-06-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "azureBareMetalInstanceName": "myAzureBareMetalInstance" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_Get.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_Get.json new file mode 100644 index 000000000000..0429abd084e6 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_Get.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2020-08-06-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "azureBareMetalInstanceName": "myAzureBareMetalInstance" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/57d3422f-467a-448e-b798-ebf490849542/resourceGroups/rg10128/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/myAzureBareMetalInstance", + "location": "westus2", + "name": "myAzureBareMetalInstance", + "tags": { + "key": "value" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalInstances", + "properties": { + "azureBareMetalInstanceId": "d83c3dfc-db7b-4103-9de7-fddfe6f2812a", + "powerState": "restarting", + "hwRevision": "Rev 4.2", + "hardwareProfile": { + "hardwareType": "Cisco_UCS", + "azureBareMetalInstanceSize": "S72" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "123.123.123.123" + } + ], + "circuitId": "/subscriptions/57d3422f-467a-448e-b798-ebf490849542/resourceGroups/rg10128/providers/Microsoft.Network/expressRouteCircuits/myAzureBareMetalInstance" + }, + "storageProfile": { + "nfsIpAddress": "123.123.119.123" + }, + "osProfile": { + "computerName": "myComputerName", + "osType": "SLES 12 SP2", + "version": "12 SP2" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_List.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_List.json new file mode 100644 index 000000000000..9c82f4fd729f --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_List.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2020-08-06-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/azureBareMetalInstances/myABMInstance1", + "name": "myABMInstance1", + "type": "Microsoft.BareMetalInfrastructure/azureBareMetalInstances", + "location": "westus", + "tags": { + "key": "value" + }, + "properties": { + "azureBareMetalInstanceId": "00000000-0000-0000-0000-000000000000", + "powerState": "started", + "proximityPlacementGroup": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", + "hwRevision": "Rev 3", + "hardwareProfile": { + "hardwareType": "Cisco_UCS", + "azureBareMetalInstanceSize": "S72" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "100.100.100.100" + } + ], + "circuitId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuit" + }, + "storageProfile": { + "nfsIpAddress": "200.200.200.200" + }, + "osProfile": { + "computerName": "myComputerName1", + "osType": "SUSE", + "version": "12 SP1", + "sshPublicKey": "AAAAB3NzaC1yc2EAAAABJQAAAQB/nAmOjTmezNUDKYvEeIRf2YnwM9/uUG1d0BYsc8/tRtx+RGi7N2lUbp728MXGwdnL9od4cItzky/zVdLZE2cycOa18xBK9cOWmcKS0A8FYBxEQWJ/q9YVUgZbFKfYGaGQxsER+A0w/fX8ALuk78ktP31K69LcQgxIsl7rNzxsoOQKJ/CIxOGMMxczYTiEoLvQhapFQMs3FL96didKr/QbrfB1WT6s3838SEaXfgZvLef1YB2xmfhbT9OXFE3FXvh2UPBfN+ffE7iiayQf/2XR+8j4N4bW30DiPtOQLGUrH1y5X/rpNZNlWW2+jGIxqZtgWg7lTy3mXy5x836Sj/6L" + }, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/azureBareMetalInstances/myABMInstance2", + "name": "myABMInstance2", + "type": "Microsoft.BareMetalInfrastructure/azureBareMetalInstances", + "location": "westus", + "tags": { + "key": "value" + }, + "properties": { + "azureBareMetalInstanceId": "00000000-0000-0000-0000-000000000000", + "powerState": "started", + "proximityPlacementGroup": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", + "hwRevision": "Rev 3", + "hardwareProfile": { + "hardwareType": "HPE", + "azureBareMetalInstanceSize": "S384" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "100.100.100.101" + } + ], + "circuitId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuit" + }, + "storageProfile": { + "nfsIpAddress": "200.200.200.201" + }, + "osProfile": { + "computerName": "myComputerName2", + "osType": "SUSE", + "version": "12 SP1", + "sshPublicKey": "AAAAB3NzaC1yc2EAAAABJQAAAQB/nAmOjTmezNUDKYvEeIRf2YnwM9/uUG1d0BYsc8/tRtx+RGi7N2lUbp728MXGwdnL9od4cItzky/zVdLZE2cycOa18xBK9cOWmcKS0A8FYBxEQWJ/q9YVUgZbFKfYGaGQxsER+A0w/fX8ALuk78ktP31K69LcQgxIsl7rNzxsoOQKJ/CIxOGMMxczYTiEoLvQhapFQMs3FL96didKr/QbrfB1WT6s3838SEaXfgZvLef1YB2xmfhbT9OXFE3FXvh2UPBfN+ffE7iiayQf/2XR+8j4N4bW30DiPtOQLGUrH1y5X/rpNZNlWW2+jGIxqZtgWg7lTy3mXy5x836Sj/6L" + }, + "partnerNodeId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/azureBareMetalInstances/myABMInstance1", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_ListBySubscription.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_ListBySubscription.json new file mode 100644 index 000000000000..412a064ac5ad --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_ListBySubscription.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2020-08-06-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/57d3422f-467a-448e-b798-ebf490849542/resourceGroups/rg10128/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/myAzureBareMetalInstance", + "location": "westus2", + "name": "myAzureBareMetalInstance1", + "tags": { + "key": "value" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalInstances", + "properties": { + "azureBareMetalInstanceId": "d83c3dfc-db7b-4103-9de7-fddfe6f2812a", + "powerState": "restarting", + "hwRevision": "Rev 4.2", + "hardwareProfile": { + "hardwareType": "Cisco_UCS", + "azureBareMetalInstanceSize": "S72" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "123.123.123.123" + } + ], + "circuitId": "/subscriptions/57d3422f-467a-448e-b798-ebf490849542/resourceGroups/rg10128/providers/Microsoft.Network/expressRouteCircuits/myAzureBareMetalInstance" + }, + "storageProfile": { + "nfsIpAddress": "123.123.119.123" + }, + "osProfile": { + "computerName": "myComputerName", + "osType": "SLES 12 SP2", + "version": "12 SP2" + }, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg10128/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/myAzureBareMetalInstance", + "location": "westus2", + "name": "myAzureBareMetalInstance2", + "tags": { + "key": "value" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalInstances", + "properties": { + "azureBareMetalInstanceId": "d83c3dfc-db7b-4103-9de7-fddfe6f2812a", + "powerState": "restarting", + "hwRevision": "Rev 4.2", + "hardwareProfile": { + "hardwareType": "Cisco_UCS", + "azureBareMetalInstanceSize": "S72" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "123.123.123.123" + } + ], + "circuitId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg10128/providers/Microsoft.Network/expressRouteCircuits/myAzureBareMetalInstance" + }, + "storageProfile": { + "nfsIpAddress": "123.123.119.123" + }, + "osProfile": { + "computerName": "myComputerName2", + "osType": "SLES 12 SP2", + "version": "12 SP2" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_PatchTags.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_PatchTags.json new file mode 100644 index 000000000000..5f0080e409f2 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_PatchTags.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2017-11-03-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "azureBareMetalInstanceName": "myABMInstance", + "tagsParameter": { + "tags": { + "testkey": "testvalue" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/myABMInstance", + "name": "myABMInstance", + "type": "Microsoft.BareMetalInfrastructure/bareMetalInstances", + "location": "westus", + "tags": { + "testkey": "testvalue" + }, + "properties": { + "azureBareMetalInstanceId": "00000000-0000-0000-0000-000000000000", + "powerState": "started", + "proximityPlacementGroup": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", + "hwRevision": "Rev 3", + "hardwareProfile": { + "hardwareType": "Cisco_UCS", + "azureBareMetalInstanceSize": "S72" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "100.100.100.100" + } + ], + "circuitId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuit" + }, + "storageProfile": { + "nfsIpAddress": "200.200.200.200" + }, + "osProfile": { + "computerName": "myComputerName", + "osType": "SUSE", + "version": "12 SP1", + "sshPublicKey": "AAAAB3NzaC1yc2EAAAABJQAAAQB/nAmOjTmezNUDKYvEeIRf2YnwM9/uUG1d0BYsc8/tRtx+RGi7N2lUbp728MXGwdnL9od4cItzky/zVdLZE2cycOa18xBK9cOWmcKS0A8FYBxEQWJ/q9YVUgZbFKfYGaGQxsER+A0w/fX8ALuk78ktP31K69LcQgxIsl7rNzxsoOQKJ/CIxOGMMxczYTiEoLvQhapFQMs3FL96didKr/QbrfB1WT6s3838SEaXfgZvLef1YB2xmfhbT9OXFE3FXvh2UPBfN+ffE7iiayQf/2XR+8j4N4bW30DiPtOQLGUrH1y5X/rpNZNlWW2+jGIxqZtgWg7lTy3mXy5x836Sj/6L" + }, + "partnerNodeId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/myABMInstance2", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_PatchTags_Delete.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_PatchTags_Delete.json new file mode 100644 index 000000000000..badfe29783ac --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_PatchTags_Delete.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2017-11-03-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "azureBareMetalInstanceName": "myABMInstance", + "tagsParameter": { + "tags": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/myABMInstance", + "name": "myABMInstance", + "type": "Microsoft.BareMetalInfrastructure/bareMetalInstances", + "location": "westus", + "tags": {}, + "properties": { + "azureBareMetalInstanceId": "00000000-0000-0000-0000-000000000000", + "powerState": "started", + "proximityPlacementGroup": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", + "hwRevision": "Rev 3", + "hardwareProfile": { + "hardwareType": "Cisco_UCS", + "azureBareMetalInstanceSize": "S72" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "100.100.100.100" + } + ], + "circuitId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuit" + }, + "storageProfile": { + "nfsIpAddress": "200.200.200.200" + }, + "osProfile": { + "computerName": "myComputerName", + "osType": "SUSE", + "version": "12 SP1", + "sshPublicKey": "AAAAB3NzaC1yc2EAAAABJQAAAQB/nAmOjTmezNUDKYvEeIRf2YnwM9/uUG1d0BYsc8/tRtx+RGi7N2lUbp728MXGwdnL9od4cItzky/zVdLZE2cycOa18xBK9cOWmcKS0A8FYBxEQWJ/q9YVUgZbFKfYGaGQxsER+A0w/fX8ALuk78ktP31K69LcQgxIsl7rNzxsoOQKJ/CIxOGMMxczYTiEoLvQhapFQMs3FL96didKr/QbrfB1WT6s3838SEaXfgZvLef1YB2xmfhbT9OXFE3FXvh2UPBfN+ffE7iiayQf/2XR+8j4N4bW30DiPtOQLGUrH1y5X/rpNZNlWW2+jGIxqZtgWg7lTy3mXy5x836Sj/6L" + }, + "partnerNodeId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/myABMInstance2", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_Restart.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_Restart.json new file mode 100644 index 000000000000..071580b9d6ea --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_Restart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-08-06-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "azureBareMetalInstanceName": "myABMInstance" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_Shutdown.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_Shutdown.json new file mode 100644 index 000000000000..071580b9d6ea --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_Shutdown.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-08-06-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "azureBareMetalInstanceName": "myABMInstance" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_Start.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_Start.json new file mode 100644 index 000000000000..071580b9d6ea --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalInstances_Start.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-08-06-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "azureBareMetalInstanceName": "myABMInstance" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalOperations_List.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalOperations_List.json new file mode 100644 index 000000000000..1821117de8f1 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/examples/AzureBareMetalOperations_List.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2020-08-06-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AzureBareMetalOp1", + "display": { + "provider": "AzureBareMetalOp1ProviderName", + "resource": "AzureBareMetalOp1ResourceName", + "operation": "AzureBareMetalOp1OperationName", + "description": "AzureBareMetalOp1Description", + "origin": "AzureBareMetalOp1Origin" + }, + "isDataAction": false + }, + { + "name": "AzureBareMetalOp2", + "display": { + "provider": "AzureBareMetalOp2ProviderName", + "resource": "AzureBareMetalOp2ResourceName", + "operation": "AzureBareMetalOp2OperationName", + "description": "AzureBareMetalOp2Description", + "origin": "AzureBareMetalOp2Origin" + }, + "isDataAction": true + } + ] + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/readme.csharp.md b/specification/baremetalinfrastructure/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..8399c777f44f --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.BareMetalInfrastructure + output-folder: $(csharp-sdks-folder)/baremetalinfrastructure/management/Microsoft.BareMetalInfrastructure/GeneratedProtocol +``` diff --git a/specification/baremetalinfrastructure/resource-manager/readme.go.md b/specification/baremetalinfrastructure/resource-manager/readme.go.md new file mode 100644 index 000000000000..1157b0905cb3 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/readme.go.md @@ -0,0 +1,19 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + clear-output-folder: true +``` + +### Tag: package-2020-08-06-preview and go + +These settings apply only when `--tag=package-2020-08-06-preview --go` is specified on the command line. +Please also specify `--go-sdks-folder=`. + +```yaml $(tag) == 'package-2020-08-06-preview' && $(go) +namespace: baremetalinfrastructure +output-folder: $(go-sdks-folder)/baremetalinfrastructure/Generated +``` diff --git a/specification/baremetalinfrastructure/resource-manager/readme.md b/specification/baremetalinfrastructure/resource-manager/readme.md new file mode 100644 index 000000000000..2efae511812e --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/readme.md @@ -0,0 +1,79 @@ +# BareMetalInfrastructure + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for BareMetalInfrastructure. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the BareMetalInfrastructure API. + +```yaml +openapi-type: arm +tag: package-2020-08-06-preview +``` + +### Tag: package-2020-08-06-preview + +These settings apply only when `--tag=package-2020-08-06-preview` is specified on the command line. + +```yaml $(tag) == 'package-2020-08-06-preview' +input-file: + - Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_baremetalinfrastructure'] +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Ruby + +See configuration in [readme.ruby.md](./readme.ruby.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) diff --git a/specification/baremetalinfrastructure/resource-manager/readme.python.md b/specification/baremetalinfrastructure/resource-manager/readme.python.md new file mode 100644 index 000000000000..4f59e49672a9 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/readme.python.md @@ -0,0 +1,21 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +```yaml $(python) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: Microsoft.BareMetalInfrastructure + package-name: baremetalinfrastructure + package-version: 2020-08-06-preview + clear-output-folder: true +``` + +```yaml $(python) +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt/baremetalinfrastructure +``` diff --git a/specification/baremetalinfrastructure/resource-manager/readme.ruby.md b/specification/baremetalinfrastructure/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..1c290102b63f --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/readme.ruby.md @@ -0,0 +1,19 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +```yaml +package-name: azure_mgmt_baremetalinfrastructure +package-version: 2020-08-06-preview +azure-arm: true +``` + +### Tag: package-2020-08-06-preview and ruby + +These settings apply only when `--tag=package-2020-08-06-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2020-08-06-preview' && $(ruby) +namespace: Microsoft.BareMetalInfrastructure +output-folder: $(ruby-sdks-folder)/baremetalinfrastructure +``` diff --git a/specification/baremetalinfrastructure/resource-manager/readme.typescript.md b/specification/baremetalinfrastructure/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..8fbf13c9da70 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +```yaml $(typescript) +typescript: + azure-arm: true + package-name: "baremetalinfrastructure" + output-folder: "$(typescript-sdks-folder)/packages/baremetalinfrastructure" + payload-flattening-threshold: 1 + generate-metadata: true +``` From d0440db243f55f47ad73af1bca10d8cc4ac84c62 Mon Sep 17 00:00:00 2001 From: Navneet Singh Date: Fri, 11 Sep 2020 13:25:46 +0530 Subject: [PATCH 041/164] Spark Compute Isolation enabled (#10726) * Spark Compute Isolation enabled Using this flag the user can enabled the Spark compute in isolation * Fix code style issue Co-authored-by: Dongwei Wang --- .../preview/2019-06-01-preview/bigDataPool.json | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPool.json index 57b66826ff17..95b3cd1f9835 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPool.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPool.json @@ -406,6 +406,10 @@ "$ref": "#/definitions/AutoPauseProperties", "description": "Auto-pausing properties" }, + "isComputeIsolationEnabled": { + "type": "boolean", + "description": "Whether compute isolation is required or not." + }, "sparkEventsFolder": { "type": "string", "description": "The Spark events folder" @@ -432,7 +436,9 @@ "None", "Small", "Medium", - "Large" + "Large", + "XLarge", + "XXLarge" ], "type": "string", "description": "The level of compute power that each node in the Big Data pool has.", From 35db0f301432b9f4162eb5b5388ae5dd6f3aadbc Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 11 Sep 2020 16:05:25 +0800 Subject: [PATCH 042/164] Bump node-fetch from 2.6.0 to 2.6.1 in /.azure-pipelines-preproduction (#10762) Bumps [node-fetch](https://github.com/bitinn/node-fetch) from 2.6.0 to 2.6.1. - [Release notes](https://github.com/bitinn/node-fetch/releases) - [Changelog](https://github.com/node-fetch/node-fetch/blob/master/docs/CHANGELOG.md) - [Commits](https://github.com/bitinn/node-fetch/compare/v2.6.0...v2.6.1) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .azure-pipelines-preproduction/package-lock.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.azure-pipelines-preproduction/package-lock.json b/.azure-pipelines-preproduction/package-lock.json index 4c101dab8fff..10fc277e7713 100644 --- a/.azure-pipelines-preproduction/package-lock.json +++ b/.azure-pipelines-preproduction/package-lock.json @@ -3835,9 +3835,9 @@ } }, "node-fetch": { - "version": "2.6.0", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.0.tgz", - "integrity": "sha512-8dG4H5ujfvFiqDmVu9fQ5bOHUC15JMjMY/Zumv26oOvvVJjM67KF8koCWIabKQ1GJIa9r2mMZscBq/TbdOcmNA==", + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.1.tgz", + "integrity": "sha512-V4aYg89jEoVRxRb2fJdAg8FHvI7cEyYdVAh94HH0UIK8oJxUfkjlDQN9RbMx+bEjP7+ggMiFRprSti032Oipxw==", "dev": true }, "node-object-hash": { From ec2cba2ff0953d431b88a9fd4922de76157119e0 Mon Sep 17 00:00:00 2001 From: Shangwei Sun <63389531+sunsw1994@users.noreply.github.com> Date: Fri, 11 Sep 2020 17:11:56 +0800 Subject: [PATCH 043/164] Dev StreamAnalytics 2017-04-01-preview version for streaming job and 2020-03-01-preview version for dedicated cluster (#10673) * Adds base for updating Microsoft.StreamAnalytics from version stable/2016-03-01 to version 2017-04-01-preview * Updates readme * Updates API version in new specs and examples * 1.add missing features for 2017-04-01-preview based on 2016-03-01 2.fix semantic errors * add 2020-03-01-preview version for asa cluster and private endpoint * address comments 1.resourceGroupName use one unique value in example 2.suppress R3023 validation error 3.add some descriptions * address comments: 1. update readme 2. modify cluster type:string to object 3. update difinition of AzureSqlReferenceInputDataSource * update example json files * add readme for python * update readme for go --- custom-words.txt | 3 +- .../common/v1/definitions.json | 198 +++ .../examples/Function_Create_AzureML.json | 142 +++ .../Function_Create_AzureMLService.json | 138 +++ .../examples/Function_Create_CSharp.json | 96 ++ .../examples/Function_Create_JavaScript.json | 90 ++ .../examples/Function_Delete.json | 13 + .../examples/Function_Get_AzureML.json | 57 + .../examples/Function_Get_JavaScript.json | 40 + .../examples/Function_ListByStreamingJob.json | 83 ++ ...ion_RetrieveDefaultDefinition_AzureML.json | 59 + .../examples/Function_Test_AzureML.json | 17 + .../examples/Function_Test_JavaScript.json | 21 + .../examples/Function_Update_AzureML.json | 70 ++ .../examples/Function_Update_JavaScript.json | 53 + .../Input_Create_Reference_Blob_CSV.json | 106 ++ .../Input_Create_Stream_Blob_CSV.json | 109 ++ .../Input_Create_Stream_EventHub_JSON.json | 88 ++ .../Input_Create_Stream_IoTHub_Avro.json | 81 ++ .../examples/Input_Delete.json | 13 + .../Input_Get_Reference_Blob_CSV.json | 45 + .../examples/Input_Get_Stream_Blob_CSV.json | 46 + .../Input_Get_Stream_EventHub_JSON.json | 39 + .../Input_Get_Stream_IoTHub_Avro.json | 37 + .../examples/Input_ListByStreamingJob.json | 124 ++ .../Input_ListByStreamingJob_Diagnostics.json | 53 + .../examples/Input_Test.json | 17 + .../examples/Input_Update_Reference_Blob.json | 63 + .../examples/Input_Update_Stream_Blob.json | 64 + .../Input_Update_Stream_EventHub.json | 51 + .../examples/Input_Update_Stream_IoTHub.json | 58 + .../examples/Operation_List.json | 319 +++++ ...Output_Create_AzureDataLakeStore_JSON.json | 97 ++ .../examples/Output_Create_AzureSQL.json | 67 + .../examples/Output_Create_AzureTable.json | 82 ++ .../examples/Output_Create_Blob_CSV.json | 103 ++ .../examples/Output_Create_DocumentDB.json | 70 ++ .../examples/Output_Create_EventHub_JSON.json | 88 ++ .../examples/Output_Create_PowerBI.json | 76 ++ .../Output_Create_ServiceBusQueue_Avro.json | 87 ++ .../Output_Create_ServiceBusTopic_CSV.json | 97 ++ .../examples/Output_Delete.json | 13 + .../Output_Get_AzureDataLakeStore_JSON.json | 42 + .../examples/Output_Get_AzureFunction.json | 34 + .../examples/Output_Get_AzureSQL.json | 32 + .../examples/Output_Get_AzureTable.json | 37 + .../examples/Output_Get_Blob_CSV.json | 44 + .../examples/Output_Get_DataWarehouse.json | 33 + .../examples/Output_Get_DocumentDB.json | 33 + .../examples/Output_Get_EventHub_JSON.json | 39 + .../examples/Output_Get_PowerBI.json | 34 + .../Output_Get_ServiceBusQueue_Avro.json | 39 + .../Output_Get_ServiceBusTopic_CSV.json | 42 + .../examples/Output_ListByStreamingJob.json | 226 ++++ .../examples/Output_Test.json | 17 + .../Output_Update_AzureDataLakeStore.json | 59 + .../examples/Output_Update_AzureSQL.json | 42 + .../examples/Output_Update_AzureTable.json | 47 + .../examples/Output_Update_Blob.json | 61 + .../examples/Output_Update_DocumentDB.json | 43 + .../examples/Output_Update_EventHub.json | 56 + .../examples/Output_Update_PowerBI.json | 44 + .../Output_Update_ServiceBusQueue.json | 59 + .../Output_Update_ServiceBusTopic.json | 59 + .../StreamingJob_Create_CompleteJob.json | 261 ++++ .../StreamingJob_Create_JobShell.json | 100 ++ .../examples/StreamingJob_Delete.json | 13 + .../examples/StreamingJob_Get_Expand.json | 244 ++++ .../examples/StreamingJob_Get_NoExpand.json | 46 + ...eamingJob_List_ByResourceGroup_Expand.json | 504 ++++++++ ...mingJob_List_ByResourceGroup_NoExpand.json | 110 ++ ...reamingJob_List_BySubscription_Expand.json | 503 ++++++++ ...amingJob_List_BySubscription_NoExpand.json | 109 ++ .../StreamingJob_Start_CustomTime.json | 16 + .../StreamingJob_Start_JobStartTime.json | 15 + ...treamingJob_Start_LastOutputEventTime.json | 15 + .../examples/StreamingJob_Stop.json | 12 + .../examples/StreamingJob_Update.json | 91 ++ .../examples/Subscription_ListQuotas.json | 24 + .../examples/Transformation_Create.json | 45 + .../examples/Transformation_Get.json | 25 + .../examples/Transformation_Update.json | 30 + .../preview/2017-04-01-preview/functions.json | 977 +++++++++++++++ .../preview/2017-04-01-preview/inputs.json | 1079 +++++++++++++++++ .../2017-04-01-preview/operations.json | 124 ++ .../preview/2017-04-01-preview/outputs.json | 1074 ++++++++++++++++ .../2017-04-01-preview/streamingjobs.json | 789 ++++++++++++ .../2017-04-01-preview/subscriptions.json | 139 +++ .../2017-04-01-preview/transformations.json | 288 +++++ .../preview/2020-03-01-preview/clusters.json | 612 ++++++++++ .../examples/Cluster_Create.json | 66 + .../examples/Cluster_Delete.json | 13 + .../examples/Cluster_Get.json | 33 + .../examples/Cluster_ListByResourceGroup.json | 58 + .../examples/Cluster_ListBySubscription.json | 57 + .../examples/Cluster_ListStreamingJobs.json | 27 + .../examples/Cluster_Update.json | 40 + .../examples/PrivateEndpoint_Create.json | 79 ++ .../examples/PrivateEndpoint_Delete.json | 14 + .../examples/PrivateEndpoint_Get.json | 38 + .../PrivateEndpoint_ListByCluster.json | 67 + .../2020-03-01-preview/privateEndpoints.json | 358 ++++++ .../resource-manager/readme.go.md | 25 +- .../resource-manager/readme.md | 108 +- .../resource-manager/readme.python.md | 26 + .../resource-manager/readme.ruby.md | 27 +- 106 files changed, 12549 insertions(+), 27 deletions(-) create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/common/v1/definitions.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Create_AzureML.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Create_AzureMLService.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Create_CSharp.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Create_JavaScript.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Delete.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Get_AzureML.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Get_JavaScript.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_ListByStreamingJob.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_RetrieveDefaultDefinition_AzureML.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Test_AzureML.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Test_JavaScript.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Update_AzureML.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Update_JavaScript.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Create_Reference_Blob_CSV.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Create_Stream_Blob_CSV.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Create_Stream_EventHub_JSON.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Create_Stream_IoTHub_Avro.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Delete.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Get_Reference_Blob_CSV.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Get_Stream_Blob_CSV.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Get_Stream_EventHub_JSON.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Get_Stream_IoTHub_Avro.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_ListByStreamingJob.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_ListByStreamingJob_Diagnostics.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Test.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Update_Reference_Blob.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Update_Stream_Blob.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Update_Stream_EventHub.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Update_Stream_IoTHub.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Operation_List.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_AzureDataLakeStore_JSON.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_AzureSQL.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_AzureTable.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_Blob_CSV.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_DocumentDB.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_EventHub_JSON.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_PowerBI.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_ServiceBusQueue_Avro.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_ServiceBusTopic_CSV.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Delete.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_AzureDataLakeStore_JSON.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_AzureFunction.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_AzureSQL.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_AzureTable.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_Blob_CSV.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_DataWarehouse.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_DocumentDB.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_EventHub_JSON.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_PowerBI.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_ServiceBusQueue_Avro.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_ServiceBusTopic_CSV.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_ListByStreamingJob.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Test.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_AzureDataLakeStore.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_AzureSQL.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_AzureTable.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_Blob.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_DocumentDB.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_EventHub.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_PowerBI.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_ServiceBusQueue.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_ServiceBusTopic.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Create_CompleteJob.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Create_JobShell.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Delete.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Get_Expand.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Get_NoExpand.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_List_ByResourceGroup_Expand.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_List_ByResourceGroup_NoExpand.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_List_BySubscription_Expand.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_List_BySubscription_NoExpand.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Start_CustomTime.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Start_JobStartTime.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Start_LastOutputEventTime.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Stop.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Update.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_ListQuotas.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Transformation_Create.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Transformation_Get.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Transformation_Update.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/inputs.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/operations.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/outputs.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/streamingjobs.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/subscriptions.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/transformations.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/clusters.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_Create.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_Delete.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_Get.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_ListByResourceGroup.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_ListBySubscription.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_ListStreamingJobs.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_Update.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/PrivateEndpoint_Create.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/PrivateEndpoint_Delete.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/PrivateEndpoint_Get.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/PrivateEndpoint_ListByCluster.json create mode 100644 specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/privateEndpoints.json create mode 100644 specification/streamanalytics/resource-manager/readme.python.md diff --git a/custom-words.txt b/custom-words.txt index d290273324d7..7f50f40e9f62 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1883,4 +1883,5 @@ ntfs networkrulesets Setget Ruleproperties -shamir_share \ No newline at end of file +shamir_share +dllpath diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/common/v1/definitions.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/common/v1/definitions.json new file mode 100644 index 000000000000..cdc06f254b09 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/common/v1/definitions.json @@ -0,0 +1,198 @@ +{ + "swagger": "2.0", + "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" + } + } + }, + "info": { + "version": "v1", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "AuthenticationMode": { + "type": "string", + "description": "Authentication Mode. Valid modes are `ConnectionString`, `Msi` and 'UserToken'.", + "enum": [ + "Msi", + "UserToken", + "ConnectionString" + ], + "x-ms-enum": { + "name": "AuthenticationMode", + "modelAsString": true + } + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts." + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "Error": { + "properties": { + "error": { + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + }, + "target": { + "type": "string", + "description": "Error target." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetails" + }, + "description": "Error details." + } + }, + "description": "Error definition properties." + } + }, + "description": "Common error representation." + }, + "ErrorDetails": { + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "target": { + "type": "string", + "description": "Error target." + }, + "message": { + "type": "string", + "description": "Error message." + } + }, + "description": "Common error details representation." + } + }, + "parameters": { + "IfMatchHeader": { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The ETag of the resource. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.", + "x-ms-parameter-location": "method" + }, + "IfNoneMatchHeader": { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Set to '*' to allow a new resource to be created, but to prevent updating an existing record set. Other values will result in a 412 Pre-condition Failed response.", + "x-ms-parameter-location": "method" + }, + "StreamingJobNameParameter": { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the streaming job.", + "x-ms-parameter-location": "method" + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription.", + "minLength": 1 + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation.", + "minLength": 1 + }, + "ResourceGroupNameParameter": { + "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, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Create_AzureML.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Create_AzureML.json new file mode 100644 index 000000000000..834492126f1c --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Create_AzureML.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj9093", + "functionName": "function588", + "function": { + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "nvarchar(max)" + } + ], + "output": { + "dataType": "nvarchar(max)" + }, + "binding": { + "type": "Microsoft.MachineLearning/WebService", + "properties": { + "endpoint": "someAzureMLEndpointURL", + "apiKey": "someApiKey==", + "inputs": { + "name": "input1", + "columnNames": [ + { + "name": "tweet", + "dataType": "string", + "mapTo": 0 + } + ] + }, + "outputs": [ + { + "name": "Sentiment", + "dataType": "string" + } + ], + "batchSize": 1000 + } + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "dac52a15-66be-4aa7-8a18-20c5409983df" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj9093/functions/function588", + "name": "function588", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "nvarchar(max)" + } + ], + "output": { + "dataType": "nvarchar(max)" + }, + "binding": { + "type": "Microsoft.MachineLearning/WebService", + "properties": { + "endpoint": "someAzureMLEndpointURL", + "inputs": { + "name": "input1", + "columnNames": [ + { + "name": "tweet", + "dataType": "string", + "mapTo": 0 + } + ] + }, + "outputs": [ + { + "name": "Sentiment", + "dataType": "string" + } + ], + "batchSize": 1000 + } + } + } + } + } + }, + "200": { + "headers": { + "ETag": "dac52a15-66be-4aa7-8a18-20c5409983df" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj9093/functions/function588", + "name": "function588", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "nvarchar(max)" + } + ], + "output": { + "dataType": "nvarchar(max)" + }, + "binding": { + "type": "Microsoft.MachineLearning/WebService", + "properties": { + "endpoint": "someAzureMLEndpointURL", + "inputs": { + "name": "input1", + "columnNames": [ + { + "name": "tweet", + "dataType": "string", + "mapTo": 0 + } + ] + }, + "outputs": [ + { + "name": "Sentiment", + "dataType": "string" + } + ], + "batchSize": 1000 + } + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Create_AzureMLService.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Create_AzureMLService.json new file mode 100644 index 000000000000..9a1dcd7de31b --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Create_AzureMLService.json @@ -0,0 +1,138 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj9093", + "functionName": "function588", + "function": { + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "nvarchar(max)" + } + ], + "output": { + "dataType": "nvarchar(max)" + }, + "binding": { + "type": "Microsoft.MachineLearningServices", + "properties": { + "endpoint": "someAzureMLEndpointURL", + "apiKey": "someApiKey==", + "inputs": [ + { + "name": "data", + "dataType": "array", + "mapTo": 0 + } + ], + "outputs": [ + { + "name": "Sentiment", + "dataType": "string" + } + ], + "batchSize": 1000, + "numberOfParallelRequests": 1 + } + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "dac52a15-66be-4aa7-8a18-20c5409983df" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj9093/functions/function588", + "name": "function588", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "nvarchar(max)" + } + ], + "output": { + "dataType": "nvarchar(max)" + }, + "binding": { + "type": "Microsoft.MachineLearningServices", + "properties": { + "endpoint": "someAzureMLEndpointURL", + "inputs": [ + { + "name": "data", + "dataType": "array", + "mapTo": 0 + } + ], + "outputs": [ + { + "name": "Sentiment", + "dataType": "string" + } + ], + "batchSize": 1000, + "numberOfParallelRequests": 1 + } + } + } + } + } + }, + "200": { + "headers": { + "ETag": "dac52a15-66be-4aa7-8a18-20c5409983df" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj9093/functions/function588", + "name": "function588", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "nvarchar(max)" + } + ], + "output": { + "dataType": "nvarchar(max)" + }, + "binding": { + "type": "Microsoft.MachineLearning/WebService", + "properties": { + "endpoint": "someAzureMLEndpointURL", + "inputs": { + "name": "input1", + "columnNames": [ + { + "name": "tweet", + "dataType": "string", + "mapTo": 0 + } + ] + }, + "outputs": [ + { + "name": "Sentiment", + "dataType": "string" + } + ], + "batchSize": 1000 + } + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Create_CSharp.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Create_CSharp.json new file mode 100644 index 000000000000..ba236b1a8618 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Create_CSharp.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj9093", + "functionName": "function588", + "function": { + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "nvarchar(max)" + } + ], + "output": { + "dataType": "nvarchar(max)" + }, + "binding": { + "type": "Microsoft.StreamAnalytics/CLRUdf", + "properties": { + "dllPath": "ASAEdgeApplication2_CodeBehind", + "class": "ASAEdgeUDFDemo.Class1", + "method": "SquareFunction" + } + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "dac52a15-66be-4aa7-8a18-20c5409983df" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj9093/functions/function588", + "name": "function588", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "nvarchar(max)" + } + ], + "output": { + "dataType": "nvarchar(max)" + }, + "binding": { + "type": "Microsoft.StreamAnalytics/CLRUdf", + "properties": { + "dllPath": "ASAEdgeApplication2_CodeBehind", + "class": "ASAEdgeUDFDemo.Class1", + "method": "SquareFunction" + } + } + } + } + } + }, + "200": { + "headers": { + "ETag": "dac52a15-66be-4aa7-8a18-20c5409983df" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj9093/functions/function588", + "name": "function588", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "nvarchar(max)" + } + ], + "output": { + "dataType": "nvarchar(max)" + }, + "binding": { + "type": "Microsoft.StreamAnalytics/CLRUdf", + "properties": { + "dllPath": "ASAEdgeApplication2_CodeBehind", + "class": "ASAEdgeUDFDemo.Class1", + "method": "SquareFunction" + } + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Create_JavaScript.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Create_JavaScript.json new file mode 100644 index 000000000000..3755ce7a0a97 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Create_JavaScript.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj8653", + "functionName": "function8197", + "function": { + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "Any" + } + ], + "output": { + "dataType": "Any" + }, + "binding": { + "type": "Microsoft.StreamAnalytics/JavascriptUdf", + "properties": { + "script": "function (x, y) { return x + y; }" + } + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "07495b35-da28-4c28-a3ed-e0d75d0b6eff" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj8653/functions/function8197", + "name": "function8197", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "Any" + } + ], + "output": { + "dataType": "Any" + }, + "binding": { + "type": "Microsoft.StreamAnalytics/JavascriptUdf", + "properties": { + "script": "function (x, y) { return x + y; }" + } + } + } + } + } + }, + "200": { + "headers": { + "ETag": "07495b35-da28-4c28-a3ed-e0d75d0b6eff" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj8653/functions/function8197", + "name": "function8197", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "Any" + } + ], + "output": { + "dataType": "Any" + }, + "binding": { + "type": "Microsoft.StreamAnalytics/JavascriptUdf", + "properties": { + "script": "function (x, y) { return x + y; }" + } + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Delete.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Delete.json new file mode 100644 index 000000000000..5cfa1cbee2bc --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj8653", + "functionName": "function8197" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Get_AzureML.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Get_AzureML.json new file mode 100644 index 000000000000..654077725b00 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Get_AzureML.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj9093", + "functionName": "function588" + }, + "responses": { + "200": { + "headers": { + "ETag": "dac52a15-66be-4aa7-8a18-20c5409983df" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj9093/functions/function588", + "name": "function588", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "nvarchar(max)" + } + ], + "output": { + "dataType": "nvarchar(max)" + }, + "binding": { + "type": "Microsoft.MachineLearning/WebService", + "properties": { + "endpoint": "someAzureMLEndpointURL", + "inputs": { + "name": "input1", + "columnNames": [ + { + "name": "tweet", + "dataType": "string", + "mapTo": 0 + } + ] + }, + "outputs": [ + { + "name": "Sentiment", + "dataType": "string" + } + ], + "batchSize": 1000 + } + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Get_JavaScript.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Get_JavaScript.json new file mode 100644 index 000000000000..1213c594bc8e --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Get_JavaScript.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj8653", + "functionName": "function8197" + }, + "responses": { + "200": { + "headers": { + "ETag": "07495b35-da28-4c28-a3ed-e0d75d0b6eff" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj8653/functions/function8197", + "name": "function8197", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "Any" + } + ], + "output": { + "dataType": "Any" + }, + "binding": { + "type": "Microsoft.StreamAnalytics/JavascriptUdf", + "properties": { + "script": "function (x, y) { return x + y; }" + } + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_ListByStreamingJob.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_ListByStreamingJob.json new file mode 100644 index 000000000000..55eb3da1573a --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_ListByStreamingJob.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj8653" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj8653/functions/function588", + "name": "function588", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "nvarchar(max)" + } + ], + "output": { + "dataType": "nvarchar(max)" + }, + "binding": { + "type": "Microsoft.MachineLearning/WebService", + "properties": { + "endpoint": "someAzureMLEndpointURL", + "inputs": { + "name": "input1", + "columnNames": [ + { + "name": "tweet", + "dataType": "string", + "mapTo": 0 + } + ] + }, + "outputs": [ + { + "name": "Sentiment", + "dataType": "string" + } + ], + "batchSize": 5000 + } + } + }, + "etag": "281cbf11-cd50-4a44-b833-cf170ce74748" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj8653/functions/function8197", + "name": "function8197", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "Any" + } + ], + "output": { + "dataType": "Any" + }, + "binding": { + "type": "Microsoft.StreamAnalytics/JavascriptUdf", + "properties": { + "script": "function (a, b) { return a * b; }" + } + } + }, + "etag": "94a512d5-2f59-4e39-b9c8-bca4abd74b7e" + } + } + ] + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_RetrieveDefaultDefinition_AzureML.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_RetrieveDefaultDefinition_AzureML.json new file mode 100644 index 000000000000..0b7993c40a65 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_RetrieveDefaultDefinition_AzureML.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj9093", + "functionName": "function588", + "functionRetrieveDefaultDefinitionParameters": { + "bindingType": "Microsoft.MachineLearning/WebService", + "bindingRetrievalProperties": { + "executeEndpoint": "someAzureMLExecuteEndpointUrl", + "udfType": "Scalar" + } + } + }, + "responses": { + "200": { + "body": { + "name": "function588", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "nvarchar(max)" + } + ], + "output": { + "dataType": "nvarchar(max)" + }, + "binding": { + "type": "Microsoft.MachineLearning/WebService", + "properties": { + "endpoint": "someAzureMLExecuteEndpointUrl", + "inputs": { + "name": "input1", + "columnNames": [ + { + "name": "tweet", + "dataType": "string", + "mapTo": 0 + } + ] + }, + "outputs": [ + { + "name": "Sentiment", + "dataType": "string" + } + ], + "batchSize": 1000 + } + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Test_AzureML.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Test_AzureML.json new file mode 100644 index 000000000000..eb79404a8f6b --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Test_AzureML.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj9093", + "functionName": "function588" + }, + "responses": { + "200": { + "body": { + "status": "TestSucceeded" + } + }, + "202": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Test_JavaScript.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Test_JavaScript.json new file mode 100644 index 000000000000..d97c3be651c7 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Test_JavaScript.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj8653", + "functionName": "function8197" + }, + "responses": { + "200": { + "body": { + "status": "TestFailed", + "error": { + "code": "BadRequest", + "message": "Test operation is not supported for function type: Microsoft.StreamAnalytics/JavascriptUdf" + } + } + }, + "202": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Update_AzureML.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Update_AzureML.json new file mode 100644 index 000000000000..0711d61c402c --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Update_AzureML.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj9093", + "functionName": "function588", + "function": { + "properties": { + "type": "Scalar", + "properties": { + "binding": { + "type": "Microsoft.MachineLearning/WebService", + "properties": { + "batchSize": 5000 + } + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "281cbf11-cd50-4a44-b833-cf170ce74748" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj9093/functions/function588", + "name": "function588", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "nvarchar(max)" + } + ], + "output": { + "dataType": "nvarchar(max)" + }, + "binding": { + "type": "Microsoft.MachineLearning/WebService", + "properties": { + "endpoint": "someAzureMLEndpointURL", + "inputs": { + "name": "input1", + "columnNames": [ + { + "name": "tweet", + "dataType": "string", + "mapTo": 0 + } + ] + }, + "outputs": [ + { + "name": "Sentiment", + "dataType": "string" + } + ], + "batchSize": 5000 + } + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Update_JavaScript.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Update_JavaScript.json new file mode 100644 index 000000000000..47c53e90bdad --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Function_Update_JavaScript.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj8653", + "functionName": "function8197", + "function": { + "properties": { + "type": "Scalar", + "properties": { + "binding": { + "type": "Microsoft.StreamAnalytics/JavascriptUdf", + "properties": { + "script": "function (a, b) { return a * b; }" + } + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "94a512d5-2f59-4e39-b9c8-bca4abd74b7e" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj8653/functions/function8197", + "name": "function8197", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "Any" + } + ], + "output": { + "dataType": "Any" + }, + "binding": { + "type": "Microsoft.StreamAnalytics/JavascriptUdf", + "properties": { + "script": "function (a, b) { return a * b; }" + } + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Create_Reference_Blob_CSV.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Create_Reference_Blob_CSV.json new file mode 100644 index 000000000000..41d4a65a51ed --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Create_Reference_Blob_CSV.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj9597", + "inputName": "input7225", + "input": { + "properties": { + "type": "Reference", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName", + "accountKey": "someAccountKey==" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "c987701d-4039-47aa-a115-ad84f67d07c5" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7225", + "name": "input7225", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Reference", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + }, + "200": { + "headers": { + "ETag": "c987701d-4039-47aa-a115-ad84f67d07c5" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7225", + "name": "input7225", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Reference", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Create_Stream_Blob_CSV.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Create_Stream_Blob_CSV.json new file mode 100644 index 000000000000..fdc482aa5569 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Create_Stream_Blob_CSV.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj6695", + "inputName": "input8899", + "input": { + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName", + "accountKey": "someAccountKey==" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH", + "sourcePartitionCount": 16 + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "475074b8-c957-4b1f-a219-12b8399c3d4c" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj6695/inputs/input8899", + "name": "input8899", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "sourcePartitionCount": 16, + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + }, + "200": { + "headers": { + "ETag": "475074b8-c957-4b1f-a219-12b8399c3d4c" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj6695/inputs/input8899", + "name": "input8899", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "sourcePartitionCount": 16, + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Create_Stream_EventHub_JSON.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Create_Stream_EventHub_JSON.json new file mode 100644 index 000000000000..b73ee46ff860 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Create_Stream_EventHub_JSON.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj197", + "inputName": "input7425", + "input": { + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey", + "sharedAccessPolicyKey": "someSharedAccessPolicyKey==", + "eventHubName": "sdkeventhub", + "consumerGroupName": "sdkconsumergroup" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "afd0d184-37e9-4370-9e55-32501bc4de3a" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj197/inputs/input7425", + "name": "input7425", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "eventHubName": "sdkeventhub", + "consumerGroupName": "sdkconsumergroup", + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + } + } + } + }, + "200": { + "headers": { + "ETag": "afd0d184-37e9-4370-9e55-32501bc4de3a" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj197/inputs/input7425", + "name": "input7425", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "eventHubName": "sdkeventhub", + "consumerGroupName": "sdkconsumergroup", + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Create_Stream_IoTHub_Avro.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Create_Stream_IoTHub_Avro.json new file mode 100644 index 000000000000..cc86b7bcc8b5 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Create_Stream_IoTHub_Avro.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj9742", + "inputName": "input7970", + "input": { + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Devices/IotHubs", + "properties": { + "iotHubNamespace": "iothub", + "sharedAccessPolicyName": "owner", + "sharedAccessPolicyKey": "sharedAccessPolicyKey=", + "consumerGroupName": "sdkconsumergroup", + "endpoint": "messages/events" + } + }, + "serialization": { + "type": "Avro" + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "bd8009b3-8165-4bd3-aad2-29a2b378dd14" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj9742/inputs/input7970", + "name": "input7970", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Devices/IotHubs", + "properties": { + "iotHubNamespace": "iothub", + "sharedAccessPolicyName": "owner", + "endpoint": "messages/events", + "consumerGroupName": "sdkconsumergroup" + } + }, + "serialization": { + "type": "Avro", + "properties": {} + } + } + } + }, + "200": { + "headers": { + "ETag": "bd8009b3-8165-4bd3-aad2-29a2b378dd14" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj9742/inputs/input7970", + "name": "input7970", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Devices/IotHubs", + "properties": { + "iotHubNamespace": "iothub", + "sharedAccessPolicyName": "owner", + "endpoint": "messages/events", + "consumerGroupName": "sdkconsumergroup" + } + }, + "serialization": { + "type": "Avro", + "properties": {} + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Delete.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Delete.json new file mode 100644 index 000000000000..efc786d71416 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj9597", + "inputName": "input7225" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Get_Reference_Blob_CSV.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Get_Reference_Blob_CSV.json new file mode 100644 index 000000000000..d560b90d6d16 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Get_Reference_Blob_CSV.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj9597", + "inputName": "input7225" + }, + "responses": { + "200": { + "headers": { + "ETag": "c987701d-4039-47aa-a115-ad84f67d07c5" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7225", + "name": "input7225", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Reference", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Get_Stream_Blob_CSV.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Get_Stream_Blob_CSV.json new file mode 100644 index 000000000000..083c30bbb96a --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Get_Stream_Blob_CSV.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj6695", + "inputName": "input8899" + }, + "responses": { + "200": { + "headers": { + "ETag": "475074b8-c957-4b1f-a219-12b8399c3d4c" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj6695/inputs/input8899", + "name": "input8899", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "sourcePartitionCount": 16, + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Get_Stream_EventHub_JSON.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Get_Stream_EventHub_JSON.json new file mode 100644 index 000000000000..44f137054ef4 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Get_Stream_EventHub_JSON.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj197", + "inputName": "input7425" + }, + "responses": { + "200": { + "headers": { + "ETag": "afd0d184-37e9-4370-9e55-32501bc4de3a" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj197/inputs/input7425", + "name": "input7425", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "eventHubName": "sdkeventhub", + "consumerGroupName": "sdkconsumergroup", + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Get_Stream_IoTHub_Avro.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Get_Stream_IoTHub_Avro.json new file mode 100644 index 000000000000..cb639630e138 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Get_Stream_IoTHub_Avro.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj9742", + "inputName": "input7970" + }, + "responses": { + "200": { + "headers": { + "ETag": "bd8009b3-8165-4bd3-aad2-29a2b378dd14" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj9742/inputs/input7970", + "name": "input7970", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Devices/IotHubs", + "properties": { + "iotHubNamespace": "iothub", + "sharedAccessPolicyName": "owner", + "endpoint": "messages/events", + "consumerGroupName": "sdkconsumergroup" + } + }, + "serialization": { + "type": "Avro", + "properties": {} + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_ListByStreamingJob.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_ListByStreamingJob.json new file mode 100644 index 000000000000..e0165148a5c2 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_ListByStreamingJob.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj9597" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7225", + "name": "input7225", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Reference", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "differentContainer", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + }, + "etag": "a4ceb697-1c8f-40c8-b951-fb5ee4757437" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input8899", + "name": "input8899", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "sourcePartitionCount": 32, + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + }, + "etag": "3b35d57c-02f4-4b41-8e1d-af02a86c2fa1" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7425", + "name": "input7425", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "eventHubName": "sdkeventhub", + "consumerGroupName": "differentConsumerGroupName", + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Avro", + "properties": {} + }, + "etag": "7548f259-81b5-4ea7-b896-25c6717d98ba" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7970", + "name": "input7970", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Devices/IotHubs", + "properties": { + "iotHubNamespace": "iothub", + "sharedAccessPolicyName": "owner", + "endpoint": "messages/operationsMonitoringEvents", + "consumerGroupName": "sdkconsumergroup" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + }, + "etag": "e2d847e0-c95b-48ef-9e14-1afc1f2270cb" + } + } + ] + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_ListByStreamingJob_Diagnostics.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_ListByStreamingJob_Diagnostics.json new file mode 100644 index 000000000000..cbe3348e4459 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_ListByStreamingJob_Diagnostics.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj7804", + "$select": "*" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest", + "name": "inputtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + }, + "diagnostics": { + "conditions": [ + { + "since": "2017-05-11T04:38:42.4938687Z", + "code": "INP-3", + "message": "Could not deserialize the input event as Json. Some possible reasons: 1) Malformed events 2) Input source configured with incorrect serialization format" + } + ] + }, + "etag": "ca88f8fa-605b-4c7f-8695-46f5faa60cd0" + } + } + ] + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Test.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Test.json new file mode 100644 index 000000000000..d72cf2c0372c --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Test.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj9597", + "inputName": "input7225" + }, + "responses": { + "200": { + "body": { + "status": "TestSucceeded" + } + }, + "202": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Update_Reference_Blob.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Update_Reference_Blob.json new file mode 100644 index 000000000000..6f9b28c8db9b --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Update_Reference_Blob.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj9597", + "inputName": "input7225", + "input": { + "properties": { + "type": "Reference", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "container": "differentContainer" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "a4ceb697-1c8f-40c8-b951-fb5ee4757437" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj9597/inputs/input7225", + "name": "input7225", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Reference", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "differentContainer", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Update_Stream_Blob.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Update_Stream_Blob.json new file mode 100644 index 000000000000..de4b602ffb0a --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Update_Stream_Blob.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj6695", + "inputName": "input8899", + "input": { + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "sourcePartitionCount": 32 + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "3b35d57c-02f4-4b41-8e1d-af02a86c2fa1" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj6695/inputs/input8899", + "name": "input8899", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "sourcePartitionCount": 32, + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Update_Stream_EventHub.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Update_Stream_EventHub.json new file mode 100644 index 000000000000..362ae7631e6e --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Update_Stream_EventHub.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj197", + "inputName": "input7425", + "input": { + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "consumerGroupName": "differentConsumerGroupName" + } + }, + "serialization": { + "type": "Avro" + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "7548f259-81b5-4ea7-b896-25c6717d98ba" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj197/inputs/input7425", + "name": "input7425", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "eventHubName": "sdkeventhub", + "consumerGroupName": "differentConsumerGroupName", + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Avro", + "properties": {} + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Update_Stream_IoTHub.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Update_Stream_IoTHub.json new file mode 100644 index 000000000000..96fda55e9a86 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Input_Update_Stream_IoTHub.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj9742", + "inputName": "input7970", + "input": { + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Devices/IotHubs", + "properties": { + "endpoint": "messages/operationsMonitoringEvents" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "e2d847e0-c95b-48ef-9e14-1afc1f2270cb" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj9742/inputs/input7970", + "name": "input7970", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Devices/IotHubs", + "properties": { + "iotHubNamespace": "iothub", + "sharedAccessPolicyName": "owner", + "endpoint": "messages/operationsMonitoringEvents", + "consumerGroupName": "sdkconsumergroup" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Operation_List.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Operation_List.json new file mode 100644 index 000000000000..442cff126fb4 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Operation_List.json @@ -0,0 +1,319 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.StreamAnalytics/locations/quotas/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Subscription Quota", + "operation": "Read Stream Analytics Subscription Quota", + "description": "Read Stream Analytics Subscription Quota" + } + }, + { + "name": "Microsoft.StreamAnalytics/operations/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Operations", + "operation": "Read Stream Analytics Operations", + "description": "Read Stream Analytics Operations" + } + }, + { + "name": "Microsoft.StreamAnalytics/Register/action", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Resource Provider", + "operation": "Register subscription with Stream Analytics Resource Provider", + "description": "Register subscription with Stream Analytics Resource Provider" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/Delete", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job", + "operation": "Delete Stream Analytics Job", + "description": "Delete Stream Analytics Job" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/functions/Delete", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Function", + "operation": "Delete Stream Analytics Job Function", + "description": "Delete Stream Analytics Job Function" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/functions/operationresults/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Function", + "operation": "Read operation results for Stream Analytics Job Function", + "description": "Read operation results for Stream Analytics Job Function" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/functions/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Function", + "operation": "Read Stream Analytics Job Function", + "description": "Read Stream Analytics Job Function" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/functions/RetrieveDefaultDefinition/action", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Function", + "operation": "Retrieve Default Definition of a Stream Analytics Job Function", + "description": "Retrieve Default Definition of a Stream Analytics Job Function" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/functions/Test/action", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Function", + "operation": "Test Stream Analytics Job Function", + "description": "Test Stream Analytics Job Function" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/functions/Write", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Function", + "operation": "Write Stream Analytics Job Function", + "description": "Write Stream Analytics Job Function" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/inputs/Delete", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Input", + "operation": "Delete Stream Analytics Job Input", + "description": "Delete Stream Analytics Job Input" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/inputs/operationresults/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Input", + "operation": "Read operation results for Stream Analytics Job Input", + "description": "Read operation results for Stream Analytics Job Input" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/inputs/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Input", + "operation": "Read Stream Analytics Job Input", + "description": "Read Stream Analytics Job Input" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/inputs/Sample/action", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Input", + "operation": "Sample Stream Analytics Job Input", + "description": "Sample Stream Analytics Job Input" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/inputs/Test/action", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Input", + "operation": "Test Stream Analytics Job Input", + "description": "Test Stream Analytics Job Input" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/inputs/Write", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Input", + "operation": "Write Stream Analytics Job Input", + "description": "Write Stream Analytics Job Input" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/metricdefinitions/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Metric Definitions", + "operation": "Read Metric Definitions", + "description": "Read Metric Definitions" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/operationresults/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job", + "operation": "Read operation results for Stream Analytics Job", + "description": "Read operation results for Stream Analytics Job" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/outputs/Delete", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Output", + "operation": "Delete Stream Analytics Job Output", + "description": "Delete Stream Analytics Job Output" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/outputs/operationresults/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Output", + "operation": "Read operation results for Stream Analytics Job Output", + "description": "Read operation results for Stream Analytics Job Output" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/outputs/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Output", + "operation": "Read Stream Analytics Job Output", + "description": "Read Stream Analytics Job Output" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/outputs/Test/action", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Output", + "operation": "Test Stream Analytics Job Output", + "description": "Test Stream Analytics Job Output" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/outputs/Write", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Output", + "operation": "Write Stream Analytics Job Output", + "description": "Write Stream Analytics Job Output" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "streamingjobs", + "operation": "Read diagnostic setting.", + "description": "Read diagnostic setting." + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "streamingjobs", + "operation": "Write diagnostic setting.", + "description": "Write diagnostic setting." + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/PublishEdgePackage/action", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job", + "operation": "Publish edge package for Stream Analytics Job", + "description": "Publish edge package for Stream Analytics Job" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job", + "operation": "Read Stream Analytics Job", + "description": "Read Stream Analytics Job" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/Scale/action", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job", + "operation": "Scale Stream Analytics Job", + "description": "Scale Stream Analytics Job" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/Start/action", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job", + "operation": "Start Stream Analytics Job", + "description": "Start Stream Analytics Job" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/Stop/action", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job", + "operation": "Stop Stream Analytics Job", + "description": "Stop Stream Analytics Job" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/transformations/Delete", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Transformation", + "operation": "Delete Stream Analytics Job Transformation", + "description": "Delete Stream Analytics Job Transformation" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/transformations/Read", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Transformation", + "operation": "Read Stream Analytics Job Transformation", + "description": "Read Stream Analytics Job Transformation" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/transformations/Write", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job Transformation", + "operation": "Write Stream Analytics Job Transformation", + "description": "Write Stream Analytics Job Transformation" + } + }, + { + "name": "Microsoft.StreamAnalytics/streamingjobs/Write", + "display": { + "provider": "Microsoft Azure Stream Analytics", + "resource": "Stream Analytics Job", + "operation": "Write Stream Analytics Job", + "description": "Write Stream Analytics Job" + } + } + ] + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_AzureDataLakeStore_JSON.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_AzureDataLakeStore_JSON.json new file mode 100644 index 000000000000..f070987e133d --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_AzureDataLakeStore_JSON.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj3310", + "outputName": "output5195", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.DataLake/Accounts", + "properties": { + "accountName": "someaccount", + "tenantId": "cea4e98b-c798-49e7-8c40-4a2b3beb47dd", + "refreshToken": "someRefreshToken==", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "filePathPrefix": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "Array" + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "5472168f-7317-4241-8b75-0c8d9d0ea804" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195", + "name": "output5195", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.DataLake/Accounts", + "properties": { + "accountName": "someaccount", + "tenantId": "cea4e98b-c798-49e7-8c40-4a2b3beb47dd", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "filePathPrefix": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "Array" + } + } + } + } + }, + "200": { + "headers": { + "ETag": "5472168f-7317-4241-8b75-0c8d9d0ea804" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195", + "name": "output5195", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.DataLake/Accounts", + "properties": { + "accountName": "someaccount", + "tenantId": "cea4e98b-c798-49e7-8c40-4a2b3beb47dd", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "filePathPrefix": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "Array" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_AzureSQL.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_AzureSQL.json new file mode 100644 index 000000000000..0e008ff6f410 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_AzureSQL.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj6458", + "outputName": "output1755", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "someServer", + "database": "someDatabase", + "user": "someUser", + "password": "somePassword", + "table": "someTable" + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "731a47c6-ff67-4439-bde6-a2a3da4c1ecf" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output1755", + "name": "output1755", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "someServer", + "database": "someDatabase", + "table": "someTable", + "user": "someUser" + } + } + } + } + }, + "200": { + "headers": { + "ETag": "731a47c6-ff67-4439-bde6-a2a3da4c1ecf" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output1755", + "name": "output1755", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "someServer", + "database": "someDatabase", + "table": "someTable", + "user": "someUser" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_AzureTable.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_AzureTable.json new file mode 100644 index 000000000000..1a65e7b04e91 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_AzureTable.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj2790", + "outputName": "output958", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.Storage/Table", + "properties": { + "accountName": "someAccountName", + "accountKey": "accountKey==", + "table": "samples", + "partitionKey": "partitionKey", + "rowKey": "rowKey", + "columnsToRemove": [ + "column1", + "column2" + ], + "batchSize": 25 + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "2409b6d1-c99c-405b-9a14-ea7833637038" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj2790/outputs/output958", + "name": "output958", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Table", + "properties": { + "accountName": "someAccountName", + "table": "samples", + "partitionKey": "partitionKey", + "rowKey": "rowKey", + "columnsToRemove": [ + "column1", + "column2" + ], + "batchSize": 25 + } + } + } + } + }, + "200": { + "headers": { + "ETag": "2409b6d1-c99c-405b-9a14-ea7833637038" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj2790/outputs/output958", + "name": "output958", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Table", + "properties": { + "accountName": "someAccountName", + "table": "samples", + "partitionKey": "partitionKey", + "rowKey": "rowKey", + "columnsToRemove": [ + "column1", + "column2" + ], + "batchSize": 25 + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_Blob_CSV.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_Blob_CSV.json new file mode 100644 index 000000000000..fbe36e19d632 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_Blob_CSV.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj900", + "outputName": "output1623", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName", + "accountKey": "accountKey==" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "5433fd97-d133-46e3-8588-5fe1f1599ee0" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj900/outputs/output1623", + "name": "output1623", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + }, + "200": { + "headers": { + "ETag": "5433fd97-d133-46e3-8588-5fe1f1599ee0" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj900/outputs/output1623", + "name": "output1623", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_DocumentDB.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_DocumentDB.json new file mode 100644 index 000000000000..0f9365a8a609 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_DocumentDB.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj2331", + "outputName": "output3022", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.Storage/DocumentDB", + "properties": { + "accountId": "someAccountId", + "accountKey": "accountKey==", + "database": "db01", + "collectionNamePattern": "collection", + "partitionKey": "key", + "documentId": "documentId" + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "ccf8b864-259e-43c5-a628-ba10858b2c07" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022", + "name": "output3022", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/DocumentDB", + "properties": { + "accountId": "someAccountId", + "database": "db01", + "collectionNamePattern": "collection", + "partitionKey": "key", + "documentId": "documentId" + } + } + } + } + }, + "200": { + "headers": { + "ETag": "ccf8b864-259e-43c5-a628-ba10858b2c07" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022", + "name": "output3022", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/DocumentDB", + "properties": { + "accountId": "someAccountId", + "database": "db01", + "collectionNamePattern": "collection", + "partitionKey": "key", + "documentId": "documentId" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_EventHub_JSON.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_EventHub_JSON.json new file mode 100644 index 000000000000..4f2caaef48e9 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_EventHub_JSON.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj3310", + "outputName": "output5195", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey", + "sharedAccessPolicyKey": "sharedAccessPolicyKey=", + "eventHubName": "sdkeventhub", + "partitionKey": "partitionKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "Array" + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "5472168f-7317-4241-8b75-0c8d9d0ea804" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195", + "name": "output5195", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "eventHubName": "sdkeventhub", + "partitionKey": "partitionKey", + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "Array" + } + } + } + } + }, + "200": { + "headers": { + "ETag": "5472168f-7317-4241-8b75-0c8d9d0ea804" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195", + "name": "output5195", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "eventHubName": "sdkeventhub", + "partitionKey": "partitionKey", + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "Array" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_PowerBI.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_PowerBI.json new file mode 100644 index 000000000000..0d132fa48f13 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_PowerBI.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj2331", + "outputName": "output3022", + "output": { + "properties": { + "datasource": { + "type": "PowerBI", + "properties": { + "dataset": "someDataset", + "table": "someTable", + "refreshToken": "someRefreshToken==", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "groupId": "ac40305e-3e8d-43ac-8161-c33799f43e95", + "groupName": "MyPowerBIGroup", + "authenticationMode": "ConnectionString" + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "ccf8b864-259e-43c5-a628-ba10858b2c07" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022", + "name": "output3022", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "PowerBI", + "properties": { + "dataset": "someDataset", + "table": "someTable", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "groupId": "ac40305e-3e8d-43ac-8161-c33799f43e95", + "groupName": "MyPowerBIGroup", + "authenticationMode": "ConnectionString" + } + } + } + } + }, + "200": { + "headers": { + "ETag": "ccf8b864-259e-43c5-a628-ba10858b2c07" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022", + "name": "output3022", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "PowerBI", + "properties": { + "dataset": "someDataset", + "table": "someTable", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "groupId": "ac40305e-3e8d-43ac-8161-c33799f43e95", + "groupName": "MyPowerBIGroup", + "authenticationMode": "ConnectionString" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_ServiceBusQueue_Avro.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_ServiceBusQueue_Avro.json new file mode 100644 index 000000000000..893b2e566ae2 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_ServiceBusQueue_Avro.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj5095", + "outputName": "output3456", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Queue", + "properties": { + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey", + "sharedAccessPolicyKey": "sharedAccessPolicyKey=", + "queueName": "sdkqueue", + "propertyColumns": [ + "column1", + "column2" + ] + } + }, + "serialization": { + "type": "Avro" + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "2f68c1ec-2080-43cb-93ec-4bcd3b7f9dbe" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj5095/outputs/output3456", + "name": "output3456", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Queue", + "properties": { + "queueName": "sdkqueue", + "propertyColumns": [ + "column1", + "column2" + ], + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Avro", + "properties": {} + } + } + } + }, + "200": { + "headers": { + "ETag": "2f68c1ec-2080-43cb-93ec-4bcd3b7f9dbe" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj5095/outputs/output3456", + "name": "output3456", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Queue", + "properties": { + "queueName": "sdkqueue", + "propertyColumns": [ + "column1", + "column2" + ], + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Avro", + "properties": {} + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_ServiceBusTopic_CSV.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_ServiceBusTopic_CSV.json new file mode 100644 index 000000000000..b24a002925cf --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Create_ServiceBusTopic_CSV.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj7094", + "outputName": "output7886", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Topic", + "properties": { + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey", + "sharedAccessPolicyKey": "sharedAccessPolicyKey=", + "topicName": "sdktopic", + "propertyColumns": [ + "column1", + "column2" + ] + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "39259839-e581-4af4-bf68-302e6820e3a0" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj7094/outputs/output7886", + "name": "output7886", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Topic", + "properties": { + "topicName": "sdktopic", + "propertyColumns": [ + "column1", + "column2" + ], + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + }, + "200": { + "headers": { + "ETag": "39259839-e581-4af4-bf68-302e6820e3a0" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj7094/outputs/output7886", + "name": "output7886", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Topic", + "properties": { + "topicName": "sdktopic", + "propertyColumns": [ + "column1", + "column2" + ], + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Delete.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Delete.json new file mode 100644 index 000000000000..3225777c59d9 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj6458", + "outputName": "output1755" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_AzureDataLakeStore_JSON.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_AzureDataLakeStore_JSON.json new file mode 100644 index 000000000000..10978f4f6365 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_AzureDataLakeStore_JSON.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj3310", + "outputName": "output5195" + }, + "responses": { + "200": { + "headers": { + "ETag": "5472168f-7317-4241-8b75-0c8d9d0ea804" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195", + "name": "output5195", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.DataLake/Accounts", + "properties": { + "accountName": "someaccount", + "tenantId": "cea4e98b-c798-49e7-8c40-4a2b3beb47dd", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "filePathPrefix": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "Array" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_AzureFunction.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_AzureFunction.json new file mode 100644 index 000000000000..109b2fb683ed --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_AzureFunction.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj2790", + "outputName": "output958" + }, + "responses": { + "200": { + "headers": { + "ETag": "2409b6d1-c99c-405b-9a14-ea7833637038" + }, + "body": { + "id": "/subscriptions/7f31cba8-b597-4129-b158-8f21a7395bd0/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/kunAll0908npm2/outputs/AzureFunction1", + "name": "AzureFunction1", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.AzureFunction", + "properties": { + "functionAppName": "functionappforasaautomation", + "functionName": "HttpTrigger2", + "apiKey": null, + "maxBatchSize": 256, + "maxBatchCount": 100 + } + }, + "etag": "7b912929-346d-432e-9495-6972dbd63179" + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_AzureSQL.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_AzureSQL.json new file mode 100644 index 000000000000..5c0f053b613d --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_AzureSQL.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj6458", + "outputName": "output1755" + }, + "responses": { + "200": { + "headers": { + "ETag": "731a47c6-ff67-4439-bde6-a2a3da4c1ecf" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output1755", + "name": "output1755", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "someServer", + "database": "someDatabase", + "table": "someTable", + "user": "someUser" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_AzureTable.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_AzureTable.json new file mode 100644 index 000000000000..e67c48756bdb --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_AzureTable.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj2790", + "outputName": "output958" + }, + "responses": { + "200": { + "headers": { + "ETag": "2409b6d1-c99c-405b-9a14-ea7833637038" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj2790/outputs/output958", + "name": "output958", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Table", + "properties": { + "accountName": "someAccountName", + "table": "samples", + "partitionKey": "partitionKey", + "rowKey": "rowKey", + "columnsToRemove": [ + "column1", + "column2" + ], + "batchSize": 25 + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_Blob_CSV.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_Blob_CSV.json new file mode 100644 index 000000000000..d7c7cdde7b4d --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_Blob_CSV.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj900", + "outputName": "output1623" + }, + "responses": { + "200": { + "headers": { + "ETag": "5433fd97-d133-46e3-8588-5fe1f1599ee0" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj900/outputs/output1623", + "name": "output1623", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "state", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_DataWarehouse.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_DataWarehouse.json new file mode 100644 index 000000000000..dcd8f0581443 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_DataWarehouse.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj2790", + "outputName": "output958" + }, + "responses": { + "200": { + "headers": { + "ETag": "2409b6d1-c99c-405b-9a14-ea7833637038" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/kunAll0908npm2/outputs/SynapseformerlySQLDW1", + "name": "SynapseformerlySQLDW1", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/DataWarehouse", + "properties": { + "table": "test2", + "server": "asatestserver", + "database": "zhayaSQLpool", + "user": "tolladmin" + } + }, + "etag": "ce3fb956-0487-4168-af20-1133a59bdc6e" + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_DocumentDB.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_DocumentDB.json new file mode 100644 index 000000000000..37063497ee26 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_DocumentDB.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj2331", + "outputName": "output3022" + }, + "responses": { + "200": { + "headers": { + "ETag": "ccf8b864-259e-43c5-a628-ba10858b2c07" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022", + "name": "output3022", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/DocumentDB", + "properties": { + "accountId": "someAccountId", + "database": "db01", + "collectionNamePattern": "collection", + "partitionKey": "key", + "documentId": "documentId" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_EventHub_JSON.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_EventHub_JSON.json new file mode 100644 index 000000000000..5680a436242d --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_EventHub_JSON.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj3310", + "outputName": "output5195" + }, + "responses": { + "200": { + "headers": { + "ETag": "5472168f-7317-4241-8b75-0c8d9d0ea804" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195", + "name": "output5195", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "eventHubName": "sdkeventhub", + "partitionKey": "partitionKey", + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "Array" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_PowerBI.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_PowerBI.json new file mode 100644 index 000000000000..e62d3ed60f41 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_PowerBI.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj2331", + "outputName": "output3022" + }, + "responses": { + "200": { + "headers": { + "ETag": "ccf8b864-259e-43c5-a628-ba10858b2c07" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022", + "name": "output3022", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "PowerBI", + "properties": { + "dataset": "someDataset", + "table": "someTable", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "groupId": "ac40305e-3e8d-43ac-8161-c33799f43e95", + "groupName": "MyPowerBIGroup" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_ServiceBusQueue_Avro.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_ServiceBusQueue_Avro.json new file mode 100644 index 000000000000..539338506799 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_ServiceBusQueue_Avro.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj5095", + "outputName": "output3456" + }, + "responses": { + "200": { + "headers": { + "ETag": "2f68c1ec-2080-43cb-93ec-4bcd3b7f9dbe" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj5095/outputs/output3456", + "name": "output3456", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Queue", + "properties": { + "queueName": "sdkqueue", + "propertyColumns": [ + "column1", + "column2" + ], + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Avro", + "properties": {} + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_ServiceBusTopic_CSV.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_ServiceBusTopic_CSV.json new file mode 100644 index 000000000000..d53758411faf --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Get_ServiceBusTopic_CSV.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj7094", + "outputName": "output7886" + }, + "responses": { + "200": { + "headers": { + "ETag": "39259839-e581-4af4-bf68-302e6820e3a0" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj7094/outputs/output7886", + "name": "output7886", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Topic", + "properties": { + "topicName": "sdktopic", + "propertyColumns": [ + "column1", + "column2" + ], + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_ListByStreamingJob.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_ListByStreamingJob.json new file mode 100644 index 000000000000..59cc2c0332a2 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_ListByStreamingJob.json @@ -0,0 +1,226 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj6458" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output1755", + "name": "output1755", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "someServer", + "database": "someDatabase", + "table": "differentTable", + "user": "someUser" + } + }, + "etag": "f489d6f3-fcd5-4bcb-b642-81e987ee16d6" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output958", + "name": "output958", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Table", + "properties": { + "accountName": "someAccountName", + "table": "samples", + "partitionKey": "differentPartitionKey", + "rowKey": "rowKey", + "columnsToRemove": [ + "column1", + "column2" + ], + "batchSize": 25 + } + }, + "etag": "ea1d20bf-6cb3-40bc-bc7b-ec3a7fd5977e" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output1623", + "name": "output1623", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "differentContainer", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + }, + "etag": "3a1b2023-79a9-4b33-93e8-f49fc3e573fe" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output3022", + "name": "output3022", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/DocumentDB", + "properties": { + "accountId": "someAccountId", + "database": "db01", + "collectionNamePattern": "collection", + "partitionKey": "differentPartitionKey", + "documentId": "documentId" + } + }, + "etag": "7849c132-e995-4631-91c3-931606eec432" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output5195", + "name": "output5195", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "eventHubName": "sdkeventhub", + "partitionKey": "differentPartitionKey", + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + }, + "etag": "5020de6b-5bb3-4b88-8606-f11fb3c46185" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output3456", + "name": "output3456", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Queue", + "properties": { + "queueName": "differentQueueName", + "propertyColumns": [ + "column1", + "column2" + ], + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + }, + "etag": "429adaec-a777-4750-8a39-8d0c931d801c" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output7886", + "name": "output7886", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Topic", + "properties": { + "topicName": "differentTopicName", + "propertyColumns": [ + "column1", + "column2" + ], + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + }, + "etag": "c1c2007f-45b2-419a-ae7d-4d2148998460" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output3021", + "name": "output3021", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "PowerBI", + "properties": { + "dataset": "differentDataset", + "table": "someTable", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "groupId": "ac40305e-3e8d-43ac-8161-c33799f43e95", + "groupName": "MyPowerBIGroup" + } + }, + "etag": "4a492191-9672-4178-be10-043b9dbd4b9f" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output5196", + "name": "output5196", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.DataLake/Accounts", + "properties": { + "accountName": "differentaccount", + "tenantId": "cea4e98b-c798-49e7-8c40-4a2b3beb47dd", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "filePathPrefix": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + }, + "etag": "39ab7642-8c1e-48ed-85eb-949068d68002" + } + } + ] + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Test.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Test.json new file mode 100644 index 000000000000..1531796e0c22 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Test.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj6458", + "outputName": "output1755" + }, + "responses": { + "200": { + "body": { + "status": "TestSucceeded" + } + }, + "202": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_AzureDataLakeStore.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_AzureDataLakeStore.json new file mode 100644 index 000000000000..ee70b388781b --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_AzureDataLakeStore.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj3310", + "outputName": "output5195", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.DataLake/Accounts", + "properties": { + "accountName": "differentaccount" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "5020de6b-5bb3-4b88-8606-f11fb3c46185" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195", + "name": "output5195", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.DataLake/Accounts", + "properties": { + "accountName": "differentaccount", + "tenantId": "cea4e98b-c798-49e7-8c40-4a2b3beb47dd", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "filePathPrefix": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_AzureSQL.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_AzureSQL.json new file mode 100644 index 000000000000..70282bbc7b3c --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_AzureSQL.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj6458", + "outputName": "output1755", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "table": "differentTable" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "f489d6f3-fcd5-4bcb-b642-81e987ee16d6" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output1755", + "name": "output1755", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "someServer", + "database": "someDatabase", + "table": "differentTable", + "user": "someUser" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_AzureTable.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_AzureTable.json new file mode 100644 index 000000000000..6f0872407e77 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_AzureTable.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj2790", + "outputName": "output958", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.Storage/Table", + "properties": { + "partitionKey": "differentPartitionKey" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "ea1d20bf-6cb3-40bc-bc7b-ec3a7fd5977e" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj2790/outputs/output958", + "name": "output958", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Table", + "properties": { + "accountName": "someAccountName", + "table": "samples", + "partitionKey": "differentPartitionKey", + "rowKey": "rowKey", + "columnsToRemove": [ + "column1", + "column2" + ], + "batchSize": 25 + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_Blob.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_Blob.json new file mode 100644 index 000000000000..e0e87d50eea4 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_Blob.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj900", + "outputName": "output1623", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "container": "differentContainer" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "3a1b2023-79a9-4b33-93e8-f49fc3e573fe" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj900/outputs/output1623", + "name": "output1623", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "someAccountName" + } + ], + "container": "differentContainer", + "pathPattern": "{date}/{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_DocumentDB.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_DocumentDB.json new file mode 100644 index 000000000000..2e3924da160a --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_DocumentDB.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj2331", + "outputName": "output3022", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.Storage/DocumentDB", + "properties": { + "partitionKey": "differentPartitionKey" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "7849c132-e995-4631-91c3-931606eec432" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022", + "name": "output3022", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/DocumentDB", + "properties": { + "accountId": "someAccountId", + "database": "db01", + "collectionNamePattern": "collection", + "partitionKey": "differentPartitionKey", + "documentId": "documentId" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_EventHub.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_EventHub.json new file mode 100644 index 000000000000..efceb3b456c6 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_EventHub.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj3310", + "outputName": "output5195", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "partitionKey": "differentPartitionKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "5020de6b-5bb3-4b88-8606-f11fb3c46185" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195", + "name": "output5195", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "eventHubName": "sdkeventhub", + "partitionKey": "differentPartitionKey", + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_PowerBI.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_PowerBI.json new file mode 100644 index 000000000000..914d53994c1c --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_PowerBI.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj2331", + "outputName": "output3022", + "output": { + "properties": { + "datasource": { + "type": "PowerBI", + "properties": { + "dataset": "differentDataset" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "7849c132-e995-4631-91c3-931606eec432" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022", + "name": "output3022", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "PowerBI", + "properties": { + "dataset": "differentDataset", + "table": "someTable", + "tokenUserPrincipalName": "bobsmith@contoso.com", + "tokenUserDisplayName": "Bob Smith", + "groupId": "ac40305e-3e8d-43ac-8161-c33799f43e95", + "groupName": "MyPowerBIGroup" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_ServiceBusQueue.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_ServiceBusQueue.json new file mode 100644 index 000000000000..22f059c8dce6 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_ServiceBusQueue.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj5095", + "outputName": "output3456", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Queue", + "properties": { + "queueName": "differentQueueName" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "429adaec-a777-4750-8a39-8d0c931d801c" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj5095/outputs/output3456", + "name": "output3456", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Queue", + "properties": { + "queueName": "differentQueueName", + "propertyColumns": [ + "column1", + "column2" + ], + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_ServiceBusTopic.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_ServiceBusTopic.json new file mode 100644 index 000000000000..8853725cd6ea --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Output_Update_ServiceBusTopic.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj7094", + "outputName": "output7886", + "output": { + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Topic", + "properties": { + "topicName": "differentTopicName" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "c1c2007f-45b2-419a-ae7d-4d2148998460" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj7094/outputs/output7886", + "name": "output7886", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.ServiceBus/Topic", + "properties": { + "topicName": "differentTopicName", + "propertyColumns": [ + "column1", + "column2" + ], + "serviceBusNamespace": "sdktest", + "sharedAccessPolicyName": "RootManageSharedAccessKey" + } + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": "|", + "encoding": "UTF8" + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Create_CompleteJob.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Create_CompleteJob.json new file mode 100644 index 000000000000..9bbde5a6f337 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Create_CompleteJob.json @@ -0,0 +1,261 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj7804", + "streamingJob": { + "properties": { + "sku": { + "name": "Standard" + }, + "eventsOutOfOrderPolicy": "Drop", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "compatibilityLevel": "1.0", + "inputs": [ + { + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "yourAccountName", + "accountKey": "yourAccountKey==" + } + ], + "container": "containerName", + "pathPattern": "" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + } + }, + "name": "inputtest" + } + ], + "transformation": { + "properties": { + "streamingUnits": 1, + "query": "Select Id, Name from inputtest" + }, + "name": "transformationtest" + }, + "outputs": [ + { + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "serverName", + "database": "databaseName", + "user": "userName", + "password": "userPassword", + "table": "tableName" + } + } + }, + "name": "outputtest" + } + ], + "functions": [] + }, + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "87551cc5-1290-4d08-afcd-cdaa92e5ade0" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804", + "name": "sj7804", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "732e4b1d-94a7-43ae-8297-3ad04f1540b9", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Drop", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2017-05-11T04:37:11.54Z", + "compatibilityLevel": "1.0", + "inputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest", + "name": "inputtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "accountName" + } + ], + "container": "containerName", + "pathPattern": "" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + }, + "etag": "ca88f8fa-605b-4c7f-8695-46f5faa60cd0" + } + } + ], + "transformation": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/transformations/transformationtest", + "name": "transformationtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 1, + "query": "Select Id, Name from inputtest", + "etag": "91d8fcbe-60b3-49c3-9f21-9942b95602b8" + } + }, + "functions": [], + "outputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/outputs/outputtest", + "name": "outputtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "serverName", + "database": "databaseName", + "table": "tableName", + "user": "userName" + } + }, + "etag": "62097c3c-b503-41ff-a56f-196a9598ab90" + } + } + ] + } + } + }, + "200": { + "headers": { + "ETag": "87551cc5-1290-4d08-afcd-cdaa92e5ade0" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804", + "name": "sj7804", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "732e4b1d-94a7-43ae-8297-3ad04f1540b9", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Drop", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2017-05-11T04:37:11.54Z", + "compatibilityLevel": "1.0", + "inputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest", + "name": "inputtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "accountName" + } + ], + "container": "containerName", + "pathPattern": "" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + }, + "etag": "ca88f8fa-605b-4c7f-8695-46f5faa60cd0" + } + } + ], + "transformation": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/transformations/transformationtest", + "name": "transformationtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 1, + "query": "Select Id, Name from inputtest", + "etag": "91d8fcbe-60b3-49c3-9f21-9942b95602b8" + } + }, + "functions": [], + "outputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/outputs/outputtest", + "name": "outputtest", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Sql/Server/Database", + "properties": { + "server": "serverName", + "database": "databaseName", + "table": "tableName", + "user": "userName" + } + }, + "etag": "62097c3c-b503-41ff-a56f-196a9598ab90" + } + } + ] + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Create_JobShell.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Create_JobShell.json new file mode 100644 index 000000000000..cf031d95636c --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Create_JobShell.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj59", + "streamingJob": { + "properties": { + "sku": { + "name": "Standard" + }, + "eventsOutOfOrderPolicy": "Drop", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 5, + "eventsLateArrivalMaxDelayInSeconds": 16, + "dataLocale": "en-US", + "compatibilityLevel": "1.0", + "inputs": [], + "outputs": [], + "functions": [] + }, + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "3e6872bc-c9d0-45b6-91b6-da66f1773056" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj59", + "name": "sj59", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "d53ecc3c-fcb0-485d-9caf-25e20fcb2061", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Drop", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 5, + "eventsLateArrivalMaxDelayInSeconds": 16, + "dataLocale": "en-US", + "createdDate": "2017-05-11T04:37:04.697Z", + "compatibilityLevel": "1.0", + "inputs": [], + "functions": [], + "outputs": [] + } + } + }, + "200": { + "headers": { + "ETag": "3e6872bc-c9d0-45b6-91b6-da66f1773056" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj59", + "name": "sj59", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "key1": "value1", + "randomKey": "randomValue", + "key3": "value3" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "d53ecc3c-fcb0-485d-9caf-25e20fcb2061", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Drop", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 5, + "eventsLateArrivalMaxDelayInSeconds": 16, + "dataLocale": "en-US", + "createdDate": "2017-05-11T04:37:04.697Z", + "compatibilityLevel": "1.0", + "inputs": [], + "functions": [], + "outputs": [] + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Delete.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Delete.json new file mode 100644 index 000000000000..56c140778005 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj59" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Get_Expand.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Get_Expand.json new file mode 100644 index 000000000000..fe008830a054 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Get_Expand.json @@ -0,0 +1,244 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj7804", + "$expand": "inputs,outputs,transformation,functions" + }, + "responses": { + "200": { + "headers": { + "ETag": "87551cc5-1290-4d08-afcd-cdaa92e5ade0" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest", + "name": "zhejunmltest", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "aacee415-41d4-47f6-acf4-de9ae50175b0", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Adjust", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2020-07-17T08:36:07.463Z", + "compatibilityLevel": "1.2", + "jobStorageAccount": null, + "contentStoragePolicy": "SystemAccount", + "inputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/inputs/Input", + "name": "Input", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Devices/IotHubs", + "properties": { + "iotHubNamespace": "MyASAIoT", + "sharedAccessPolicyName": "iothubowner", + "endpoint": "messages/events", + "consumerGroupName": "$Default" + } + }, + "compression": { + "type": "None" + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + }, + "etag": "3cb574f7-b63a-4ac1-a1db-8e8a3b88a20d" + } + } + ], + "transformation": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/transformations/Transformation", + "name": "Transformation", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 3, + "query": "\r\nWITH sentiment AS ( \r\nSELECT Temperature, diabetespredict(Temperature) as result \r\nFROM Input \r\n) \r\n\r\nSELECT Temperature, result.[Score] \r\nINTO BlobOutput1\r\nFROM sentiment\r\n\r\n/*\r\nSELECT data, MLFunction2(data)\r\nFROM sampleRequestData\r\n*/\r\n/*\r\nSELECT data, AksArrayScore(data)\r\nFROM sampleData\r\n*/", + "etag": "7241d411-e71d-4205-b77e-4cc56aba34c0" + } + }, + "functions": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/functions/diabetespredict", + "name": "diabetespredict", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "array", + "isConfigurationParameter": null + } + ], + "output": { + "dataType": "float" + }, + "binding": { + "type": "Microsoft.MachineLearningServices", + "properties": { + "endpoint": "http://52.183.91.247/api/v1/service/aks-service-1/score", + "apiKey": null, + "inputs": [ + { + "name": "data", + "dataType": "array", + "mapTo": 0 + } + ], + "outputs": [ + { + "name": "output", + "dataType": "double", + "mapTo": 0 + } + ], + "batchSize": 1000, + "numberOfParallelRequests": 1 + } + } + }, + "etag": "acfdd307-418c-48f3-8856-7c176d38529f" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/functions/MLFunction2", + "name": "MLFunction2", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "array", + "isConfigurationParameter": null + } + ], + "output": { + "dataType": "float" + }, + "binding": { + "type": "Microsoft.MachineLearningServices", + "properties": { + "endpoint": "http://13.83.67.157/api/v1/service/nyc-fare-predict/score", + "apiKey": null, + "inputs": [ + { + "name": "data", + "dataType": "array", + "mapTo": 0 + } + ], + "outputs": [ + { + "name": "output", + "dataType": "double", + "mapTo": 0 + } + ], + "batchSize": 1000, + "numberOfParallelRequests": 1 + } + } + }, + "etag": "4d537fa6-f43c-4ee6-a45e-9a8f8002a65c" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/functions/MLFunction3", + "name": "MLFunction3", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "array", + "isConfigurationParameter": null + } + ], + "output": { + "dataType": "float" + }, + "binding": { + "type": "Microsoft.MachineLearningServices", + "properties": { + "endpoint": "http://52.183.91.247/api/v1/service/aks-service-1/score", + "apiKey": null, + "inputs": [ + { + "name": "data", + "dataType": "array", + "mapTo": 0 + } + ], + "outputs": [ + { + "name": "output", + "dataType": "double", + "mapTo": 0 + } + ], + "batchSize": 1000, + "numberOfParallelRequests": 1 + } + } + }, + "etag": "912f08e7-4a8c-46eb-afaf-d88f930a7b45" + } + } + ], + "outputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/outputs/BlobOutput1", + "name": "BlobOutput1", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "zhejuntest2" + } + ], + "container": "output", + "pathPattern": "{date}{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH", + "authenticationMode": "ConnectionString" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + }, + "etag": "1c271cd5-dd4a-4d3e-95ee-1dbcaa530c2c" + } + } + ], + "etag": "89ba3a42-e217-432e-bf23-798dbf001519", + "jobType": "Cloud", + "cluster": null + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Get_NoExpand.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Get_NoExpand.json new file mode 100644 index 000000000000..7f0d65339cec --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Get_NoExpand.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj59" + }, + "responses": { + "200": { + "headers": { + "ETag": "3e6872bc-c9d0-45b6-91b6-da66f1773056" + }, + "body": { + "id": "/subscriptions/7f31cba8-b597-4129-b158-8f21a7395bd0/resourceGroups/DO_NOT_DELETE/providers/Microsoft.StreamAnalytics/streamingjobs/wrm-test-vs-job", + "name": "wrm-test-vs-job", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "Japan East", + "tags": {}, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "37936929-58fc-4c06-900b-18d110d87fe8", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Adjust", + "outputErrorPolicy": "Stop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2020-06-24T07:41:10.94Z", + "compatibilityLevel": "1.2", + "jobStorageAccount": null, + "contentStoragePolicy": "SystemAccount", + "jobType": "Cloud", + "cluster": null + }, + "identity": { + "principalId": "c10a9ec7-7136-441f-9e90-d17cd1a51b94", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_List_ByResourceGroup_Expand.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_List_ByResourceGroup_Expand.json new file mode 100644 index 000000000000..ead3c7ffb2f9 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_List_ByResourceGroup_Expand.json @@ -0,0 +1,504 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "$expand": "inputs,outputs,transformation,functions" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/asaClusterTest", + "name": "asaClusterTest", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "hidden-link:/Microsoft.StreamAnalytics/streamingjobs/inputs/input": "{\"partitionCount\":2}" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "c5b86804-4b8e-4d99-885f-910ea24b51f4", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Adjust", + "outputErrorPolicy": "Stop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2020-07-15T03:41:25.7Z", + "compatibilityLevel": "1.2", + "jobStorageAccount": null, + "contentStoragePolicy": "SystemAccount", + "inputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/asaClusterTest/inputs/HistoricalTrafficData", + "name": "HistoricalTrafficData", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Reference", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "zhejuntest" + } + ], + "container": "container1", + "pathPattern": "{date}{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "compression": { + "type": "None" + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + }, + "etag": "8ffd285f-cc45-4a0a-9e0b-a7cfd7f7130c" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/asaClusterTest/inputs/input", + "name": "input", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "consumerGroupName": "1", + "eventHubName": "input", + "serviceBusNamespace": "azuremlbugbash", + "sharedAccessPolicyName": "inputpolicy", + "authenticationMode": "ConnectionString" + } + }, + "compression": { + "type": "None" + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + }, + "etag": "d62c06ad-343b-4631-81cc-2c63c4081869" + } + } + ], + "transformation": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/asaClusterTest/transformations/Transformation", + "name": "Transformation", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 3, + "query": "-- input refers to the alias of your event hub \r\n\r\nWITH  \r\n\r\nTripData AS ( \r\n\r\n    SELECT TRY_CAST(pickupLat AS float) as pickupLat, \r\n\r\n    TRY_CAST(pickupLon AS float) as pickupLon, \r\n\r\n    passengerCount, TripTimeinSeconds,  \r\n\r\n    pickupTime, VendorID, tripDistanceInMiles \r\n\r\n    FROM input timestamp by pickupTime \r\n\r\n    WHERE pickupLat > -90 AND pickupLat < 90 AND pickupLon > -180 AND pickupLon < 180 \r\n\r\n) \r\n\r\n \r\n\r\n--query 1 \r\n\r\nSELECT count(*), system.timestamp as timestamps \r\n\r\nINTO output \r\n\r\nFROM TripData \r\n\r\nGroup by hoppingwindow(second,60,5) \r\n\r\n \r\n\r\n \r\n\r\n--query 2 where HistoricalTrafficData is the alias of your reference data \r\n\r\nSELECT count(TripData.VendorID) as NbTrips, avg(TripData.passengerCount) as AvgPassenger, avg(TripData.TripTimeinSeconds) as TripTimeinSeconds, System.Timestamp as timestamps, TRY_CAST(HistoricalTrafficData.avgTraffic as bigint) as historicalTraffic \r\n\r\nINTO PBI \r\n\r\nFROM TripData \r\n\r\nJOIN HistoricalTrafficData ON \r\n\r\ndatepart(hour,TripData.pickupTime) = TRY_CAST(HistoricalTrafficData.hour as bigint) \r\n\r\nGroup By TripData.VendorID, HistoricalTrafficData.avgTraffic, hoppingwindow(second,60,5) ", + "etag": "cc14703e-4d5f-489c-97e4-adf75698b20d" + } + }, + "functions": [], + "outputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/asaClusterTest/outputs/output", + "name": "output", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "zhejuntest" + } + ], + "container": "output", + "pathPattern": "", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH", + "authenticationMode": "ConnectionString" + } + }, + "timeWindow": "01:59:00", + "sizeWindow": 1, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + }, + "etag": "3632dbc3-1a8c-49dc-838d-1f84b709c667" + } + } + ], + "etag": "ba6f6d8e-57e2-45bd-87ba-2b62c259bbcc", + "jobType": "Cloud", + "cluster": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/zhejunASA" + } + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/ASAUDFTest", + "name": "ASAUDFTest", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": {}, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "8b39d20f-d8df-42e0-8198-a20160e4696b", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Adjust", + "outputErrorPolicy": "Stop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2020-07-16T05:56:55.51Z", + "compatibilityLevel": "1.2", + "jobStorageAccount": { + "authenticationMode": "ConnectionString", + "accountName": "zhejuntest" + }, + "contentStoragePolicy": "SystemAccount", + "inputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/ASAUDFTest/inputs/Input", + "name": "Input", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "GatewayMessageBus" + }, + "compression": { + "type": "None" + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + }, + "etag": "34dcf5e8-d33e-4de3-b413-580fa9316f4b" + } + } + ], + "transformation": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/ASAUDFTest/transformations/Transformation", + "name": "Transformation", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": null, + "query": " SELECT machine.temperature, udf.ASAEdgeUDFDemo_Class1_SquareFunction(try_cast(machine.temperature as bigint))\r\n INTO Output\r\n FROM Input", + "etag": "29beb753-10cb-4627-91df-09dbfea9ac77" + } + }, + "functions": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/ASAUDFTest/functions/ASAEdgeUDFDemo_Class1_SquareFunction", + "name": "ASAEdgeUDFDemo_Class1_SquareFunction", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "any", + "isConfigurationParameter": null + } + ], + "output": { + "dataType": "any" + }, + "binding": { + "type": "Microsoft.StreamAnalytics/CLRUdf", + "properties": { + "dllPath": "ASAEdgeApplication2_CodeBehind", + "class": "ASAEdgeUDFDemo.Class1", + "method": "SquareFunction" + } + } + }, + "etag": "c3f6f31b-6b42-42c9-8cb1-1d12d6ab448a" + } + } + ], + "outputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/ASAUDFTest/outputs/Output", + "name": "Output", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "GatewayMessageBus" + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "Array" + } + }, + "etag": "c6ba3df6-13af-40af-992f-9317e8537590" + } + } + ], + "etag": "bfee3a7f-cdaf-4b1e-b449-71a3b8b4d6d9", + "jobType": "Edge", + "externals": { + "storageAccount": { + "accountName": "zhejuntest" + }, + "container": "container2", + "path": "UserCustomCode.zip" + }, + "cluster": null + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest", + "name": "zhejunmltest", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "aacee415-41d4-47f6-acf4-de9ae50175b0", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Adjust", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2020-07-17T08:36:07.463Z", + "compatibilityLevel": "1.2", + "jobStorageAccount": null, + "contentStoragePolicy": "SystemAccount", + "inputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/inputs/Input", + "name": "Input", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Devices/IotHubs", + "properties": { + "iotHubNamespace": "MyASAIoT", + "sharedAccessPolicyName": "iothubowner", + "endpoint": "messages/events", + "consumerGroupName": "$Default" + } + }, + "compression": { + "type": "None" + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + }, + "etag": "3cb574f7-b63a-4ac1-a1db-8e8a3b88a20d" + } + } + ], + "transformation": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/transformations/Transformation", + "name": "Transformation", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 3, + "query": "\r\nWITH sentiment AS ( \r\nSELECT Temperature, diabetespredict(Temperature) as result \r\nFROM Input \r\n) \r\n\r\nSELECT Temperature, result.[Score] \r\nINTO BlobOutput1\r\nFROM sentiment\r\n\r\n/*\r\nSELECT data, MLFunction2(data)\r\nFROM sampleRequestData\r\n*/\r\n/*\r\nSELECT data, AksArrayScore(data)\r\nFROM sampleData\r\n*/", + "etag": "7241d411-e71d-4205-b77e-4cc56aba34c0" + } + }, + "functions": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/functions/diabetespredict", + "name": "diabetespredict", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "array", + "isConfigurationParameter": null + } + ], + "output": { + "dataType": "float" + }, + "binding": { + "type": "Microsoft.MachineLearningServices", + "properties": { + "endpoint": "http://52.183.91.247/api/v1/service/aks-service-1/score", + "apiKey": null, + "inputs": [ + { + "name": "data", + "dataType": "array", + "mapTo": 0 + } + ], + "outputs": [ + { + "name": "output", + "dataType": "double", + "mapTo": 0 + } + ], + "batchSize": 1000, + "numberOfParallelRequests": 1 + } + } + }, + "etag": "acfdd307-418c-48f3-8856-7c176d38529f" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/functions/MLFunction2", + "name": "MLFunction2", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "array", + "isConfigurationParameter": null + } + ], + "output": { + "dataType": "float" + }, + "binding": { + "type": "Microsoft.MachineLearningServices", + "properties": { + "endpoint": "http://13.83.67.157/api/v1/service/nyc-fare-predict/score", + "apiKey": null, + "inputs": [ + { + "name": "data", + "dataType": "array", + "mapTo": 0 + } + ], + "outputs": [ + { + "name": "output", + "dataType": "double", + "mapTo": 0 + } + ], + "batchSize": 1000, + "numberOfParallelRequests": 1 + } + } + }, + "etag": "4d537fa6-f43c-4ee6-a45e-9a8f8002a65c" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/functions/MLFunction3", + "name": "MLFunction3", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "array", + "isConfigurationParameter": null + } + ], + "output": { + "dataType": "float" + }, + "binding": { + "type": "Microsoft.MachineLearningServices", + "properties": { + "endpoint": "http://52.183.91.247/api/v1/service/aks-service-1/score", + "apiKey": null, + "inputs": [ + { + "name": "data", + "dataType": "array", + "mapTo": 0 + } + ], + "outputs": [ + { + "name": "output", + "dataType": "double", + "mapTo": 0 + } + ], + "batchSize": 1000, + "numberOfParallelRequests": 1 + } + } + }, + "etag": "912f08e7-4a8c-46eb-afaf-d88f930a7b45" + } + } + ], + "outputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/outputs/BlobOutput1", + "name": "BlobOutput1", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "zhejuntest2" + } + ], + "container": "output", + "pathPattern": "{date}{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH", + "authenticationMode": "ConnectionString" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + }, + "etag": "1c271cd5-dd4a-4d3e-95ee-1dbcaa530c2c" + } + } + ], + "etag": "89ba3a42-e217-432e-bf23-798dbf001519", + "jobType": "Cloud", + "cluster": null + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_List_ByResourceGroup_NoExpand.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_List_ByResourceGroup_NoExpand.json new file mode 100644 index 000000000000..e56d3b9c58f8 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_List_ByResourceGroup_NoExpand.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/asaClusterTest", + "name": "asaClusterTest", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "hidden-link:/Microsoft.StreamAnalytics/streamingjobs/inputs/input": "{\"partitionCount\":2}" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "c5b86804-4b8e-4d99-885f-910ea24b51f4", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Adjust", + "outputErrorPolicy": "Stop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2020-07-15T03:41:25.7Z", + "compatibilityLevel": "1.2", + "jobStorageAccount": null, + "contentStoragePolicy": "SystemAccount", + "etag": "ba6f6d8e-57e2-45bd-87ba-2b62c259bbcc", + "jobType": "Cloud", + "cluster": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/zhejunASA" + } + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/ASAUDFTest", + "name": "ASAUDFTest", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": {}, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "8b39d20f-d8df-42e0-8198-a20160e4696b", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Adjust", + "outputErrorPolicy": "Stop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2020-07-16T05:56:55.51Z", + "compatibilityLevel": "1.2", + "jobStorageAccount": { + "authenticationMode": "ConnectionString", + "accountName": "zhejuntest" + }, + "contentStoragePolicy": "SystemAccount", + "etag": "bfee3a7f-cdaf-4b1e-b449-71a3b8b4d6d9", + "jobType": "Edge", + "externals": { + "storageAccount": { + "accountName": "zhejuntest" + }, + "container": "container2", + "path": "UserCustomCode.zip" + }, + "cluster": null + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest", + "name": "zhejunmltest", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "aacee415-41d4-47f6-acf4-de9ae50175b0", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Adjust", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2020-07-17T08:36:07.463Z", + "compatibilityLevel": "1.2", + "jobStorageAccount": null, + "contentStoragePolicy": "SystemAccount", + "etag": "89ba3a42-e217-432e-bf23-798dbf001519", + "jobType": "Cloud", + "cluster": null + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_List_BySubscription_Expand.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_List_BySubscription_Expand.json new file mode 100644 index 000000000000..bf17ca0995be --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_List_BySubscription_Expand.json @@ -0,0 +1,503 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "$expand": "inputs,outputs,transformation,functions" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/asaClusterTest", + "name": "asaClusterTest", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "hidden-link:/Microsoft.StreamAnalytics/streamingjobs/inputs/input": "{\"partitionCount\":2}" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "c5b86804-4b8e-4d99-885f-910ea24b51f4", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Adjust", + "outputErrorPolicy": "Stop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2020-07-15T03:41:25.7Z", + "compatibilityLevel": "1.2", + "jobStorageAccount": null, + "contentStoragePolicy": "SystemAccount", + "inputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/asaClusterTest/inputs/HistoricalTrafficData", + "name": "HistoricalTrafficData", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Reference", + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "zhejuntest" + } + ], + "container": "container1", + "pathPattern": "{date}{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH" + } + }, + "compression": { + "type": "None" + }, + "serialization": { + "type": "Csv", + "properties": { + "fieldDelimiter": ",", + "encoding": "UTF8" + } + }, + "etag": "8ffd285f-cc45-4a0a-9e0b-a7cfd7f7130c" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/asaClusterTest/inputs/input", + "name": "input", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "consumerGroupName": "1", + "eventHubName": "input", + "serviceBusNamespace": "azuremlbugbash", + "sharedAccessPolicyName": "inputpolicy", + "authenticationMode": "ConnectionString" + } + }, + "compression": { + "type": "None" + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + }, + "etag": "d62c06ad-343b-4631-81cc-2c63c4081869" + } + } + ], + "transformation": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/asaClusterTest/transformations/Transformation", + "name": "Transformation", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 3, + "query": "-- input refers to the alias of your event hub \r\n\r\nWITH  \r\n\r\nTripData AS ( \r\n\r\n    SELECT TRY_CAST(pickupLat AS float) as pickupLat, \r\n\r\n    TRY_CAST(pickupLon AS float) as pickupLon, \r\n\r\n    passengerCount, TripTimeinSeconds,  \r\n\r\n    pickupTime, VendorID, tripDistanceInMiles \r\n\r\n    FROM input timestamp by pickupTime \r\n\r\n    WHERE pickupLat > -90 AND pickupLat < 90 AND pickupLon > -180 AND pickupLon < 180 \r\n\r\n) \r\n\r\n \r\n\r\n--query 1 \r\n\r\nSELECT count(*), system.timestamp as timestamps \r\n\r\nINTO output \r\n\r\nFROM TripData \r\n\r\nGroup by hoppingwindow(second,60,5) \r\n\r\n \r\n\r\n \r\n\r\n--query 2 where HistoricalTrafficData is the alias of your reference data \r\n\r\nSELECT count(TripData.VendorID) as NbTrips, avg(TripData.passengerCount) as AvgPassenger, avg(TripData.TripTimeinSeconds) as TripTimeinSeconds, System.Timestamp as timestamps, TRY_CAST(HistoricalTrafficData.avgTraffic as bigint) as historicalTraffic \r\n\r\nINTO PBI \r\n\r\nFROM TripData \r\n\r\nJOIN HistoricalTrafficData ON \r\n\r\ndatepart(hour,TripData.pickupTime) = TRY_CAST(HistoricalTrafficData.hour as bigint) \r\n\r\nGroup By TripData.VendorID, HistoricalTrafficData.avgTraffic, hoppingwindow(second,60,5) ", + "etag": "cc14703e-4d5f-489c-97e4-adf75698b20d" + } + }, + "functions": [], + "outputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/asaClusterTest/outputs/output", + "name": "output", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "zhejuntest" + } + ], + "container": "output", + "pathPattern": "", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH", + "authenticationMode": "ConnectionString" + } + }, + "timeWindow": "01:59:00", + "sizeWindow": 1, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + }, + "etag": "3632dbc3-1a8c-49dc-838d-1f84b709c667" + } + } + ], + "etag": "ba6f6d8e-57e2-45bd-87ba-2b62c259bbcc", + "jobType": "Cloud", + "cluster": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/zhejunASA" + } + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/ASAUDFTest", + "name": "ASAUDFTest", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": {}, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "8b39d20f-d8df-42e0-8198-a20160e4696b", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Adjust", + "outputErrorPolicy": "Stop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2020-07-16T05:56:55.51Z", + "compatibilityLevel": "1.2", + "jobStorageAccount": { + "authenticationMode": "ConnectionString", + "accountName": "zhejuntest" + }, + "contentStoragePolicy": "SystemAccount", + "inputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/ASAUDFTest/inputs/Input", + "name": "Input", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "GatewayMessageBus" + }, + "compression": { + "type": "None" + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + }, + "etag": "34dcf5e8-d33e-4de3-b413-580fa9316f4b" + } + } + ], + "transformation": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/ASAUDFTest/transformations/Transformation", + "name": "Transformation", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": null, + "query": " SELECT machine.temperature, udf.ASAEdgeUDFDemo_Class1_SquareFunction(try_cast(machine.temperature as bigint))\r\n INTO Output\r\n FROM Input", + "etag": "29beb753-10cb-4627-91df-09dbfea9ac77" + } + }, + "functions": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/ASAUDFTest/functions/ASAEdgeUDFDemo_Class1_SquareFunction", + "name": "ASAEdgeUDFDemo_Class1_SquareFunction", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "any", + "isConfigurationParameter": null + } + ], + "output": { + "dataType": "any" + }, + "binding": { + "type": "Microsoft.StreamAnalytics/CLRUdf", + "properties": { + "dllPath": "ASAEdgeApplication2_CodeBehind", + "class": "ASAEdgeUDFDemo.Class1", + "method": "SquareFunction" + } + } + }, + "etag": "c3f6f31b-6b42-42c9-8cb1-1d12d6ab448a" + } + } + ], + "outputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/ASAUDFTest/outputs/Output", + "name": "Output", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "GatewayMessageBus" + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "Array" + } + }, + "etag": "c6ba3df6-13af-40af-992f-9317e8537590" + } + } + ], + "etag": "bfee3a7f-cdaf-4b1e-b449-71a3b8b4d6d9", + "jobType": "Edge", + "externals": { + "storageAccount": { + "accountName": "zhejuntest" + }, + "container": "container2", + "path": "UserCustomCode.zip" + }, + "cluster": null + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest", + "name": "zhejunmltest", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "aacee415-41d4-47f6-acf4-de9ae50175b0", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Adjust", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2020-07-17T08:36:07.463Z", + "compatibilityLevel": "1.2", + "jobStorageAccount": null, + "contentStoragePolicy": "SystemAccount", + "inputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/inputs/Input", + "name": "Input", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.Devices/IotHubs", + "properties": { + "iotHubNamespace": "MyASAIoT", + "sharedAccessPolicyName": "iothubowner", + "endpoint": "messages/events", + "consumerGroupName": "$Default" + } + }, + "compression": { + "type": "None" + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + }, + "etag": "3cb574f7-b63a-4ac1-a1db-8e8a3b88a20d" + } + } + ], + "transformation": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/transformations/Transformation", + "name": "Transformation", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 3, + "query": "\r\nWITH sentiment AS ( \r\nSELECT Temperature, diabetespredict(Temperature) as result \r\nFROM Input \r\n) \r\n\r\nSELECT Temperature, result.[Score] \r\nINTO BlobOutput1\r\nFROM sentiment\r\n\r\n/*\r\nSELECT data, MLFunction2(data)\r\nFROM sampleRequestData\r\n*/\r\n/*\r\nSELECT data, AksArrayScore(data)\r\nFROM sampleData\r\n*/", + "etag": "7241d411-e71d-4205-b77e-4cc56aba34c0" + } + }, + "functions": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/functions/diabetespredict", + "name": "diabetespredict", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "array", + "isConfigurationParameter": null + } + ], + "output": { + "dataType": "float" + }, + "binding": { + "type": "Microsoft.MachineLearningServices", + "properties": { + "endpoint": "http://52.183.91.247/api/v1/service/aks-service-1/score", + "apiKey": null, + "inputs": [ + { + "name": "data", + "dataType": "array", + "mapTo": 0 + } + ], + "outputs": [ + { + "name": "output", + "dataType": "double", + "mapTo": 0 + } + ], + "batchSize": 1000, + "numberOfParallelRequests": 1 + } + } + }, + "etag": "acfdd307-418c-48f3-8856-7c176d38529f" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/functions/MLFunction2", + "name": "MLFunction2", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "array", + "isConfigurationParameter": null + } + ], + "output": { + "dataType": "float" + }, + "binding": { + "type": "Microsoft.MachineLearningServices", + "properties": { + "endpoint": "http://13.83.67.157/api/v1/service/nyc-fare-predict/score", + "apiKey": null, + "inputs": [ + { + "name": "data", + "dataType": "array", + "mapTo": 0 + } + ], + "outputs": [ + { + "name": "output", + "dataType": "double", + "mapTo": 0 + } + ], + "batchSize": 1000, + "numberOfParallelRequests": 1 + } + } + }, + "etag": "4d537fa6-f43c-4ee6-a45e-9a8f8002a65c" + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/functions/MLFunction3", + "name": "MLFunction3", + "type": "Microsoft.StreamAnalytics/streamingjobs/functions", + "properties": { + "type": "Scalar", + "properties": { + "inputs": [ + { + "dataType": "array", + "isConfigurationParameter": null + } + ], + "output": { + "dataType": "float" + }, + "binding": { + "type": "Microsoft.MachineLearningServices", + "properties": { + "endpoint": "http://52.183.91.247/api/v1/service/aks-service-1/score", + "apiKey": null, + "inputs": [ + { + "name": "data", + "dataType": "array", + "mapTo": 0 + } + ], + "outputs": [ + { + "name": "output", + "dataType": "double", + "mapTo": 0 + } + ], + "batchSize": 1000, + "numberOfParallelRequests": 1 + } + } + }, + "etag": "912f08e7-4a8c-46eb-afaf-d88f930a7b45" + } + } + ], + "outputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest/outputs/BlobOutput1", + "name": "BlobOutput1", + "type": "Microsoft.StreamAnalytics/streamingjobs/outputs", + "properties": { + "datasource": { + "type": "Microsoft.Storage/Blob", + "properties": { + "storageAccounts": [ + { + "accountName": "zhejuntest2" + } + ], + "container": "output", + "pathPattern": "{date}{time}", + "dateFormat": "yyyy/MM/dd", + "timeFormat": "HH", + "authenticationMode": "ConnectionString" + } + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8", + "format": "LineSeparated" + } + }, + "etag": "1c271cd5-dd4a-4d3e-95ee-1dbcaa530c2c" + } + } + ], + "etag": "89ba3a42-e217-432e-bf23-798dbf001519", + "jobType": "Cloud", + "cluster": null + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_List_BySubscription_NoExpand.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_List_BySubscription_NoExpand.json new file mode 100644 index 000000000000..ba64bea75a82 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_List_BySubscription_NoExpand.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/asaClusterTest", + "name": "asaClusterTest", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "hidden-link:/Microsoft.StreamAnalytics/streamingjobs/inputs/input": "{\"partitionCount\":2}" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "c5b86804-4b8e-4d99-885f-910ea24b51f4", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Adjust", + "outputErrorPolicy": "Stop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2020-07-15T03:41:25.7Z", + "compatibilityLevel": "1.2", + "jobStorageAccount": null, + "contentStoragePolicy": "SystemAccount", + "etag": "ba6f6d8e-57e2-45bd-87ba-2b62c259bbcc", + "jobType": "Cloud", + "cluster": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/zhejunASA" + } + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/ASAUDFTest", + "name": "ASAUDFTest", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": {}, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "8b39d20f-d8df-42e0-8198-a20160e4696b", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Adjust", + "outputErrorPolicy": "Stop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2020-07-16T05:56:55.51Z", + "compatibilityLevel": "1.2", + "jobStorageAccount": { + "authenticationMode": "ConnectionString", + "accountName": "zhejuntest" + }, + "contentStoragePolicy": "SystemAccount", + "etag": "bfee3a7f-cdaf-4b1e-b449-71a3b8b4d6d9", + "jobType": "Edge", + "externals": { + "storageAccount": { + "accountName": "zhejuntest" + }, + "container": "container2", + "path": "UserCustomCode.zip" + }, + "cluster": null + } + }, + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/zhejunmltest", + "name": "zhejunmltest", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "aacee415-41d4-47f6-acf4-de9ae50175b0", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Adjust", + "outputErrorPolicy": "Drop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2020-07-17T08:36:07.463Z", + "compatibilityLevel": "1.2", + "jobStorageAccount": null, + "contentStoragePolicy": "SystemAccount", + "etag": "89ba3a42-e217-432e-bf23-798dbf001519", + "jobType": "Cloud", + "cluster": null + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Start_CustomTime.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Start_CustomTime.json new file mode 100644 index 000000000000..0e20a536d73b --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Start_CustomTime.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj59", + "startJobParameters": { + "outputStartMode": "CustomTime", + "outputStartTime": "2012-12-12T12:12:12Z" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Start_JobStartTime.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Start_JobStartTime.json new file mode 100644 index 000000000000..165fd2b75266 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Start_JobStartTime.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj59", + "startJobParameters": { + "outputStartMode": "JobStartTime" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Start_LastOutputEventTime.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Start_LastOutputEventTime.json new file mode 100644 index 000000000000..5be70fd3794f --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Start_LastOutputEventTime.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj59", + "startJobParameters": { + "outputStartMode": "LastOutputEventTime" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Stop.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Stop.json new file mode 100644 index 000000000000..bd959439dd1b --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Stop.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj59" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Update.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Update.json new file mode 100644 index 000000000000..4cdadcf92e28 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/StreamingJob_Update.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj59", + "streamingJob": { + "properties": { + "eventsOutOfOrderMaxDelayInSeconds": 21, + "eventsLateArrivalMaxDelayInSeconds": 13 + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "3e6872bc-c9d0-45b6-91b6-da66f1773056" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/abdasPartitionCountTags", + "name": "abdasPartitionCountTags", + "type": "Microsoft.StreamAnalytics/streamingjobs", + "location": "West US", + "tags": { + "hidden-link:/Microsoft.StreamAnalytics/streamingjobs/inputs/input": "{\"partitionCount\":1}" + }, + "properties": { + "sku": { + "name": "Standard" + }, + "jobId": "6d2b662c-a8b1-4a19-b3bb-8314adfa7ec3", + "provisioningState": "Succeeded", + "jobState": "Created", + "eventsOutOfOrderPolicy": "Adjust", + "outputErrorPolicy": "Stop", + "eventsOutOfOrderMaxDelayInSeconds": 0, + "eventsLateArrivalMaxDelayInSeconds": 5, + "dataLocale": "en-US", + "createdDate": "2020-07-10T18:03:00.21Z", + "compatibilityLevel": "1.2", + "jobStorageAccount": null, + "contentStoragePolicy": "SystemAccount", + "inputs": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/abdasPartitionCountTags/inputs/input", + "name": "input", + "type": "Microsoft.StreamAnalytics/streamingjobs/inputs", + "properties": { + "type": "Stream", + "datasource": { + "type": "Microsoft.ServiceBus/EventHub", + "properties": { + "consumerGroupName": "abdasPartitionCountTags_input_consumer_group", + "eventHubName": "anothereh", + "serviceBusNamespace": "another-new-ns", + "sharedAccessPolicyName": "abdasPartitionCountTags_input_policy", + "authenticationMode": "ConnectionString" + } + }, + "compression": { + "type": "None" + }, + "serialization": { + "type": "Json", + "properties": { + "encoding": "UTF8" + } + }, + "etag": "26fb1bf7-f153-4bb9-a1e8-5ca32d9489be" + } + } + ], + "transformation": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/abdasPartitionCountTags/transformations/Transformation", + "name": "Transformation", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 3, + "query": "SELECT\r\n *\r\nINTO\r\n [YourOutputAlias]\r\nFROM\r\n [YourInputAlias]", + "etag": "57f64482-3663-49d1-b29f-cd74a9a7e211" + } + }, + "functions": [], + "outputs": [], + "jobType": "Cloud", + "cluster": null + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_ListQuotas.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_ListQuotas.json new file mode 100644 index 000000000000..0b8dbdad3cc5 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Subscription_ListQuotas.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "location": "West US" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/providers/Microsoft.StreamAnalytics/locations/West US/quotas/StreamingUnits", + "name": "StreamingUnits", + "type": "Microsoft.StreamAnalytics/quotas", + "properties": { + "maxCount": 200, + "currentCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Transformation_Create.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Transformation_Create.json new file mode 100644 index 000000000000..865c80472b38 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Transformation_Create.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj8374", + "transformationName": "transformation952", + "transformation": { + "properties": { + "streamingUnits": 6, + "query": "Select Id, Name from inputtest" + } + } + }, + "responses": { + "201": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj8374/transformations/transformation952", + "name": "transformation952", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 6, + "query": "Select Id, Name from inputtest" + } + } + }, + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj8374/transformations/transformation952", + "name": "transformation952", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 6, + "query": "Select Id, Name from inputtest" + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Transformation_Get.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Transformation_Get.json new file mode 100644 index 000000000000..02d8fc5d7197 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Transformation_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj8374", + "transformationName": "transformation952" + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj8374/transformations/transformation952", + "name": "transformation952", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 6, + "query": "Select Id, Name from inputtest" + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Transformation_Update.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Transformation_Update.json new file mode 100644 index 000000000000..365598c160ca --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/examples/Transformation_Update.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2017-04-01-preview", + "subscriptionId": "56b5e0a9-b645-407d-99b0-c64f86013e3d", + "resourceGroupName": "sjrg", + "jobName": "sj8374", + "transformationName": "transformation952", + "transformation": { + "properties": { + "query": "New query" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "fc6f7a9b-3eea-4589-8265-cc854ec25f5a" + }, + "body": { + "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sj8374/transformations/transformation952", + "name": "transformation952", + "type": "Microsoft.StreamAnalytics/streamingjobs/transformations", + "properties": { + "streamingUnits": 6, + "query": "New query" + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json new file mode 100644 index 000000000000..b33a07742e00 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json @@ -0,0 +1,977 @@ +{ + "swagger": "2.0", + "info": { + "title": "StreamAnalyticsManagementClient", + "version": "2017-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions/{functionName}": { + "put": { + "tags": [ + "Functions" + ], + "operationId": "Functions_CreateOrReplace", + "description": "Creates a function or replaces an already existing function under an existing streaming job.", + "x-ms-examples": { + "Create an Azure ML function": { + "$ref": "./examples/Function_Create_AzureML.json" + }, + "Create a JavaScript function": { + "$ref": "./examples/Function_Create_JavaScript.json" + }, + "Create an Azure ML Service function": { + "$ref": "./examples/Function_Create_AzureMLService.json" + }, + "Create a CLRUdf function": { + "$ref": "./examples/Function_Create_CSharp.json" + } + }, + "parameters": [ + { + "name": "function", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Function" + }, + "description": "The definition of the function that will be used to create a new function or replace the existing one under the streaming job." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the function. Omit this value to always overwrite the current function. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new function to be created, but to prevent updating an existing function. Other values will result in a 412 Pre-condition Failed response." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/FunctionNameParameter" + } + ], + "responses": { + "200": { + "description": "The function was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/Function" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "201": { + "description": "The function was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/Function" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + } + } + }, + "patch": { + "tags": [ + "Functions" + ], + "operationId": "Functions_Update", + "description": "Updates an existing function under an existing streaming job. This can be used to partially update (ie. update one or two properties) a function without affecting the rest the job or function definition.", + "x-ms-examples": { + "Update an Azure ML function": { + "$ref": "./examples/Function_Update_AzureML.json" + }, + "Update a JavaScript function": { + "$ref": "./examples/Function_Update_JavaScript.json" + } + }, + "parameters": [ + { + "name": "function", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Function" + }, + "description": "A function object. The properties specified here will overwrite the corresponding properties in the existing function (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing function will remain the same and not change as a result of this PATCH operation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the function. Omit this value to always overwrite the current function. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/FunctionNameParameter" + } + ], + "responses": { + "200": { + "description": "The function was successfully updated.", + "schema": { + "$ref": "#/definitions/Function" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + } + } + }, + "delete": { + "tags": [ + "Functions" + ], + "operationId": "Functions_Delete", + "description": "Deletes a function from the streaming job.", + "x-ms-examples": { + "Delete a function": { + "$ref": "./examples/Function_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/FunctionNameParameter" + } + ], + "responses": { + "200": { + "description": "The function was successfully deleted." + }, + "204": { + "description": "The function does not exist." + } + } + }, + "get": { + "tags": [ + "Functions" + ], + "operationId": "Functions_Get", + "description": "Gets details about the specified function.", + "x-ms-examples": { + "Get an Azure ML function": { + "$ref": "./examples/Function_Get_AzureML.json" + }, + "Get a JavaScript function": { + "$ref": "./examples/Function_Get_JavaScript.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/FunctionNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified function.", + "schema": { + "$ref": "#/definitions/Function" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions": { + "get": { + "tags": [ + "Functions" + ], + "operationId": "Functions_ListByStreamingJob", + "description": "Lists all of the functions under the specified streaming job.", + "x-ms-examples": { + "List all functions in a streaming job": { + "$ref": "./examples/Function_ListByStreamingJob.json" + } + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "The $select OData query parameter. This is a comma-separated list of structural properties to include in the response, or \"*\" to include all properties. By default, all properties are returned except diagnostics. Currently only accepts '*' as a valid value." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully listed the functions under the specified streaming job.", + "schema": { + "$ref": "#/definitions/FunctionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions/{functionName}/test": { + "post": { + "tags": [ + "Functions" + ], + "operationId": "Functions_Test", + "description": "Tests if the information provided for a function is valid. This can range from testing the connection to the underlying web service behind the function or making sure the function code provided is syntactically correct.", + "x-ms-examples": { + "Test the connection for an Azure ML function": { + "$ref": "./examples/Function_Test_AzureML.json" + }, + "Test the connection for a JavaScript function": { + "$ref": "./examples/Function_Test_JavaScript.json" + } + }, + "parameters": [ + { + "name": "function", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/Function" + }, + "description": "If the function specified does not already exist, this parameter must contain the full function definition intended to be tested. If the function specified already exists, this parameter can be left null to test the existing function as is or if specified, the properties specified will overwrite the corresponding properties in the existing function (exactly like a PATCH operation) and the resulting function will be tested." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/FunctionNameParameter" + } + ], + "responses": { + "200": { + "description": "The test operation completed successfully.", + "schema": { + "$ref": "./inputs.json#/definitions/ResourceTestStatus" + } + }, + "202": { + "description": "The test request was successfully initiated." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions/{functionName}/RetrieveDefaultDefinition": { + "post": { + "tags": [ + "Functions" + ], + "operationId": "Functions_RetrieveDefaultDefinition", + "description": "Retrieves the default definition of a function based on the parameters specified.", + "x-ms-examples": { + "Retrieve the default definition for an Azure ML function": { + "$ref": "./examples/Function_RetrieveDefaultDefinition_AzureML.json" + } + }, + "parameters": [ + { + "name": "functionRetrieveDefaultDefinitionParameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/FunctionRetrieveDefaultDefinitionParameters" + }, + "description": "Parameters used to specify the type of function to retrieve the default definition for." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/FunctionNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the function's default definition.", + "schema": { + "$ref": "#/definitions/Function" + } + } + } + } + } + }, + "definitions": { + "Function": { + "description": "A function object, containing all information associated with the named function. All functions are contained under a streaming job.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/FunctionProperties", + "description": "The properties that are associated with a function." + } + } + }, + "FunctionProperties": { + "description": "The properties that are associated with a function.", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Indicates the type of function." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency." + }, + "properties": { + "$ref": "#/definitions/FunctionConfiguration", + "x-ms-client-flatten": true + } + }, + "required": [ + "type" + ] + }, + "FunctionConfiguration": { + "properties": { + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/FunctionInput" + } + }, + "output": { + "$ref": "#/definitions/FunctionOutput" + }, + "binding": { + "$ref": "#/definitions/FunctionBinding" + } + } + }, + "ScalarFunctionProperties": { + "description": "The properties that are associated with a scalar function.", + "x-ms-discriminator-value": "Scalar", + "allOf": [ + { + "$ref": "#/definitions/FunctionProperties" + } + ] + }, + "FunctionInput": { + "description": "Describes one input parameter of a function.", + "properties": { + "dataType": { + "type": "string", + "description": "The (Azure Stream Analytics supported) data type of the function input parameter. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx" + }, + "isConfigurationParameter": { + "type": "boolean", + "description": "A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false." + } + } + }, + "FunctionOutput": { + "description": "Describes the output of a function.", + "properties": { + "dataType": { + "type": "string", + "description": "The (Azure Stream Analytics supported) data type of the function output. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx" + } + } + }, + "FunctionBinding": { + "description": "The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint.", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Indicates the function binding type." + } + }, + "required": [ + "type" + ] + }, + "AzureMachineLearningStudioFunctionBinding": { + "description": "The binding to an Azure Machine Learning Studio.", + "x-ms-discriminator-value": "Microsoft.MachineLearning/WebService", + "allOf": [ + { + "$ref": "#/definitions/FunctionBinding" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AzureMachineLearningStudioFunctionBindingProperties", + "description": "The binding properties associated with an Azure Machine learning Studio.", + "x-ms-client-flatten": true + } + } + }, + "AzureMachineLearningStudioFunctionBindingProperties": { + "description": "The binding properties associated with an Azure Machine learning Studio.", + "properties": { + "endpoint": { + "type": "string", + "description": "The Request-Response execute endpoint of the Azure Machine Learning Studio. Find out more here: https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs" + }, + "apiKey": { + "type": "string", + "description": "The API key used to authenticate with Request-Response endpoint." + }, + "inputs": { + "$ref": "#/definitions/AzureMachineLearningStudioInputs", + "description": "The inputs for the Azure Machine Learning Studio endpoint." + }, + "outputs": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureMachineLearningStudioOutputColumn" + }, + "description": "A list of outputs from the Azure Machine Learning Studio endpoint execution." + }, + "batchSize": { + "type": "integer", + "format": "int32", + "description": "Number between 1 and 10000 describing maximum number of rows for every Azure ML RRS execute request. Default is 1000." + } + } + }, + "AzureMachineLearningStudioInputs": { + "description": "The inputs for the Azure Machine Learning Studio endpoint.", + "properties": { + "name": { + "type": "string", + "description": "The name of the input. This is the name provided while authoring the endpoint." + }, + "columnNames": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureMachineLearningStudioInputColumn" + }, + "description": "A list of input columns for the Azure Machine Learning Studio endpoint." + } + } + }, + "AzureMachineLearningStudioInputColumn": { + "description": "Describes an input column for the Azure Machine Learning Studio endpoint.", + "properties": { + "name": { + "type": "string", + "description": "The name of the input column." + }, + "dataType": { + "type": "string", + "description": "The (Azure Machine Learning supported) data type of the input column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx ." + }, + "mapTo": { + "type": "integer", + "format": "int32", + "description": "The zero based index of the function parameter this input maps to." + } + } + }, + "AzureMachineLearningStudioOutputColumn": { + "description": "Describes an output column for the Azure Machine Learning Studio endpoint.", + "properties": { + "name": { + "type": "string", + "description": "The name of the output column." + }, + "dataType": { + "type": "string", + "description": "The (Azure Machine Learning supported) data type of the output column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx ." + } + } + }, + "JavaScriptFunctionBinding": { + "description": "The binding to a JavaScript function.", + "x-ms-discriminator-value": "Microsoft.StreamAnalytics/JavascriptUdf", + "allOf": [ + { + "$ref": "#/definitions/FunctionBinding" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/JavaScriptFunctionBindingProperties", + "description": "The binding properties associated with a JavaScript function.", + "x-ms-client-flatten": true + } + } + }, + "JavaScriptFunctionBindingProperties": { + "description": "The binding properties associated with a JavaScript function.", + "properties": { + "script": { + "type": "string", + "description": "The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }'" + } + } + }, + "CSharpFunctionBinding": { + "description": "The binding to a CSharp function.", + "x-ms-discriminator-value": "Microsoft.StreamAnalytics/CLRUdf", + "allOf": [ + { + "$ref": "#/definitions/FunctionBinding" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CSharpFunctionBindingProperties", + "description": "The binding properties associated with a CSharp function.", + "x-ms-client-flatten": true + } + } + }, + "CSharpFunctionBindingProperties": { + "description": "The binding properties associated with a CSharp function.", + "properties": { + "script": { + "type": "string", + "description": "The Csharp code containing a single function definition." + }, + "dllPath": { + "type": "string", + "description": "The Csharp code containing a single function definition." + }, + "class": { + "type": "string", + "description": "The Csharp code containing a single function definition." + }, + "method": { + "type": "string", + "description": "The Csharp code containing a single function definition." + } + } + }, + "FunctionRetrieveDefaultDefinitionParameters": { + "description": "Parameters used to specify the type of function to retrieve the default definition for.", + "discriminator": "bindingType", + "properties": { + "bindingType": { + "type": "string", + "description": "Indicates the function binding type." + } + }, + "required": [ + "bindingType" + ] + }, + "AzureMachineLearningStudioFunctionRetrieveDefaultDefinitionParameters": { + "description": "The parameters needed to retrieve the default function definition for an Azure Machine Learning Studio function.", + "x-ms-discriminator-value": "Microsoft.MachineLearning/WebService", + "allOf": [ + { + "$ref": "#/definitions/FunctionRetrieveDefaultDefinitionParameters" + } + ], + "properties": { + "bindingRetrievalProperties": { + "$ref": "#/definitions/AzureMachineLearningStudioFunctionBindingRetrievalProperties", + "description": "The binding retrieval properties associated with an Azure Machine learning Studio.", + "x-ms-client-flatten": true + } + } + }, + "AzureMachineLearningStudioFunctionBindingRetrievalProperties": { + "description": "The binding retrieval properties associated with an Azure Machine learning Studio.", + "properties": { + "executeEndpoint": { + "type": "string", + "description": "The Request-Response execute endpoint of the Azure Machine Learning Studio. Find out more here: https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs" + }, + "udfType": { + "$ref": "#/definitions/UdfType", + "description": "The function type." + } + } + }, + "AzureMachineLearningServiceFunctionRetrieveDefaultDefinitionParameters": { + "description": "The parameters needed to retrieve the default function definition for an Azure Machine Learning web service function.", + "x-ms-discriminator-value": "Microsoft.MachineLearningServices", + "allOf": [ + { + "$ref": "#/definitions/FunctionRetrieveDefaultDefinitionParameters" + } + ], + "properties": { + "bindingRetrievalProperties": { + "$ref": "#/definitions/AzureMachineLearningServiceFunctionBindingRetrievalProperties", + "description": "The binding retrieval properties associated with an Azure Machine learning web service.", + "x-ms-client-flatten": true + } + } + }, + "AzureMachineLearningServiceFunctionBindingRetrievalProperties": { + "description": "The binding retrieval properties associated with an Azure Machine learning web service.", + "properties": { + "executeEndpoint": { + "type": "string", + "description": "The Request-Response execute endpoint of the Azure Machine Learning web service." + }, + "udfType": { + "$ref": "#/definitions/UdfType", + "description": "The function type." + } + } + }, + "JavaScriptFunctionRetrieveDefaultDefinitionParameters": { + "description": "The parameters needed to retrieve the default function definition for a JavaScript function.", + "x-ms-discriminator-value": "Microsoft.StreamAnalytics/JavascriptUdf", + "allOf": [ + { + "$ref": "#/definitions/FunctionRetrieveDefaultDefinitionParameters" + } + ], + "properties": { + "bindingRetrievalProperties": { + "$ref": "#/definitions/JavaScriptFunctionBindingRetrievalProperties", + "description": "The binding retrieval properties associated with a JavaScript function.", + "x-ms-client-flatten": true + } + } + }, + "JavaScriptFunctionBindingRetrievalProperties": { + "description": "The binding retrieval properties associated with a JavaScript function.", + "properties": { + "script": { + "type": "string", + "description": "The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }'." + }, + "udfType": { + "$ref": "#/definitions/UdfType", + "description": "The function type." + } + } + }, + "CSharpFunctionRetrieveDefaultDefinitionParameters": { + "description": "The parameters needed to retrieve the default function definition for a CSharp function.", + "x-ms-discriminator-value": "Microsoft.StreamAnalytics/CLRUdf", + "allOf": [ + { + "$ref": "#/definitions/FunctionRetrieveDefaultDefinitionParameters" + } + ], + "properties": { + "bindingRetrievalProperties": { + "$ref": "#/definitions/CSharpFunctionBindingRetrievalProperties", + "description": "The binding retrieval properties associated with a CSharp function.", + "x-ms-client-flatten": true + } + } + }, + "CSharpFunctionBindingRetrievalProperties": { + "description": "The binding retrieval properties associated with a CSharp function.", + "properties": { + "script": { + "type": "string", + "description": "The CSharp code containing a single function definition." + }, + "udfType": { + "$ref": "#/definitions/UdfType", + "description": "The function type." + } + } + }, + "AzureMachineLearningServiceFunctionBinding": { + "description": "The binding to an Azure Machine Learning web service.", + "x-ms-discriminator-value": "Microsoft.MachineLearningServices", + "allOf": [ + { + "$ref": "#/definitions/FunctionBinding" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AzureMachineLearningServiceFunctionBindingProperties", + "description": "The binding properties associated with an Azure Machine learning web service.", + "x-ms-client-flatten": true + } + } + }, + "AzureMachineLearningServiceFunctionBindingProperties": { + "description": "The binding properties associated with an Azure Machine learning web service.", + "properties": { + "endpoint": { + "type": "string", + "description": "The Request-Response execute endpoint of the Azure Machine Learning web service." + }, + "apiKey": { + "type": "string", + "description": "The API key used to authenticate with Request-Response endpoint." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureMachineLearningServiceInputColumn" + }, + "description": "The inputs for the Azure Machine Learning web service endpoint." + }, + "outputs": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureMachineLearningServiceOutputColumn" + }, + "description": "A list of outputs from the Azure Machine Learning web service endpoint execution." + }, + "batchSize": { + "type": "integer", + "format": "int32", + "description": "Number between 1 and 10000 describing maximum number of rows for every Azure ML RRS execute request. Default is 1000." + }, + "numberOfParallelRequests": { + "type": "integer", + "format": "int32", + "description": "The number of parallel requests that will be sent per partition of your job to the machine learning service. Default is 1." + } + } + }, + "AzureMachineLearningServiceInputs": { + "description": "The inputs for the Azure Machine Learning web service endpoint.", + "properties": { + "name": { + "type": "string", + "description": "The name of the input. This is the name provided while authoring the endpoint." + }, + "columnNames": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureMachineLearningServiceInputColumn" + }, + "description": "A list of input columns for the Azure Machine Learning web service endpoint." + } + } + }, + "AzureMachineLearningServiceInputColumn": { + "description": "Describes an input column for the Azure Machine Learning web service endpoint.", + "properties": { + "name": { + "type": "string", + "description": "The name of the input column." + }, + "dataType": { + "type": "string", + "description": "The (Azure Machine Learning supported) data type of the input column." + }, + "mapTo": { + "type": "integer", + "format": "int32", + "description": "The zero based index of the function parameter this input maps to." + } + } + }, + "AzureMachineLearningServiceOutputColumn": { + "description": "Describes an output column for the Azure Machine Learning web service endpoint.", + "properties": { + "name": { + "type": "string", + "description": "The name of the output column." + }, + "dataType": { + "type": "string", + "description": "The (Azure Machine Learning supported) data type of the output column." + }, + "mapTo": { + "type": "integer", + "format": "int32", + "description": "The zero based index of the function parameter this input maps to." + } + } + }, + "FunctionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Function" + }, + "readOnly": true, + "description": "A list of functions under a streaming job. Populated by a 'List' operation." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + }, + "description": "Object containing a list of functions under a streaming job." + }, + "UdfType": { + "type": "string", + "description": "The function type.", + "enum": [ + "Scalar" + ], + "x-ms-enum": { + "name": "UdfType", + "modelAsString": false + } + }, + "SubResource": { + "description": "The base sub-resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "x-ms-azure-resource": true + }, + "AggregateFunctionProperties": { + "description": "The properties that are associated with an aggregate function.", + "x-ms-discriminator-value": "Aggregate", + "allOf": [ + { + "$ref": "#/definitions/FunctionProperties" + } + ] + } + }, + "parameters": { + "FunctionNameParameter": { + "name": "functionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the function.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/inputs.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/inputs.json new file mode 100644 index 000000000000..51178cc6130c --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/inputs.json @@ -0,0 +1,1079 @@ +{ + "swagger": "2.0", + "info": { + "title": "StreamAnalyticsManagementClient", + "version": "2017-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/inputs/{inputName}": { + "put": { + "tags": [ + "Inputs" + ], + "operationId": "Inputs_CreateOrReplace", + "description": "Creates an input or replaces an already existing input under an existing streaming job.", + "x-ms-examples": { + "Create a reference blob input with CSV serialization": { + "$ref": "./examples/Input_Create_Reference_Blob_CSV.json" + }, + "Create a stream blob input with CSV serialization": { + "$ref": "./examples/Input_Create_Stream_Blob_CSV.json" + }, + "Create a stream Event Hub input with JSON serialization": { + "$ref": "./examples/Input_Create_Stream_EventHub_JSON.json" + }, + "Create a stream IoT Hub input with Avro serialization": { + "$ref": "./examples/Input_Create_Stream_IoTHub_Avro.json" + } + }, + "parameters": [ + { + "name": "input", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Input" + }, + "description": "The definition of the input that will be used to create a new input or replace the existing one under the streaming job." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the input. Omit this value to always overwrite the current input. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new input to be created, but to prevent updating an existing input. Other values will result in a 412 Pre-condition Failed response." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/InputNameParameter" + } + ], + "responses": { + "200": { + "description": "The input was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/Input" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "201": { + "description": "The input was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/Input" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + } + } + }, + "patch": { + "tags": [ + "Inputs" + ], + "operationId": "Inputs_Update", + "description": "Updates an existing input under an existing streaming job. This can be used to partially update (ie. update one or two properties) an input without affecting the rest the job or input definition.", + "x-ms-examples": { + "Update a reference blob input": { + "$ref": "./examples/Input_Update_Reference_Blob.json" + }, + "Update a stream blob input": { + "$ref": "./examples/Input_Update_Stream_Blob.json" + }, + "Update a stream Event Hub input": { + "$ref": "./examples/Input_Update_Stream_EventHub.json" + }, + "Update a stream IoT Hub input": { + "$ref": "./examples/Input_Update_Stream_IoTHub.json" + } + }, + "parameters": [ + { + "name": "input", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Input" + }, + "description": "An Input object. The properties specified here will overwrite the corresponding properties in the existing input (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing input will remain the same and not change as a result of this PATCH operation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the input. Omit this value to always overwrite the current input. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/InputNameParameter" + } + ], + "responses": { + "200": { + "description": "The input was successfully updated.", + "schema": { + "$ref": "#/definitions/Input" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + } + } + }, + "delete": { + "tags": [ + "Inputs" + ], + "operationId": "Inputs_Delete", + "description": "Deletes an input from the streaming job.", + "x-ms-examples": { + "Delete an input": { + "$ref": "./examples/Input_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/InputNameParameter" + } + ], + "responses": { + "200": { + "description": "The input was successfully deleted." + }, + "204": { + "description": "The input does not exist." + } + } + }, + "get": { + "tags": [ + "Inputs" + ], + "operationId": "Inputs_Get", + "description": "Gets details about the specified input.", + "x-ms-examples": { + "Get a reference blob input with CSV serialization": { + "$ref": "./examples/Input_Get_Reference_Blob_CSV.json" + }, + "Get a stream blob input with CSV serialization": { + "$ref": "./examples/Input_Get_Stream_Blob_CSV.json" + }, + "Get a stream Event Hub input with JSON serialization": { + "$ref": "./examples/Input_Get_Stream_EventHub_JSON.json" + }, + "Get a stream IoT Hub input with Avro serialization": { + "$ref": "./examples/Input_Get_Stream_IoTHub_Avro.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/InputNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified input.", + "schema": { + "$ref": "#/definitions/Input" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/inputs": { + "get": { + "tags": [ + "Inputs" + ], + "operationId": "Inputs_ListByStreamingJob", + "description": "Lists all of the inputs under the specified streaming job.", + "x-ms-examples": { + "List all inputs in a streaming job": { + "$ref": "./examples/Input_ListByStreamingJob.json" + }, + "List all inputs in a streaming job and include diagnostic information using the $select OData query parameter": { + "$ref": "./examples/Input_ListByStreamingJob_Diagnostics.json" + } + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "The $select OData query parameter. This is a comma-separated list of structural properties to include in the response, or \"*\" to include all properties. By default, all properties are returned except diagnostics. Currently only accepts '*' as a valid value." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully listed the inputs under the specified streaming job.", + "schema": { + "$ref": "#/definitions/InputListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/inputs/{inputName}/test": { + "post": { + "tags": [ + "Inputs" + ], + "operationId": "Inputs_Test", + "description": "Tests whether an input’s datasource is reachable and usable by the Azure Stream Analytics service.", + "x-ms-examples": { + "Test the connection for an input": { + "$ref": "./examples/Input_Test.json" + } + }, + "parameters": [ + { + "name": "input", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/Input" + }, + "description": "If the input specified does not already exist, this parameter must contain the full input definition intended to be tested. If the input specified already exists, this parameter can be left null to test the existing input as is or if specified, the properties specified will overwrite the corresponding properties in the existing input (exactly like a PATCH operation) and the resulting input will be tested." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/InputNameParameter" + } + ], + "responses": { + "200": { + "description": "The test operation completed successfully.", + "schema": { + "$ref": "#/definitions/ResourceTestStatus" + } + }, + "202": { + "description": "The test request was successfully initiated." + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Input": { + "description": "An input object, containing all information associated with the named input. All inputs are contained under a streaming job.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/InputProperties", + "description": "The properties that are associated with an input. Required on PUT (CreateOrReplace) requests." + } + } + }, + "InputProperties": { + "description": "The properties that are associated with an input.", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests." + }, + "serialization": { + "$ref": "#/definitions/Serialization", + "description": "Describes how data from an input is serialized or how data is serialized when written to an output. Required on PUT (CreateOrReplace) requests." + }, + "diagnostics": { + "readOnly": true, + "$ref": "#/definitions/Diagnostics", + "description": "Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency." + }, + "compression": { + "$ref": "#/definitions/Compression" + }, + "partitionKey": { + "type": "string", + "description": "partitionKey Describes a key in the input data which is used for partitioning the input data" + } + }, + "required": [ + "type" + ] + }, + "StreamInputProperties": { + "description": "The properties that are associated with an input containing stream data.", + "x-ms-discriminator-value": "Stream", + "allOf": [ + { + "$ref": "#/definitions/InputProperties" + } + ], + "properties": { + "datasource": { + "$ref": "#/definitions/StreamInputDataSource", + "description": "Describes an input data source that contains stream data. Required on PUT (CreateOrReplace) requests." + } + } + }, + "ReferenceInputProperties": { + "description": "The properties that are associated with an input containing reference data.", + "x-ms-discriminator-value": "Reference", + "allOf": [ + { + "$ref": "#/definitions/InputProperties" + } + ], + "properties": { + "datasource": { + "$ref": "#/definitions/ReferenceInputDataSource", + "description": "Describes an input data source that contains reference data. Required on PUT (CreateOrReplace) requests." + } + } + }, + "StreamInputDataSource": { + "description": "Describes an input data source that contains stream data.", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests." + } + }, + "required": [ + "type" + ] + }, + "BlobStreamInputDataSource": { + "description": "Describes a blob input data source that contains stream data.", + "x-ms-discriminator-value": "Microsoft.Storage/Blob", + "allOf": [ + { + "$ref": "#/definitions/StreamInputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BlobStreamInputDataSourceProperties", + "description": "The properties that are associated with a blob input containing stream data. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "BlobStreamInputDataSourceProperties": { + "description": "The properties that are associated with a blob input containing stream data.", + "allOf": [ + { + "$ref": "#/definitions/BlobDataSourceProperties" + } + ], + "properties": { + "sourcePartitionCount": { + "type": "integer", + "format": "int32", + "description": "The partition count of the blob input data source. Range 1 - 256." + } + } + }, + "EventHubStreamInputDataSource": { + "description": "Describes an Event Hub input data source that contains stream data.", + "x-ms-discriminator-value": "Microsoft.ServiceBus/EventHub", + "allOf": [ + { + "$ref": "#/definitions/StreamInputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventHubStreamInputDataSourceProperties", + "description": "The properties that are associated with an Event Hub input containing stream data. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "EventHubV2StreamInputDataSource": { + "description": "Describes an Event Hub input data source that contains stream data.", + "x-ms-discriminator-value": "Microsoft.EventHub/EventHub", + "allOf": [ + { + "$ref": "#/definitions/StreamInputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventHubStreamInputDataSourceProperties", + "description": "The properties that are associated with an Event Hub input containing stream data. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "EventHubStreamInputDataSourceProperties": { + "description": "The properties that are associated with a Event Hub input containing stream data.", + "allOf": [ + { + "$ref": "#/definitions/EventHubDataSourceProperties" + } + ], + "properties": { + "consumerGroupName": { + "type": "string", + "description": "The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not specified, the input uses the Event Hub’s default consumer group." + } + } + }, + "IoTHubStreamInputDataSource": { + "description": "Describes an IoT Hub input data source that contains stream data.", + "x-ms-discriminator-value": "Microsoft.Devices/IotHubs", + "allOf": [ + { + "$ref": "#/definitions/StreamInputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/IoTHubStreamInputDataSourceProperties", + "description": "The properties that are associated with an IoT Hub input containing stream data. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "IoTHubStreamInputDataSourceProperties": { + "description": "The properties that are associated with a IoT Hub input containing stream data.", + "properties": { + "iotHubNamespace": { + "type": "string", + "description": "The name or the URI of the IoT Hub. Required on PUT (CreateOrReplace) requests." + }, + "sharedAccessPolicyName": { + "type": "string", + "description": "The shared access policy name for the IoT Hub. This policy must contain at least the Service connect permission. Required on PUT (CreateOrReplace) requests." + }, + "sharedAccessPolicyKey": { + "type": "string", + "description": "The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests." + }, + "consumerGroupName": { + "type": "string", + "description": "The name of an IoT Hub Consumer Group that should be used to read events from the IoT Hub. If not specified, the input uses the Iot Hub’s default consumer group." + }, + "endpoint": { + "type": "string", + "description": "The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.)." + } + } + }, + "ReferenceInputDataSource": { + "description": "Describes an input data source that contains reference data.", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests." + } + }, + "required": [ + "type" + ] + }, + "BlobReferenceInputDataSource": { + "description": "Describes a blob input data source that contains reference data.", + "x-ms-discriminator-value": "Microsoft.Storage/Blob", + "allOf": [ + { + "$ref": "#/definitions/ReferenceInputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BlobReferenceInputDataSourceProperties", + "description": "The properties that are associated with a blob input containing reference data. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "BlobReferenceInputDataSourceProperties": { + "description": "The properties that are associated with a blob input containing reference data.", + "allOf": [ + { + "$ref": "#/definitions/BlobDataSourceProperties" + } + ], + "properties": {} + }, + "BlobDataSourceProperties": { + "description": "The properties that are associated with a blob data source.", + "properties": { + "storageAccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "description": "A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests." + }, + "container": { + "type": "string", + "description": "The name of a container within the associated Storage account. This container contains either the blob(s) to be read from or written to. Required on PUT (CreateOrReplace) requests." + }, + "pathPattern": { + "type": "string", + "description": "The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a more detailed explanation and example." + }, + "dateFormat": { + "type": "string", + "description": "The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead." + }, + "timeFormat": { + "type": "string", + "description": "The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead." + } + } + }, + "StorageAccount": { + "description": "The properties that are associated with an Azure Storage account", + "properties": { + "accountName": { + "type": "string", + "description": "The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests." + }, + "accountKey": { + "type": "string", + "description": "The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests." + } + } + }, + "ServiceBusDataSourceProperties": { + "description": "The common properties that are associated with Service Bus data sources (Queues, Topics, Event Hubs, etc.).", + "properties": { + "serviceBusNamespace": { + "type": "string", + "description": "The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests." + }, + "sharedAccessPolicyName": { + "type": "string", + "description": "The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests." + }, + "sharedAccessPolicyKey": { + "type": "string", + "description": "The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests." + }, + "authenticationMode": { + "$ref": "../../common/v1/definitions.json#/definitions/AuthenticationMode", + "description": "Authentication Mode." + } + } + }, + "EventHubDataSourceProperties": { + "description": "The common properties that are associated with Event Hub data sources.", + "allOf": [ + { + "$ref": "#/definitions/ServiceBusDataSourceProperties" + } + ], + "properties": { + "eventHubName": { + "type": "string", + "description": "The name of the Event Hub. Required on PUT (CreateOrReplace) requests." + } + } + }, + "Diagnostics": { + "description": "Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention.", + "properties": { + "conditions": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticCondition" + }, + "description": "A collection of zero or more conditions applicable to the resource, or to the job overall, that warrant customer attention." + } + } + }, + "DiagnosticCondition": { + "description": "Condition applicable to the resource, or to the job overall, that warrant customer attention.", + "properties": { + "since": { + "readOnly": true, + "type": "string", + "description": "The UTC timestamp of when the condition started. Customers should be able to find a corresponding event in the ops log around this time." + }, + "code": { + "readOnly": true, + "type": "string", + "description": "The opaque diagnostic code." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "The human-readable message describing the condition in detail. Localized in the Accept-Language of the client request." + } + } + }, + "InputListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Input" + }, + "readOnly": true, + "description": "A list of inputs under a streaming job. Populated by a 'List' operation." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + }, + "description": "Object containing a list of inputs under a streaming job." + }, + "Serialization": { + "description": "Describes how data from an input is serialized or how data is serialized when written to an output.", + "discriminator": "type", + "properties": { + "type": { + "$ref": "#/definitions/EventSerializationType" + } + }, + "required": [ + "type" + ] + }, + "ParquetSerialization": { + "description": "Describes how data from an input is serialized or how data is serialized when written to an output in Parquet format.", + "x-ms-discriminator-value": "Parquet", + "allOf": [ + { + "$ref": "#/definitions/Serialization" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ParquetSerializationProperties", + "description": "The properties that are associated with the Parquet serialization type. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "ParquetSerializationProperties": { + "description": "The properties that are associated with the Parquet serialization type.", + "properties": {} + }, + "CustomClrSerialization": { + "description": "Describes how data from an input is serialized or how data is serialized when written to an output in custom format.", + "x-ms-discriminator-value": "CustomClr", + "allOf": [ + { + "$ref": "#/definitions/Serialization" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CustomClrSerializationProperties", + "description": "The properties that are associated with the CustomClr serialization type. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "CustomClrSerializationProperties": { + "description": "The properties that are associated with the CustomClr serialization type.", + "properties": { + "serializationDllPath": { + "type": "string", + "description": "The serialization library path." + }, + "serializationClassName": { + "type": "string", + "description": "The serialization class name." + } + } + }, + "CsvSerialization": { + "description": "Describes how data from an input is serialized or how data is serialized when written to an output in CSV format.", + "x-ms-discriminator-value": "Csv", + "allOf": [ + { + "$ref": "#/definitions/Serialization" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CsvSerializationProperties", + "description": "The properties that are associated with the CSV serialization type. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "CsvSerializationProperties": { + "description": "The properties that are associated with the CSV serialization type.", + "properties": { + "fieldDelimiter": { + "type": "string", + "description": "Specifies the delimiter that will be used to separate comma-separated value (CSV) records. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a list of supported values. Required on PUT (CreateOrReplace) requests." + }, + "encoding": { + "$ref": "#/definitions/Encoding", + "description": "Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. Required on PUT (CreateOrReplace) requests." + } + } + }, + "JsonSerialization": { + "description": "Describes how data from an input is serialized or how data is serialized when written to an output in JSON format.", + "x-ms-discriminator-value": "Json", + "allOf": [ + { + "$ref": "#/definitions/Serialization" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/JsonSerializationProperties", + "description": "The properties that are associated with the JSON serialization type. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "JsonSerializationProperties": { + "description": "The properties that are associated with the JSON serialization type.", + "properties": { + "encoding": { + "$ref": "#/definitions/Encoding", + "description": "Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. Required on PUT (CreateOrReplace) requests." + }, + "format": { + "$ref": "#/definitions/JsonOutputSerializationFormat", + "description": "This property only applies to JSON serialization of outputs only. It is not applicable to inputs. This property specifies the format of the JSON the output will be written in. The currently supported values are 'lineSeparated' indicating the output will be formatted by having each JSON object separated by a new line and 'array' indicating the output will be formatted as an array of JSON objects. Default value is 'lineSeparated' if left null." + } + } + }, + "AvroSerialization": { + "description": "Describes how data from an input is serialized or how data is serialized when written to an output in Avro format.", + "x-ms-discriminator-value": "Avro", + "allOf": [ + { + "$ref": "#/definitions/Serialization" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AvroSerializationProperties", + "description": "The properties that are associated with the Avro serialization type. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "AvroSerializationProperties": { + "description": "The properties that are associated with the Avro serialization type.", + "properties": {} + }, + "Encoding": { + "type": "string", + "description": "Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output.", + "enum": [ + "UTF8" + ], + "x-ms-enum": { + "name": "Encoding", + "modelAsString": true + } + }, + "JsonOutputSerializationFormat": { + "type": "string", + "description": "Specifies the format of the JSON the output will be written in. The currently supported values are 'lineSeparated' indicating the output will be formatted by having each JSON object separated by a new line and 'array' indicating the output will be formatted as an array of JSON objects.", + "enum": [ + "LineSeparated", + "Array" + ], + "x-ms-enum": { + "name": "JsonOutputSerializationFormat", + "modelAsString": true + } + }, + "ResourceTestStatus": { + "description": "Describes the status of the test operation along with error information, if applicable.", + "properties": { + "status": { + "readOnly": true, + "type": "string", + "description": "The status of the test operation." + }, + "error": { + "readOnly": true, + "$ref": "#/definitions/ErrorResponse", + "description": "Describes the error that occurred." + } + } + }, + "ErrorResponse": { + "description": "Describes the error that occurred.", + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "Error code associated with the error that occurred." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "Describes the error in detail." + } + } + }, + "SubResource": { + "description": "The base sub-resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "x-ms-azure-resource": true + }, + "Compression": { + "description": "Describes how input data is compressed", + "properties": { + "type": { + "type": "string" + } + }, + "required": [ + "type" + ] + }, + "Identity": { + "description": "Describes how identity is verified", + "properties": { + "tenantId": { + "type": "string" + }, + "principalId": { + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "AzureSqlReferenceInputDataSource": { + "description": "Describes an Azure SQL database reference input data source.", + "x-ms-discriminator-value": "Microsoft.Sql/Server/Database", + "allOf": [ + { + "$ref": "#/definitions/ReferenceInputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AzureSqlReferenceInputDataSourceProperties" + } + } + }, + "AzureSqlReferenceInputDataSourceProperties": { + "properties": { + "server": { + "description": "This element is associated with the datasource element. This is the name of the server that contains the database that will be written to.", + "type": "string" + }, + "database": { + "description": "This element is associated with the datasource element. This is the name of the database that output will be written to.", + "type": "string" + }, + "user": { + "description": "This element is associated with the datasource element. This is the user name that will be used to connect to the SQL Database instance.", + "type": "string" + }, + "password": { + "description": "This element is associated with the datasource element. This is the password that will be used to connect to the SQL Database instance.", + "type": "string" + }, + "table": { + "description": "This element is associated with the datasource element. The name of the table in the Azure SQL database..", + "type": "string" + }, + "refreshType": { + "description": "This element is associated with the datasource element. This element is of enum type. It indicates what kind of data refresh option do we want to use:Static/RefreshPeriodicallyWithFull/RefreshPeriodicallyWithDelta", + "type": "string" + }, + "refreshRate": { + "description": "This element is associated with the datasource element. This indicates how frequently the data will be fetched from the database. It is of DateTime format.", + "type": "string" + }, + "fullSnapshotQuery": { + "description": "This element is associated with the datasource element. This query is used to fetch data from the sql database.", + "type": "string" + }, + "deltaSnapshotQuery": { + "description": "This element is associated with the datasource element. This query is used to fetch incremental changes from the SQL database. To use this option, we recommend using temporal tables in Azure SQL Database.", + "type": "string" + } + } + }, + "EventSerializationType": { + "type": "string", + "description": "Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests.", + "enum": [ + "Csv", + "Avro", + "Json", + "CustomClr", + "Parquet" + ], + "x-ms-enum": { + "name": "EventSerializationType", + "modelAsString": true + } + } + }, + "parameters": { + "InputNameParameter": { + "name": "inputName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the input.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/operations.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/operations.json new file mode 100644 index 000000000000..1272302df934 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/operations.json @@ -0,0 +1,124 @@ +{ + "swagger": "2.0", + "info": { + "title": "StreamAnalyticsManagementClient", + "version": "2017-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.StreamAnalytics/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available Stream Analytics related operations.", + "x-ms-examples": { + "List available operations for the Stream Analytics resource provider": { + "$ref": "./examples/Operation_List.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully listed the available operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Stream Analytics operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of Stream Analytics operations supported by the Microsoft.StreamAnalytics resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Operation": { + "description": "A Stream Analytics REST API operation", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation being performed on this particular object.", + "type": "string", + "readOnly": true + }, + "display": { + "description": "Contains the localized display information for this particular operation / action.", + "readOnly": true, + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The localized friendly form of the resource type related to this action/operation.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The localized friendly description for the operation.", + "type": "string", + "readOnly": true + } + } + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/outputs.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/outputs.json new file mode 100644 index 000000000000..0e2134ff78df --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/outputs.json @@ -0,0 +1,1074 @@ +{ + "swagger": "2.0", + "info": { + "title": "StreamAnalyticsManagementClient", + "version": "2017-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/outputs/{outputName}": { + "put": { + "tags": [ + "Outputs" + ], + "operationId": "Outputs_CreateOrReplace", + "description": "Creates an output or replaces an already existing output under an existing streaming job.", + "x-ms-examples": { + "Create an Azure SQL database output": { + "$ref": "./examples/Output_Create_AzureSQL.json" + }, + "Create an Azure Table output": { + "$ref": "./examples/Output_Create_AzureTable.json" + }, + "Create a blob output with CSV serialization": { + "$ref": "./examples/Output_Create_Blob_CSV.json" + }, + "Create a DocumentDB output": { + "$ref": "./examples/Output_Create_DocumentDB.json" + }, + "Create an Event Hub output with JSON serialization": { + "$ref": "./examples/Output_Create_EventHub_JSON.json" + }, + "Create a Service Bus Queue output with Avro serialization": { + "$ref": "./examples/Output_Create_ServiceBusQueue_Avro.json" + }, + "Create a Service Bus Topic output with CSV serialization": { + "$ref": "./examples/Output_Create_ServiceBusTopic_CSV.json" + }, + "Create a Power BI output": { + "$ref": "./examples/Output_Create_PowerBI.json" + }, + "Create an Azure Data Lake Store output with JSON serialization": { + "$ref": "./examples/Output_Create_AzureDataLakeStore_JSON.json" + } + }, + "parameters": [ + { + "name": "output", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Output" + }, + "description": "The definition of the output that will be used to create a new output or replace the existing one under the streaming job." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the output. Omit this value to always overwrite the current output. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new output to be created, but to prevent updating an existing output. Other values will result in a 412 Pre-condition Failed response." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/OutputNameParameter" + } + ], + "responses": { + "200": { + "description": "The output was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/Output" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "201": { + "description": "The output was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/Output" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + } + } + }, + "patch": { + "tags": [ + "Outputs" + ], + "operationId": "Outputs_Update", + "description": "Updates an existing output under an existing streaming job. This can be used to partially update (ie. update one or two properties) an output without affecting the rest the job or output definition.", + "x-ms-examples": { + "Update an Azure SQL database output": { + "$ref": "./examples/Output_Update_AzureSQL.json" + }, + "Update an Azure Table output": { + "$ref": "./examples/Output_Update_AzureTable.json" + }, + "Update a blob output with CSV serialization": { + "$ref": "./examples/Output_Update_Blob.json" + }, + "Update a DocumentDB output": { + "$ref": "./examples/Output_Update_DocumentDB.json" + }, + "Update an Event Hub output with JSON serialization": { + "$ref": "./examples/Output_Update_EventHub.json" + }, + "Update a Service Bus Queue output with Avro serialization": { + "$ref": "./examples/Output_Update_ServiceBusQueue.json" + }, + "Update a Service Bus Topic output with CSV serialization": { + "$ref": "./examples/Output_Update_ServiceBusTopic.json" + }, + "Update a Power BI output": { + "$ref": "./examples/Output_Update_PowerBI.json" + }, + "Update an Azure Data Lake Store output with JSON serialization": { + "$ref": "./examples/Output_Update_AzureDataLakeStore.json" + } + }, + "parameters": [ + { + "name": "output", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Output" + }, + "description": "An Output object. The properties specified here will overwrite the corresponding properties in the existing output (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing output will remain the same and not change as a result of this PATCH operation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the output. Omit this value to always overwrite the current output. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/OutputNameParameter" + } + ], + "responses": { + "200": { + "description": "The output was successfully updated.", + "schema": { + "$ref": "#/definitions/Output" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + } + } + }, + "delete": { + "tags": [ + "Outputs" + ], + "operationId": "Outputs_Delete", + "description": "Deletes an output from the streaming job.", + "x-ms-examples": { + "Delete an output": { + "$ref": "./examples/Output_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/OutputNameParameter" + } + ], + "responses": { + "200": { + "description": "The output was successfully deleted." + }, + "204": { + "description": "The output does not exist." + } + } + }, + "get": { + "tags": [ + "Outputs" + ], + "operationId": "Outputs_Get", + "description": "Gets details about the specified output.", + "x-ms-examples": { + "Get an Azure SQL database output": { + "$ref": "./examples/Output_Get_AzureSQL.json" + }, + "Get an Azure Table output": { + "$ref": "./examples/Output_Get_AzureTable.json" + }, + "Get a blob output with CSV serialization": { + "$ref": "./examples/Output_Get_Blob_CSV.json" + }, + "Get a DocumentDB output": { + "$ref": "./examples/Output_Get_DocumentDB.json" + }, + "Get an Azure Data Warehouse output": { + "$ref": "./examples/Output_Get_DataWarehouse.json" + }, + "Get an Azure Function output": { + "$ref": "./examples/Output_Get_AzureFunction.json" + }, + "Get an Event Hub output with JSON serialization": { + "$ref": "./examples/Output_Get_EventHub_JSON.json" + }, + "Get a Service Bus Queue output with Avro serialization": { + "$ref": "./examples/Output_Get_ServiceBusQueue_Avro.json" + }, + "Get a Service Bus Topic output with CSV serialization": { + "$ref": "./examples/Output_Get_ServiceBusTopic_CSV.json" + }, + "Get a Power BI output": { + "$ref": "./examples/Output_Get_PowerBI.json" + }, + "Get an Azure Data Lake Store output with JSON serialization": { + "$ref": "./examples/Output_Get_AzureDataLakeStore_JSON.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/OutputNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified output.", + "schema": { + "$ref": "#/definitions/Output" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/outputs": { + "get": { + "tags": [ + "Outputs" + ], + "operationId": "Outputs_ListByStreamingJob", + "description": "Lists all of the outputs under the specified streaming job.", + "x-ms-examples": { + "List all outputs in a streaming job": { + "$ref": "./examples/Output_ListByStreamingJob.json" + } + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "The $select OData query parameter. This is a comma-separated list of structural properties to include in the response, or \"*\" to include all properties. By default, all properties are returned except diagnostics. Currently only accepts '*' as a valid value." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully listed the outputs under the specified streaming job.", + "schema": { + "$ref": "#/definitions/OutputListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/outputs/{outputName}/test": { + "post": { + "tags": [ + "Outputs" + ], + "operationId": "Outputs_Test", + "description": "Tests whether an output’s datasource is reachable and usable by the Azure Stream Analytics service.", + "x-ms-examples": { + "Test the connection for an output": { + "$ref": "./examples/Output_Test.json" + } + }, + "parameters": [ + { + "name": "output", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/Output" + }, + "description": "If the output specified does not already exist, this parameter must contain the full output definition intended to be tested. If the output specified already exists, this parameter can be left null to test the existing output as is or if specified, the properties specified will overwrite the corresponding properties in the existing output (exactly like a PATCH operation) and the resulting output will be tested." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/OutputNameParameter" + } + ], + "responses": { + "200": { + "description": "The test operation completed successfully.", + "schema": { + "$ref": "./inputs.json#/definitions/ResourceTestStatus" + } + }, + "202": { + "description": "The test request was successfully initiated." + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Output": { + "description": "An output object, containing all information associated with the named output. All outputs are contained under a streaming job.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/OutputProperties", + "description": "The properties that are associated with an output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "OutputProperties": { + "description": "The properties that are associated with an output.", + "properties": { + "datasource": { + "$ref": "#/definitions/OutputDataSource", + "description": "Describes the data source that output will be written to. Required on PUT (CreateOrReplace) requests." + }, + "timeWindow": { + "type": "string" + }, + "sizeWindow": { + "type": "number" + }, + "serialization": { + "$ref": "./inputs.json#/definitions/Serialization", + "description": "Describes how data from an input is serialized or how data is serialized when written to an output. Required on PUT (CreateOrReplace) requests." + }, + "diagnostics": { + "readOnly": true, + "$ref": "./inputs.json#/definitions/Diagnostics", + "description": "Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency." + } + } + }, + "OutputDataSource": { + "description": "Describes the data source that output will be written to.", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests." + } + }, + "required": [ + "type" + ] + }, + "BlobOutputDataSource": { + "description": "Describes a blob output data source.", + "x-ms-discriminator-value": "Microsoft.Storage/Blob", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BlobOutputDataSourceProperties", + "description": "The properties that are associated with a blob output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "BlobOutputDataSourceProperties": { + "description": "The properties that are associated with a blob output.", + "allOf": [ + { + "$ref": "./inputs.json#/definitions/BlobDataSourceProperties" + } + ], + "properties": { + "authenticationMode": { + "$ref": "../../common/v1/definitions.json#/definitions/AuthenticationMode", + "description": "Authentication Mode." + } + } + }, + "AzureTableOutputDataSource": { + "description": "Describes an Azure Table output data source.", + "x-ms-discriminator-value": "Microsoft.Storage/Table", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AzureTableOutputDataSourceProperties", + "description": "The properties that are associated with an Azure Table output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "AzureTableOutputDataSourceProperties": { + "description": "The properties that are associated with an Azure Table output.", + "properties": { + "accountName": { + "type": "string", + "description": "The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests." + }, + "accountKey": { + "type": "string", + "description": "The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests." + }, + "table": { + "type": "string", + "description": "The name of the Azure Table. Required on PUT (CreateOrReplace) requests." + }, + "partitionKey": { + "type": "string", + "description": "This element indicates the name of a column from the SELECT statement in the query that will be used as the partition key for the Azure Table. Required on PUT (CreateOrReplace) requests." + }, + "rowKey": { + "type": "string", + "description": "This element indicates the name of a column from the SELECT statement in the query that will be used as the row key for the Azure Table. Required on PUT (CreateOrReplace) requests." + }, + "columnsToRemove": { + "type": "array", + "items": { + "type": "string" + }, + "description": "If specified, each item in the array is the name of a column to remove (if present) from output event entities." + }, + "batchSize": { + "type": "integer", + "format": "int32", + "description": "The number of rows to write to the Azure Table at a time." + } + } + }, + "EventHubOutputDataSource": { + "description": "Describes an Event Hub output data source.", + "x-ms-discriminator-value": "Microsoft.ServiceBus/EventHub", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventHubOutputDataSourceProperties", + "description": "The properties that are associated with an Event Hub output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "EventHubV2OutputDataSource": { + "description": "Describes an Event Hub output data source.", + "x-ms-discriminator-value": "Microsoft.EventHub/EventHub", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventHubOutputDataSourceProperties", + "description": "The properties that are associated with an Event Hub output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "EventHubOutputDataSourceProperties": { + "description": "The properties that are associated with an Event Hub output.", + "allOf": [ + { + "$ref": "./inputs.json#/definitions/EventHubDataSourceProperties" + } + ], + "properties": { + "partitionKey": { + "type": "string", + "description": "The key/column that is used to determine to which partition to send event data." + }, + "propertyColumns": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AzureSqlDatabaseOutputDataSource": { + "description": "Describes an Azure SQL database output data source.", + "x-ms-discriminator-value": "Microsoft.Sql/Server/Database", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AzureSqlDatabaseOutputDataSourceProperties", + "description": "The properties that are associated with an Azure SQL database output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "AzureSqlDatabaseOutputDataSourceProperties": { + "description": "The properties that are associated with an Azure SQL database output.", + "allOf": [ + { + "$ref": "#/definitions/AzureSqlDatabaseDataSourceProperties" + } + ], + "properties": {} + }, + "AzureSynapseOutputDataSource": { + "description": "Describes an Azure Synapse output data source.", + "x-ms-discriminator-value": "Microsoft.Sql/Server/DataWarehouse", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AzureSynapseOutputDataSourceProperties", + "description": "The properties that are associated with an Azure Synapse output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "AzureSynapseOutputDataSourceProperties": { + "description": "The properties that are associated with an Azure Synapse output.", + "allOf": [ + { + "$ref": "#/definitions/AzureSynapseDataSourceProperties" + } + ], + "properties": {} + }, + "AzureSynapseDataSourceProperties": { + "description": "The properties that are associated with an Azure SQL database data source.", + "properties": { + "server": { + "type": "string", + "description": "The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests." + }, + "database": { + "type": "string", + "description": "The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests." + }, + "table": { + "type": "string", + "description": "The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests." + }, + "user": { + "type": "string", + "description": "The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests." + }, + "password": { + "type": "string", + "description": "The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests." + } + } + }, + "DocumentDbOutputDataSource": { + "description": "Describes a DocumentDB output data source.", + "x-ms-discriminator-value": "Microsoft.Storage/DocumentDB", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DocumentDbOutputDataSourceProperties", + "description": "The properties that are associated with a DocumentDB output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "DocumentDbOutputDataSourceProperties": { + "description": "The properties that are associated with a DocumentDB output.", + "properties": { + "accountId": { + "type": "string", + "description": "The DocumentDB account name or ID. Required on PUT (CreateOrReplace) requests." + }, + "accountKey": { + "type": "string", + "description": "The account key for the DocumentDB account. Required on PUT (CreateOrReplace) requests." + }, + "database": { + "type": "string", + "description": "The name of the DocumentDB database. Required on PUT (CreateOrReplace) requests." + }, + "collectionNamePattern": { + "type": "string", + "description": "The collection name pattern for the collections to be used. The collection name format can be constructed using the optional {partition} token, where partitions start from 0. See the DocumentDB section of https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for more information. Required on PUT (CreateOrReplace) requests." + }, + "partitionKey": { + "type": "string", + "description": "The name of the field in output events used to specify the key for partitioning output across collections. If 'collectionNamePattern' contains the {partition} token, this property is required to be specified." + }, + "documentId": { + "type": "string", + "description": "The name of the field in output events used to specify the primary key which insert or update operations are based on." + } + } + }, + "AzureFunctionOutputDataSource": { + "description": "Defines the metadata of AzureFunctionOutputDataSource", + "x-ms-discriminator-value": "Microsoft.AzureFunction", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AzureFunctionOutputDataSourceProperties", + "description": "The properties that are associated with a Azure Function output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "AzureFunctionOutputDataSourceProperties": { + "description": "The properties that are associated with a DocumentDB output.", + "properties": { + "functionAppName": { + "description": "The name of your Azure Functions app.", + "type": "string" + }, + "functionName": { + "description": "The name of the function in your Azure Functions app.", + "type": "string" + }, + "apiKey": { + "description": "If you want to use an Azure Function from another subscription, you can do so by providing the key to access your function.", + "type": "string" + }, + "maxBatchSize": { + "description": "A property that lets you set the maximum size for each output batch that's sent to your Azure function. The input unit is in bytes. By default, this value is 262,144 bytes (256 KB).", + "type": "number" + }, + "maxBatchCount": { + "description": "A property that lets you specify the maximum number of events in each batch that's sent to Azure Functions. The default value is 100.", + "type": "number" + } + } + }, + "ServiceBusQueueOutputDataSource": { + "description": "Describes a Service Bus Queue output data source.", + "x-ms-discriminator-value": "Microsoft.ServiceBus/Queue", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ServiceBusQueueOutputDataSourceProperties", + "description": "The properties that are associated with a Service Bus Queue output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "ServiceBusQueueOutputDataSourceProperties": { + "description": "The properties that are associated with a Service Bus Queue output.", + "allOf": [ + { + "$ref": "./inputs.json#/definitions/ServiceBusDataSourceProperties" + } + ], + "properties": { + "queueName": { + "type": "string", + "description": "The name of the Service Bus Queue. Required on PUT (CreateOrReplace) requests." + }, + "propertyColumns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A string array of the names of output columns to be attached to Service Bus messages as custom properties." + }, + "systemPropertyColumns": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ServiceBusTopicOutputDataSource": { + "description": "Describes a Service Bus Topic output data source.", + "x-ms-discriminator-value": "Microsoft.ServiceBus/Topic", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ServiceBusTopicOutputDataSourceProperties", + "description": "The properties that are associated with a Service Bus Topic output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "ServiceBusTopicOutputDataSourceProperties": { + "description": "The properties that are associated with a Service Bus Topic output.", + "allOf": [ + { + "$ref": "./inputs.json#/definitions/ServiceBusDataSourceProperties" + } + ], + "properties": { + "topicName": { + "type": "string", + "description": "The name of the Service Bus Topic. Required on PUT (CreateOrReplace) requests." + }, + "propertyColumns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A string array of the names of output columns to be attached to Service Bus messages as custom properties." + }, + "systemPropertyColumns": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "PowerBIOutputDataSource": { + "description": "Describes a Power BI output data source.", + "x-ms-discriminator-value": "PowerBI", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PowerBIOutputDataSourceProperties", + "description": "The properties that are associated with a Power BI output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "PowerBIOutputDataSourceProperties": { + "description": "The properties that are associated with a Power BI output.", + "allOf": [ + { + "$ref": "#/definitions/OAuthBasedDataSourceProperties" + } + ], + "properties": { + "dataset": { + "type": "string", + "description": "The name of the Power BI dataset. Required on PUT (CreateOrReplace) requests." + }, + "table": { + "type": "string", + "description": "The name of the Power BI table under the specified dataset. Required on PUT (CreateOrReplace) requests." + }, + "groupId": { + "type": "string", + "description": "The ID of the Power BI group." + }, + "groupName": { + "type": "string", + "description": "The name of the Power BI group. Use this property to help remember which specific Power BI group id was used." + }, + "authenticationMode": { + "$ref": "../../common/v1/definitions.json#/definitions/AuthenticationMode", + "description": "Authentication Mode." + } + } + }, + "AzureDataLakeStoreOutputDataSource": { + "description": "Describes an Azure Data Lake Store output data source.", + "x-ms-discriminator-value": "Microsoft.DataLake/Accounts", + "allOf": [ + { + "$ref": "#/definitions/OutputDataSource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AzureDataLakeStoreOutputDataSourceProperties", + "description": "The properties that are associated with an Azure Data Lake Store output. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "AzureDataLakeStoreOutputDataSourceProperties": { + "description": "The properties that are associated with an Azure Data Lake Store.", + "allOf": [ + { + "$ref": "#/definitions/OAuthBasedDataSourceProperties" + } + ], + "properties": { + "accountName": { + "type": "string", + "description": "The name of the Azure Data Lake Store account. Required on PUT (CreateOrReplace) requests." + }, + "tenantId": { + "type": "string", + "description": "The tenant id of the user used to obtain the refresh token. Required on PUT (CreateOrReplace) requests." + }, + "filePathPrefix": { + "type": "string", + "description": "The location of the file to which the output should be written to. Required on PUT (CreateOrReplace) requests." + }, + "dateFormat": { + "type": "string", + "description": "The date format. Wherever {date} appears in filePathPrefix, the value of this property is used as the date format instead." + }, + "timeFormat": { + "type": "string", + "description": "The time format. Wherever {time} appears in filePathPrefix, the value of this property is used as the time format instead." + }, + "authenticationMode": { + "$ref": "../../common/v1/definitions.json#/definitions/AuthenticationMode", + "description": "Authentication Mode." + } + } + }, + "OutputListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Output" + }, + "readOnly": true, + "description": "A list of outputs under a streaming job. Populated by a 'List' operation." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + }, + "description": "Object containing a list of outputs under a streaming job." + }, + "AzureSqlDatabaseDataSourceProperties": { + "description": "The properties that are associated with an Azure SQL database data source.", + "properties": { + "server": { + "type": "string", + "description": "The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests." + }, + "database": { + "type": "string", + "description": "The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests." + }, + "user": { + "type": "string", + "description": "The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests." + }, + "password": { + "type": "string", + "description": "The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests." + }, + "table": { + "type": "string", + "description": "The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests." + }, + "maxBatchCount": { + "type": "number", + "description": "Max Batch count for write to Sql database, the default value is 10,000. Optional on PUT requests." + }, + "maxWriterCount": { + "type": "number", + "description": "Max Write r count, currently only 1(single writer) and 0(based on query partition) are available. Optional on PUT requests." + }, + "authenticationMode": { + "$ref": "../../common/v1/definitions.json#/definitions/AuthenticationMode", + "description": "Authentication Mode." + } + } + }, + "OAuthBasedDataSourceProperties": { + "description": "The properties that are associated with data sources that use OAuth as their authentication model.", + "properties": { + "refreshToken": { + "type": "string", + "description": "A refresh token that can be used to obtain a valid access token that can then be used to authenticate with the data source. A valid refresh token is currently only obtainable via the Azure Portal. It is recommended to put a dummy string value here when creating the data source and then going to the Azure Portal to authenticate the data source which will update this property with a valid refresh token. Required on PUT (CreateOrReplace) requests." + }, + "tokenUserPrincipalName": { + "type": "string", + "description": "The user principal name (UPN) of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token." + }, + "tokenUserDisplayName": { + "type": "string", + "description": "The user display name of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token." + } + } + }, + "SubResource": { + "description": "The base sub-resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "OutputNameParameter": { + "name": "outputName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the output.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/streamingjobs.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/streamingjobs.json new file mode 100644 index 000000000000..b023c743b867 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/streamingjobs.json @@ -0,0 +1,789 @@ +{ + "swagger": "2.0", + "info": { + "title": "StreamAnalyticsManagementClient", + "version": "2017-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}": { + "put": { + "tags": [ + "StreamingJobs" + ], + "operationId": "StreamingJobs_CreateOrReplace", + "description": "Creates a streaming job or replaces an already existing streaming job.", + "x-ms-examples": { + "Create a streaming job shell (a streaming job with no inputs, outputs, transformation, or functions)": { + "$ref": "./examples/StreamingJob_Create_JobShell.json" + }, + "Create a complete streaming job (a streaming job with a transformation, at least 1 input and at least 1 output)": { + "$ref": "./examples/StreamingJob_Create_CompleteJob.json" + } + }, + "parameters": [ + { + "name": "streamingJob", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingJob" + }, + "description": "The definition of the streaming job that will be used to create a new streaming job or replace the existing one." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the streaming job. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new streaming job to be created, but to prevent updating an existing record set. Other values will result in a 412 Pre-condition Failed response." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + } + ], + "responses": { + "200": { + "description": "The streaming job was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/StreamingJob" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "201": { + "description": "The streaming job was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/StreamingJob" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "StreamingJobs" + ], + "operationId": "StreamingJobs_Update", + "description": "Updates an existing streaming job. This can be used to partially update (ie. update one or two properties) a streaming job without affecting the rest the job definition.", + "x-ms-examples": { + "Update a streaming job": { + "$ref": "./examples/StreamingJob_Update.json" + } + }, + "parameters": [ + { + "name": "streamingJob", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingJob" + }, + "description": "A streaming job object. The properties specified here will overwrite the corresponding properties in the existing streaming job (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing input will remain the same and not change as a result of this PATCH operation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the streaming job. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + } + ], + "responses": { + "200": { + "description": "The streaming job was successfully updated.", + "schema": { + "$ref": "#/definitions/StreamingJob" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + } + } + }, + "delete": { + "tags": [ + "StreamingJobs" + ], + "operationId": "StreamingJobs_Delete", + "description": "Deletes a streaming job.", + "x-ms-examples": { + "Delete a streaming job": { + "$ref": "./examples/StreamingJob_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + } + ], + "responses": { + "200": { + "description": "The streaming job was successfully deleted." + }, + "202": { + "description": "The delete request was successfully initiated." + }, + "204": { + "description": "The streaming job does not exist." + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "StreamingJobs" + ], + "operationId": "StreamingJobs_Get", + "description": "Gets details about the specified streaming job.", + "x-ms-examples": { + "Get a streaming job and do not use the $expand OData query parameter": { + "$ref": "./examples/StreamingJob_Get_NoExpand.json" + }, + "Get a streaming job and use the $expand OData query parameter to expand inputs, outputs, transformation, and functions": { + "$ref": "./examples/StreamingJob_Get_Expand.json" + } + }, + "parameters": [ + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The $expand OData query parameter. This is a comma-separated list of additional streaming job properties to include in the response, beyond the default set returned when this parameter is absent. The default set is all streaming job properties other than 'inputs', 'transformation', 'outputs', and 'functions'." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified streaming job.", + "schema": { + "$ref": "#/definitions/StreamingJob" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs": { + "get": { + "tags": [ + "StreamingJobs" + ], + "operationId": "StreamingJobs_ListByResourceGroup", + "description": "Lists all of the streaming jobs in the specified resource group.", + "x-ms-examples": { + "List all streaming jobs in a resource group and do not use the $expand OData query parameter": { + "$ref": "./examples/StreamingJob_List_ByResourceGroup_NoExpand.json" + }, + "List all streaming jobs in a resource group and use the $expand OData query parameter to expand inputs, outputs, transformation, and functions": { + "$ref": "./examples/StreamingJob_List_ByResourceGroup_Expand.json" + } + }, + "parameters": [ + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The $expand OData query parameter. This is a comma-separated list of additional streaming job properties to include in the response, beyond the default set returned when this parameter is absent. The default set is all streaming job properties other than 'inputs', 'transformation', 'outputs', and 'functions'." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully listed the streaming jobs under the specified resource group.", + "schema": { + "$ref": "#/definitions/StreamingJobListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StreamAnalytics/streamingjobs": { + "get": { + "tags": [ + "StreamingJobs" + ], + "operationId": "StreamingJobs_List", + "description": "Lists all of the streaming jobs in the given subscription.", + "x-ms-examples": { + "List all streaming jobs in a subscription and do not use the $expand OData query parameter": { + "$ref": "./examples/StreamingJob_List_BySubscription_NoExpand.json" + }, + "List all streaming jobs in a subscription and use the $expand OData query parameter to expand inputs, outputs, transformation, and functions": { + "$ref": "./examples/StreamingJob_List_BySubscription_Expand.json" + } + }, + "parameters": [ + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The $expand OData query parameter. This is a comma-separated list of additional streaming job properties to include in the response, beyond the default set returned when this parameter is absent. The default set is all streaming job properties other than 'inputs', 'transformation', 'outputs', and 'functions'." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully listed the streaming jobs under the given subscription.", + "schema": { + "$ref": "#/definitions/StreamingJobListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/start": { + "post": { + "tags": [ + "StreamingJobs" + ], + "operationId": "StreamingJobs_Start", + "description": "Starts a streaming job. Once a job is started it will start processing input events and produce output.", + "x-ms-examples": { + "Start a streaming job with CustomTime output start mode": { + "$ref": "./examples/StreamingJob_Start_CustomTime.json" + }, + "Start a streaming job with JobStartTime output start mode": { + "$ref": "./examples/StreamingJob_Start_JobStartTime.json" + }, + "Start a streaming job with LastOutputEventTime output start mode": { + "$ref": "./examples/StreamingJob_Start_LastOutputEventTime.json" + } + }, + "parameters": [ + { + "name": "startJobParameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/StartStreamingJobParameters" + }, + "description": "Parameters applicable to a start streaming job operation." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + } + ], + "responses": { + "200": { + "description": "The streaming job was successfully started." + }, + "202": { + "description": "The start streaming job request was successfully initiated." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/stop": { + "post": { + "tags": [ + "StreamingJobs" + ], + "operationId": "StreamingJobs_Stop", + "description": "Stops a running streaming job. This will cause a running streaming job to stop processing input events and producing output.", + "x-ms-examples": { + "Stop a streaming job": { + "$ref": "./examples/StreamingJob_Stop.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + } + ], + "responses": { + "200": { + "description": "The streaming job was successfully stopped." + }, + "202": { + "description": "The stop streaming job request was successfully initiated." + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "External": { + "description": "The storage account where the custom code artifacts are located.", + "properties": { + "storageAccount": { + "$ref": "./inputs.json#/definitions/StorageAccount" + }, + "container": { + "type": "string" + }, + "path": { + "type": "string" + } + } + }, + "OperationListResult": { + "description": "Result of the request to list Stream Analytics operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of Stream Analytics operations supported by the Microsoft.StreamAnalytics resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Operation": { + "description": "A Stream Analytics REST API operation", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation being performed on this particular object.", + "type": "string", + "readOnly": true + }, + "display": { + "description": "Contains the localized display information for this particular operation / action.", + "readOnly": true, + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The localized friendly form of the resource type related to this action/operation.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The localized friendly description for the operation.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "StreamingJob": { + "description": "A streaming job object, containing all information associated with the named streaming job.", + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StreamingJobProperties", + "description": "The properties that are associated with a streaming job. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "./inputs.json#/definitions/Identity", + "description": "Describes the system-assigned managed identity assigned to this job that can be used to authenticate with inputs and outputs." + } + } + }, + "StreamingJobProperties": { + "description": "The properties that are associated with a streaming job.", + "properties": { + "sku": { + "description": "Describes the SKU of the streaming job. Required on PUT (CreateOrReplace) requests.", + "$ref": "#/definitions/StreamingJobSku" + }, + "jobId": { + "readOnly": true, + "type": "string", + "description": "A GUID uniquely identifying the streaming job. This GUID is generated upon creation of the streaming job." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Describes the provisioning status of the streaming job." + }, + "jobState": { + "readOnly": true, + "type": "string", + "description": "Describes the state of the streaming job." + }, + "jobType": { + "type": "string", + "description": "Describes the type of the job. Valid modes are `Cloud` and 'Edge'.", + "enum": [ + "Cloud", + "Edge" + ], + "x-ms-enum": { + "name": "JobType", + "modelAsString": true + } + }, + "outputStartMode": { + "$ref": "#/definitions/OutputStartMode", + "description": "This property should only be utilized when it is desired that the job be started immediately upon creation. Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time." + }, + "outputStartTime": { + "type": "string", + "format": "date-time", + "description": "Value is either an ISO-8601 formatted time stamp that indicates the starting point of the output event stream, or null to indicate that the output event stream will start whenever the streaming job is started. This property must have a value if outputStartMode is set to CustomTime." + }, + "lastOutputEventTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Value is either an ISO-8601 formatted timestamp indicating the last output event time of the streaming job or null indicating that output has not yet been produced. In case of multiple outputs or multiple streams, this shows the latest value in that set." + }, + "eventsOutOfOrderPolicy": { + "$ref": "#/definitions/EventsOutOfOrderPolicy", + "description": "Indicates the policy to apply to events that arrive out of order in the input event stream." + }, + "outputErrorPolicy": { + "$ref": "#/definitions/OutputErrorPolicy", + "description": "Indicates the policy to apply to events that arrive at the output and cannot be written to the external storage due to being malformed (missing column values, column values of wrong type or size)." + }, + "eventsOutOfOrderMaxDelayInSeconds": { + "type": "integer", + "format": "int32", + "description": "The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order." + }, + "eventsLateArrivalMaxDelayInSeconds": { + "type": "integer", + "format": "int32", + "description": "The maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 to 1814399 (20.23:59:59 days) and -1 is used to specify wait indefinitely. If the property is absent, it is interpreted to have a value of -1." + }, + "dataLocale": { + "type": "string", + "description": "The data locale of the stream analytics job. Value should be the name of a supported .NET Culture from the set https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx. Defaults to 'en-US' if none specified." + }, + "compatibilityLevel": { + "$ref": "#/definitions/CompatibilityLevel", + "description": "Controls certain runtime behaviors of the streaming job." + }, + "createdDate": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Value is an ISO-8601 formatted UTC timestamp indicating when the streaming job was created." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "./inputs.json#/definitions/Input" + }, + "description": "A list of one or more inputs to the streaming job. The name property for each input is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual input." + }, + "transformation": { + "$ref": "./transformations.json#/definitions/Transformation", + "description": "Indicates the query and the number of streaming units to use for the streaming job. The name property of the transformation is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual transformation." + }, + "outputs": { + "type": "array", + "items": { + "$ref": "./outputs.json#/definitions/Output" + }, + "description": "A list of one or more outputs for the streaming job. The name property for each output is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual output." + }, + "functions": { + "type": "array", + "items": { + "$ref": "./functions.json#/definitions/Function" + }, + "description": "A list of one or more functions for the streaming job. The name property for each function is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual transformation." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "The current entity tag for the streaming job. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency." + }, + "jobStorageAccount": { + "$ref": "#/definitions/JobStorageAccount" + }, + "contentStoragePolicy": { + "readOnly": true, + "type": "string", + "description": "Valid values are JobStorageAccount and SystemAccount. If set to JobStorageAccount, this requires the user to also specify jobStorageAccount property. .", + "enum": [ + "SystemAccount", + "JobStorageAccount" + ], + "x-ms-enum": { + "name": "ContentStoragePolicy", + "modelAsString": true + } + }, + "externals": { + "$ref": "#/definitions/External", + "description": "The storage account where the custom code artifacts are located." + }, + "cluster": { + "$ref": "#/definitions/ClusterInfo", + "description": "The cluster which streaming jobs will run on." + } + } + }, + "ClusterInfo": { + "description": "The properties associated with a Stream Analytics cluster.", + "properties": { + "id": { + "description": "The resource id of cluster.", + "type": "string" + } + } + }, + "StreamingJobSku": { + "description": "The properties that are associated with a SKU.", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU. Required on PUT (CreateOrReplace) requests.", + "enum": [ + "Standard" + ], + "x-ms-enum": { + "name": "StreamingJobSkuName", + "modelAsString": true + } + } + } + }, + "StreamingJobListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingJob" + }, + "readOnly": true, + "description": "A list of streaming jobs. Populated by a 'List' operation." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + }, + "description": "Object containing a list of streaming jobs." + }, + "StartStreamingJobParameters": { + "description": "Parameters supplied to the Start Streaming Job operation.", + "properties": { + "outputStartMode": { + "$ref": "#/definitions/OutputStartMode", + "description": "Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time." + }, + "outputStartTime": { + "type": "string", + "format": "date-time", + "description": "Value is either an ISO-8601 formatted time stamp that indicates the starting point of the output event stream, or null to indicate that the output event stream will start whenever the streaming job is started. This property must have a value if outputStartMode is set to CustomTime." + } + } + }, + "OutputStartMode": { + "type": "string", + "description": "Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time.", + "enum": [ + "JobStartTime", + "CustomTime", + "LastOutputEventTime" + ], + "x-ms-enum": { + "name": "OutputStartMode", + "modelAsString": true + } + }, + "EventsOutOfOrderPolicy": { + "type": "string", + "description": "Indicates the policy to apply to events that arrive out of order in the input event stream.", + "enum": [ + "Adjust", + "Drop" + ], + "x-ms-enum": { + "name": "EventsOutOfOrderPolicy", + "modelAsString": true + } + }, + "OutputErrorPolicy": { + "type": "string", + "description": "Indicates the policy to apply to events that arrive at the output and cannot be written to the external storage due to being malformed (missing column values, column values of wrong type or size).", + "enum": [ + "Stop", + "Drop" + ], + "x-ms-enum": { + "name": "OutputErrorPolicy", + "modelAsString": true + } + }, + "CompatibilityLevel": { + "type": "string", + "description": "Controls certain runtime behaviors of the streaming job.", + "enum": [ + "1.0" + ], + "x-ms-enum": { + "name": "CompatibilityLevel", + "modelAsString": true + } + }, + "JobStorageAccount": { + "description": "The properties that are associated with an Azure Storage account with MSI", + "allOf": [ + { + "$ref": "./inputs.json#/definitions/StorageAccount" + } + ], + "properties": { + "authenticationMode": { + "$ref": "../../common/v1/definitions.json#/definitions/AuthenticationMode", + "description": "Authentication Mode." + } + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/subscriptions.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/subscriptions.json new file mode 100644 index 000000000000..e20939d8ed25 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/subscriptions.json @@ -0,0 +1,139 @@ +{ + "swagger": "2.0", + "info": { + "title": "StreamAnalyticsManagementClient", + "version": "2017-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.StreamAnalytics/locations/{location}/quotas": { + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_ListQuotas", + "description": "Retrieves the subscription's current quota information in a particular region.", + "x-ms-examples": { + "List subscription quota information in West US": { + "$ref": "./examples/Subscription_ListQuotas.json" + } + }, + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the subscription's quota information in the specified region.", + "schema": { + "$ref": "#/definitions/SubscriptionQuotasListResult" + } + } + } + } + } + }, + "definitions": { + "SubscriptionQuotasListResult": { + "description": "Result of the GetQuotas operation. It contains a list of quotas for the subscription in a particular region.", + "properties": { + "value": { + "description": "List of quotas for the subscription in a particular region.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SubscriptionQuota" + } + } + } + }, + "SubscriptionQuota": { + "description": "Describes the current quota for the subscription.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "description": "Describes the properties of the quota.", + "readOnly": true, + "properties": { + "maxCount": { + "description": "The max permitted usage of this resource.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "currentCount": { + "description": "The current usage of this resource.", + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "SubResource": { + "description": "The base sub-resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "x-ms-azure-resource": true + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/transformations.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/transformations.json new file mode 100644 index 000000000000..9543efbc90a1 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2017-04-01-preview/transformations.json @@ -0,0 +1,288 @@ +{ + "swagger": "2.0", + "info": { + "title": "StreamAnalyticsManagementClient", + "version": "2017-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/transformations/{transformationName}": { + "put": { + "tags": [ + "Transformations" + ], + "operationId": "Transformations_CreateOrReplace", + "description": "Creates a transformation or replaces an already existing transformation under an existing streaming job.", + "x-ms-examples": { + "Create a transformation": { + "$ref": "./examples/Transformation_Create.json" + } + }, + "parameters": [ + { + "name": "transformation", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Transformation" + }, + "description": "The definition of the transformation that will be used to create a new transformation or replace the existing one under the streaming job." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the transformation. Omit this value to always overwrite the current transformation. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new transformation to be created, but to prevent updating an existing transformation. Other values will result in a 412 Pre-condition Failed response." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/TransformationNameParameter" + } + ], + "responses": { + "200": { + "description": "The transformation was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/Transformation" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the transformation. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + }, + "201": { + "description": "The transformation was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/Transformation" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the transformation. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + } + } + }, + "patch": { + "tags": [ + "Transformations" + ], + "operationId": "Transformations_Update", + "description": "Updates an existing transformation under an existing streaming job. This can be used to partially update (ie. update one or two properties) a transformation without affecting the rest the job or transformation definition.", + "x-ms-examples": { + "Update a transformation": { + "$ref": "./examples/Transformation_Update.json" + } + }, + "parameters": [ + { + "name": "transformation", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Transformation" + }, + "description": "A Transformation object. The properties specified here will overwrite the corresponding properties in the existing transformation (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing transformation will remain the same and not change as a result of this PATCH operation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the transformation. Omit this value to always overwrite the current transformation. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/TransformationNameParameter" + } + ], + "responses": { + "200": { + "description": "The transformation was successfully updated.", + "schema": { + "$ref": "#/definitions/Transformation" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the transformation. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + } + } + }, + "get": { + "tags": [ + "Transformations" + ], + "operationId": "Transformations_Get", + "description": "Gets details about the specified transformation.", + "x-ms-examples": { + "Get a transformation": { + "$ref": "./examples/Transformation_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/StreamingJobNameParameter" + }, + { + "$ref": "#/parameters/TransformationNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified transformation.", + "schema": { + "$ref": "#/definitions/Transformation" + }, + "headers": { + "ETag": { + "description": "The current entity tag for the transformation. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string" + } + } + } + } + } + } + }, + "definitions": { + "Transformation": { + "description": "A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job.", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TransformationProperties", + "description": "The properties that are associated with a transformation. Required on PUT (CreateOrReplace) requests.", + "x-ms-client-flatten": true + } + } + }, + "TransformationProperties": { + "description": "The properties that are associated with a transformation.", + "properties": { + "streamingUnits": { + "type": "integer", + "format": "int32", + "description": "Specifies the number of streaming units that the streaming job uses." + }, + "query": { + "type": "string", + "description": "Specifies the query that will be run in the streaming job. You can learn more about the Stream Analytics Query Language (SAQL) here: https://msdn.microsoft.com/library/azure/dn834998 . Required on PUT (CreateOrReplace) requests." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "The current entity tag for the transformation. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency." + } + } + }, + "SubResource": { + "description": "The base sub-resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "TransformationNameParameter": { + "name": "transformationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the transformation.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/clusters.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/clusters.json new file mode 100644 index 000000000000..c06405bb7968 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/clusters.json @@ -0,0 +1,612 @@ +{ + "swagger": "2.0", + "info": { + "title": "StreamAnalyticsManagementClient", + "version": "2020-03-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/clusters/{clusterName}": { + "put": { + "tags": [ + "Clusters" + ], + "description": "Creates a Stream Analytics Cluster or replaces an already existing cluster.", + "operationId": "Clusters_CreateOrUpdate", + "x-ms-examples": { + "Create a new cluster": { + "$ref": "./examples/Cluster_Create.json" + } + }, + "parameters": [ + { + "name": "cluster", + "description": "The definition of the cluster that will be used to create a new cluster or replace the existing one.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/IfMatchHeader" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/IfNoneMatchHeader" + } + ], + "responses": { + "200": { + "description": "The cluster was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "201": { + "description": "The cluster was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Clusters" + ], + "description": "Updates an existing cluster. This can be used to partially update (ie. update one or two properties) a cluster without affecting the rest of the cluster definition.", + "operationId": "Clusters_Update", + "x-ms-examples": { + "Update a cluster": { + "$ref": "./examples/Cluster_Update.json" + } + }, + "parameters": [ + { + "name": "cluster", + "description": "The properties specified here will overwrite the corresponding properties in the existing cluster (ie. Those properties will be updated).", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/IfMatchHeader" + } + ], + "responses": { + "200": { + "description": "The cluster was successfully updated.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "The update request was successfully initiated." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Clusters" + ], + "description": "Gets information about the specified cluster.", + "operationId": "Clusters_Get", + "x-ms-examples": { + "Get a cluster": { + "$ref": "./examples/Cluster_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified cluster.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + }, + "delete": { + "tags": [ + "Clusters" + ], + "description": "Deletes the specified cluster.", + "operationId": "Clusters_Delete", + "x-ms-examples": { + "Delete a cluster": { + "$ref": "./examples/Cluster_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The cluster was successfully deleted." + }, + "202": { + "description": "The delete request was successfully initiated." + }, + "204": { + "description": "The cluster does not exist." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StreamAnalytics/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "description": "Lists all of the clusters in the given subscription.", + "operationId": "Clusters_ListBySubscription", + "x-ms-examples": { + "List the clusters in a subscription": { + "$ref": "./examples/Cluster_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully listed the clusters under the specified subscription.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "description": "Lists all of the clusters in the given resource group.", + "operationId": "Clusters_ListByResourceGroup", + "x-ms-examples": { + "List clusters in resource group": { + "$ref": "./examples/Cluster_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully listed the clusters under the specified resource group.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/clusters/{clusterName}/listStreamingJobs": { + "post": { + "tags": [ + "Clusters" + ], + "description": "Lists all of the streaming jobs in the given cluster.", + "operationId": "Clusters_ListStreamingJobs", + "x-ms-examples": { + "List all streaming jobs in cluster": { + "$ref": "./examples/Cluster_ListStreamingJobs.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully listed the streaming jobs in the specified cluster.", + "schema": { + "$ref": "#/definitions/ClusterJobListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Cluster": { + "description": "A Stream Analytics Cluster object", + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/ClusterSku" + }, + "etag": { + "description": "The current entity tag for the cluster. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "The properties associated with a Stream Analytics cluster.", + "$ref": "#/definitions/ClusterProperties" + } + } + }, + "ClusterProperties": { + "description": "The properties associated with a Stream Analytics cluster.", + "properties": { + "createdDate": { + "description": "The date this cluster was created.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "clusterId": { + "description": "Unique identifier for the cluster.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ClusterProvisioningState" + }, + "capacityAllocated": { + "description": "Represents the number of streaming units currently being used on the cluster.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "capacityAssigned": { + "description": "Represents the sum of the SUs of all streaming jobs associated with the cluster. If all of the jobs were running, this would be the capacity allocated.", + "type": "integer", + "format": "int32", + "readOnly": true + } + } + }, + "ClusterListResult": { + "description": "A list of clusters populated by a 'list' operation.", + "properties": { + "value": { + "description": "A list of clusters.", + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + }, + "readOnly": true + }, + "nextLink": { + "description": "The URL to fetch the next set of clusters.", + "type": "string", + "readOnly": true + } + } + }, + "ClusterJob": { + "description": "A streaming job.", + "properties": { + "id": { + "description": "Resource ID of the streaming job.", + "type": "string", + "readOnly": true + }, + "streamingUnits": { + "description": "The number of streaming units that are used by the streaming job.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "jobState": { + "$ref": "#/definitions/JobState" + } + } + }, + "ClusterJobListResult": { + "description": "A list of streaming jobs. Populated by a List operation.", + "properties": { + "value": { + "description": "A list of streaming jobs.", + "type": "array", + "items": { + "$ref": "#/definitions/ClusterJob" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "The URL to fetch the next set of streaming jobs.", + "readOnly": true + } + } + }, + "ClusterSku": { + "description": "The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests.", + "properties": { + "name": { + "description": "Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests.", + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "ClusterSkuName", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "The default SKU." + } + ] + } + }, + "capacity": { + "description": "Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests.", + "type": "integer", + "format": "int32", + "minimum": 36, + "maximum": 216 + } + } + }, + "ClusterProvisioningState": { + "description": "The status of the cluster provisioning. The three terminal states are: Succeeded, Failed and Canceled", + "readOnly": true, + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "InProgress" + ], + "x-ms-enum": { + "name": "ClusterProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Succeeded", + "description": "The cluster provisioning succeeded." + }, + { + "value": "Failed", + "description": "The cluster provisioning failed." + }, + { + "value": "Canceled", + "description": "The cluster provisioning was canceled." + }, + { + "value": "InProgress", + "description": "The cluster provisioning was inprogress." + } + ] + } + }, + "JobState": { + "description": "The current execution state of the streaming job.", + "type": "string", + "readOnly": true, + "enum": [ + "Created", + "Starting", + "Running", + "Stopping", + "Stopped", + "Deleting", + "Failed", + "Degraded", + "Restarting", + "Scaling" + ], + "x-ms-enum": { + "name": "JobState", + "modelAsString": true, + "values": [ + { + "value": "Created", + "description": "The job is currently in the Created state." + }, + { + "value": "Starting", + "description": "The job is currently in the Starting state." + }, + { + "value": "Running", + "description": "The job is currently in the Running state." + }, + { + "value": "Stopping", + "description": "The job is currently in the Stopping state." + }, + { + "value": "Stopped", + "description": "The job is currently in the Stopped state." + }, + { + "value": "Deleting", + "description": "The job is currently in the Deleting state." + }, + { + "value": "Failed", + "description": "The job is currently in the Failed state." + }, + { + "value": "Degraded", + "description": "The job is currently in the Degraded state." + }, + { + "value": "Restarting", + "description": "The job is currently in the Restarting state." + }, + { + "value": "Scaling", + "description": "The job is currently in the Scaling state." + } + ] + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_Create.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_Create.json new file mode 100644 index 000000000000..308a5ce95830 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_Create.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "sjrg", + "clusterName": "An Example Cluster", + "api-version": "2020-03-01", + "cluster": { + "location": "North US", + "tags": { + "key": "value" + }, + "sku": { + "name": "Default", + "capacity": 48 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/AnExampleStreamingCluster", + "name": "An Example Cluster", + "type": "Microsoft.StreamAnalytics/clusters", + "location": "North US", + "tags": { + "key": "value" + }, + "sku": { + "name": "Default", + "capacity": 48 + }, + "properties": { + "createdDate": "2020-01-25T01:00:00Z", + "clusterId": "B01C67EF-4739-4DDD-9FB2-427EB43DE839", + "provisioningState": "Succeeded", + "capacityAllocated": 0, + "capacityAssigned": 0 + }, + "etag": "F86B9B70-D5B1-451D-AFC8-0B42D4729B8C" + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/AnExampleStreamingCluster", + "name": "An Example Cluster", + "type": "Microsoft.StreamAnalytics/clusters", + "location": "North US", + "tags": { + "key": "value" + }, + "sku": { + "name": "Default", + "capacity": 48 + }, + "properties": { + "createdDate": "2020-01-25T01:00:00Z", + "clusterId": "B01C67EF-4739-4DDD-9FB2-427EB43DE839", + "provisioningState": "Succeeded", + "capacityAllocated": 0, + "capacityAssigned": 0 + }, + "etag": "F86B9B70-D5B1-451D-AFC8-0B42D4729B8C" + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_Delete.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_Delete.json new file mode 100644 index 000000000000..2bfbcd63c495 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "sjrg", + "clusterName": "testcluster", + "api-version": "2020-03-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_Get.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_Get.json new file mode 100644 index 000000000000..d9151089861c --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "sjrg", + "clusterName": "testcluster", + "api-version": "2020-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/AnExampleStreamingCluster", + "name": "An Example Cluster", + "type": "Microsoft.StreamAnalytics/clusters", + "location": "Central US", + "tags": { + "key": "value" + }, + "sku": { + "name": "Default", + "capacity": 96 + }, + "properties": { + "createdDate": "2020-01-25T01:00:00Z", + "clusterId": "B01C67EF-4739-4DDD-9FB2-427EB43DE839", + "provisioningState": "Succeeded", + "capacityAllocated": 48, + "capacityAssigned": 96 + }, + "etag": "F86B9B70-D5B1-451D-AFC8-0B42D4729B8C" + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_ListByResourceGroup.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_ListByResourceGroup.json new file mode 100644 index 000000000000..3bc8733d9133 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_ListByResourceGroup.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "sjrg", + "api-version": "2020-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/AnExampleStreamingCluster", + "name": "An Example Cluster", + "type": "Microsoft.StreamAnalytics/clusters", + "location": "Central US", + "tags": { + "key": "value" + }, + "sku": { + "name": "Default", + "capacity": 96 + }, + "properties": { + "createdDate": "2020-01-25T01:00:00Z", + "clusterId": "B01C67EF-4739-4DDD-9FB2-427EB43DE839", + "provisioningState": "Succeeded", + "capacityAllocated": 48, + "capacityAssigned": 96 + }, + "etag": "F86B9B70-D5B1-451D-AFC8-0B42D4729B8C" + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/ADifferentStreamingCluster", + "name": "A Different Cluster", + "type": "Microsoft.StreamAnalytics/clusters", + "location": "Central US", + "tags": { + "key": "value" + }, + "sku": { + "name": "Default", + "capacity": 96 + }, + "properties": { + "createdDate": "2020-01-25T01:00:00Z", + "clusterId": "B01C67EF-4739-4DDD-9FB2-427EB43DE839", + "provisioningState": "Succeeded", + "capacityAllocated": 48, + "capacityAssigned": 96 + }, + "etag": "G97C0C81-D5B1-451D-AFC8-0B42D4729B8C" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_ListBySubscription.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_ListBySubscription.json new file mode 100644 index 000000000000..b612acc8c5ab --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_ListBySubscription.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2020-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/AnExampleStreamingCluster", + "name": "An Example Cluster", + "type": "Microsoft.StreamAnalytics/clusters", + "location": "Central US", + "tags": { + "key": "value" + }, + "sku": { + "name": "Default", + "capacity": 96 + }, + "properties": { + "createdDate": "2020-01-25T01:00:00Z", + "clusterId": "B01C67EF-4739-4DDD-9FB2-427EB43DE839", + "provisioningState": "Succeeded", + "capacityAllocated": 48, + "capacityAssigned": 96 + }, + "etag": "F86B9B70-D5B1-451D-AFC8-0B42D4729B8C" + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/ADifferentStreamingCluster", + "name": "A Different Cluster", + "type": "Microsoft.StreamAnalytics/clusters", + "location": "Central US", + "tags": { + "key": "value" + }, + "sku": { + "name": "Default", + "capacity": 96 + }, + "properties": { + "createdDate": "2020-01-25T01:00:00Z", + "clusterId": "B01C67EF-4739-4DDD-9FB2-427EB43DE839", + "provisioningState": "Succeeded", + "capacityAllocated": 48, + "capacityAssigned": 96 + }, + "etag": "G97C0C81-D5B1-451D-AFC8-0B42D4729B8C" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_ListStreamingJobs.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_ListStreamingJobs.json new file mode 100644 index 000000000000..af0878044e31 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_ListStreamingJobs.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "sjrg", + "clusterName": "testcluster", + "api-version": "2020-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/microsoft.streamAnalytics/streamingjobs/AFilterSample", + "streamingUnits": 6, + "jobState": "Running" + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/microsoft.streamAnalytics/streamingjobs/AnotherFilterSample", + "streamingUnits": 1, + "jobState": "Stopped" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_Update.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_Update.json new file mode 100644 index 000000000000..631d277249e4 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/Cluster_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "sjrg", + "clusterName": "testcluster", + "api-version": "2020-03-01", + "cluster": { + "location": "Central US", + "sku": { + "capacity": 96 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/AnExampleStreamingCluster", + "name": "An Example Cluster", + "type": "Microsoft.StreamAnalytics/clusters", + "location": "Central US", + "tags": { + "key": "value" + }, + "sku": { + "name": "Default", + "capacity": 96 + }, + "properties": { + "createdDate": "2020-01-25T01:00:00Z", + "clusterId": "B01C67EF-4739-4DDD-9FB2-427EB43DE839", + "provisioningState": "Succeeded", + "capacityAllocated": 36, + "capacityAssigned": 48 + }, + "etag": "F86B9B70-D5B1-451D-AFC8-0B42D4729B8C" + } + }, + "202": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/PrivateEndpoint_Create.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/PrivateEndpoint_Create.json new file mode 100644 index 000000000000..977b24febe2f --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/PrivateEndpoint_Create.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "sjrg", + "clusterName": "testcluster", + "privateEndpointName": "testpe", + "api-version": "2020-03-01", + "privateEndpoint": { + "properties": { + "manualPrivateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/testcluster/privateEndpoints/AnExamplePrivateEndpoint", + "name": "An Example Private Endpoint", + "type": "Microsoft.StreamAnalytics/clusters/privateEndpoints", + "properties": { + "createdDate": "2020-03-01T01:00Z", + "manualPrivateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Awaiting approval", + "actionsRequired": "None" + } + } + } + ] + }, + "etag": "F86B9B70-D5B1-451D-AFC8-0B42D4729B8C" + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/testcluster/privateEndpoints/AnExamplePrivateEndpoint", + "name": "An Example Private Endpoint", + "type": "Microsoft.StreamAnalytics/clusters/privateEndpoints", + "properties": { + "createdDate": "2020-03-01T01:00Z", + "manualPrivateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Awaiting approval", + "actionsRequired": "None" + } + } + } + ] + }, + "etag": "F86B9B70-D5B1-451D-AFC8-0B42D4729B8C" + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/PrivateEndpoint_Delete.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/PrivateEndpoint_Delete.json new file mode 100644 index 000000000000..e219248ac76e --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/PrivateEndpoint_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "sjrg", + "clusterName": "testcluster", + "privateEndpointName": "testpe", + "api-version": "2020-03-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/PrivateEndpoint_Get.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/PrivateEndpoint_Get.json new file mode 100644 index 000000000000..0b3909921a47 --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/PrivateEndpoint_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "sjrg", + "clusterName": "testcluster", + "privateEndpointName": "testpe", + "api-version": "2020-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/testcluster/privateEndpoints/AnExamplePrivateEndpoint", + "name": "An Example Private Endpoint", + "type": "Microsoft.StreamAnalytics/clusters/privateEndpoints", + "properties": { + "createdDate": "2020-03-01T01:00Z", + "manualPrivateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "This connection request originated from Azure Stream Analytics cluster named \"testcluster\". Please approve this request to allow any Stream Analytics job running on that cluster to access this resource.", + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Awaiting approval", + "actionsRequired": "None" + } + } + } + ] + }, + "etag": "F86B9B70-D5B1-451D-AFC8-0B42D4729B8C" + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/PrivateEndpoint_ListByCluster.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/PrivateEndpoint_ListByCluster.json new file mode 100644 index 000000000000..b4d2fe7c6cfa --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/examples/PrivateEndpoint_ListByCluster.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "sjrg", + "clusterName": "testcluster", + "api-version": "2020-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/testcluster/privateEndpoints/AnExamplePrivateEndpoint", + "name": "An Example Private Endpoint", + "type": "Microsoft.StreamAnalytics/clusters/privateEndpoints", + "properties": { + "createdDate": "2020-03-01T01:00Z", + "manualPrivateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Awaiting approval", + "actionsRequired": "None" + } + } + } + ] + }, + "etag": "F86B9B70-D5B1-451D-AFC8-0B42D4729B8C" + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/testcluster/privateEndpoints/ADifferentPrivateEndpoint", + "name": "A Different Private Endpoint", + "type": "Microsoft.StreamAnalytics/clusters/privateEndpoints", + "properties": { + "createdDate": "2020-03-01T01:00Z", + "manualPrivateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Awaiting approval", + "actionsRequired": "None" + } + } + } + ] + }, + "etag": "G97C0C81-D5B1-451D-AFC8-0B42D4729B8C" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/privateEndpoints.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/privateEndpoints.json new file mode 100644 index 000000000000..f090e917309e --- /dev/null +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/preview/2020-03-01-preview/privateEndpoints.json @@ -0,0 +1,358 @@ +{ + "swagger": "2.0", + "info": { + "title": "StreamAnalyticsManagementClient", + "version": "2020-03-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/clusters/{clusterName}/privateEndpoints/{privateEndpointName}": { + "put": { + "tags": [ + "PrivateEndpoints" + ], + "description": "Creates a Stream Analytics Private Endpoint or replaces an already existing Private Endpoint.", + "operationId": "PrivateEndpoints_CreateOrUpdate", + "x-ms-examples": { + "Create a private endpoint": { + "$ref": "./examples/PrivateEndpoint_Create.json" + } + }, + "parameters": [ + { + "name": "privateEndpoint", + "description": "The definition of the private endpoint that will be used to create a new cluster or replace the existing one.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpoint" + } + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./clusters.json#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/IfMatchHeader" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/IfNoneMatchHeader" + } + ], + "responses": { + "200": { + "description": "The private endpoint was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/PrivateEndpoint" + } + }, + "201": { + "description": "The private endpoint was successfully created or replaced.", + "schema": { + "$ref": "#/definitions/PrivateEndpoint" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + }, + "get": { + "tags": [ + "PrivateEndpoints" + ], + "description": "Gets information about the specified Private Endpoint.", + "operationId": "PrivateEndpoints_Get", + "x-ms-examples": { + "Get a private endpoint": { + "$ref": "./examples/PrivateEndpoint_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./clusters.json#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified private endpoint.", + "schema": { + "$ref": "#/definitions/PrivateEndpoint" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + } + }, + "delete": { + "tags": [ + "PrivateEndpoints" + ], + "description": "Delete the specified private endpoint.", + "operationId": "PrivateEndpoints_Delete", + "x-ms-examples": { + "Delete a private endpoint": { + "$ref": "./examples/PrivateEndpoint_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./clusters.json#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The private endpoint was successfully deleted." + }, + "202": { + "description": "The delete request was successfully initiated." + }, + "204": { + "description": "The private endpoint does not exist." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/clusters/{clusterName}/privateEndpoints": { + "get": { + "tags": [ + "PrivateEndpoints" + ], + "description": "Lists the private endpoints in the cluster.", + "operationId": "PrivateEndpoints_ListByCluster", + "x-ms-examples": { + "Get the private endpoints in a cluster": { + "$ref": "./examples/PrivateEndpoint_ListByCluster.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./clusters.json#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully listed the private endpoints under the specified cluster.", + "schema": { + "$ref": "#/definitions/PrivateEndpointListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PrivateEndpoint": { + "description": "Complete information about the private endpoint.", + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "The properties associated with a private endpoint.", + "$ref": "#/definitions/PrivateEndpointProperties" + }, + "etag": { + "description": "Unique opaque string (generally a GUID) that represents the metadata state of the resource (private endpoint) and changes whenever the resource is updated. Required on PUT (CreateOrUpdate) requests.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateEndpointProperties": { + "description": "The properties associated with a private endpoint.", + "properties": { + "createdDate": { + "description": "The date when this private endpoint was created.", + "type": "string", + "readOnly": true + }, + "manualPrivateLinkServiceConnections": { + "description": "A list of connections to the remote resource. Immutable after it is set.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkServiceConnection" + } + } + } + }, + "PrivateLinkServiceConnection": { + "description": "A grouping of information about the connection to the remote resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Bag of properties defining a privatelinkServiceConnection.", + "$ref": "#/definitions/PrivateLinkServiceConnectionProperties" + } + } + }, + "PrivateLinkServiceConnectionProperties": { + "description": "Bag of properties defining a privatelinkServiceConnection.", + "properties": { + "privateLinkServiceId": { + "description": "The resource id of the private link service. Required on PUT (CreateOrUpdate) requests.", + "type": "string" + }, + "groupIds": { + "description": "The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests.", + "type": "array", + "items": { + "type": "string" + } + }, + "requestMessage": { + "description": "A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.", + "type": "string" + }, + "privateLinkServiceConnectionState": { + "description": "A collection of read-only information about the state of the connection to the private remote resource.", + "$ref": "#/definitions/PrivateLinkConnectionState" + } + } + }, + "PrivateLinkConnectionState": { + "description": "A collection of read-only information about the state of the connection to the private remote resource.", + "properties": { + "status": { + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the remote resource/service.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The reason for approval/rejection of the connection.", + "type": "string", + "readOnly": true + }, + "actionsRequired": { + "description": "A message indicating if changes on the service provider require any updates on the consumer.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateEndpointListResult": { + "description": "A list of private endpoints.", + "properties": { + "value": { + "description": "A list of private endpoints.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpoint" + }, + "readOnly": true + }, + "nextLink": { + "description": "The URL to fetch the next set of private endpoints.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "PrivateEndpointNameParameter": { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/streamanalytics/resource-manager/readme.go.md b/specification/streamanalytics/resource-manager/readme.go.md index 443818eee8dd..59234232de73 100644 --- a/specification/streamanalytics/resource-manager/readme.go.md +++ b/specification/streamanalytics/resource-manager/readme.go.md @@ -13,14 +13,31 @@ go: ``` yaml $(go) && $(multiapi) batch: - - tag: package-2016-03 + - tag: package-2020-03-preview ``` -### Tag: package-2016-03 and go +### Tag: package-pure-2016-03 and go -These settings apply only when `--tag=package-2016-03 --go` is specified on the command line. +These settings apply only when `--tag=package-pure-2016-03 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag) == 'package-2016-03' && $(go) +``` yaml $(tag) == 'package-pure-2016-03' && $(go) output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2016-03-01/$(namespace) ``` + +### Tag: package-pure-2017-04-preview and go + +These settings apply only when `--tag=package-pure-2017-04-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-pure-2017-04-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2017-04-01-preview/$(namespace) +``` + +### Tag: package-2020-03-preview and go + +These settings apply only when `--tag=package-2020-03-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-03-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-03-01-preview/$(namespace) \ No newline at end of file diff --git a/specification/streamanalytics/resource-manager/readme.md b/specification/streamanalytics/resource-manager/readme.md index 70f57945aa29..da97ee0bb56d 100644 --- a/specification/streamanalytics/resource-manager/readme.md +++ b/specification/streamanalytics/resource-manager/readme.md @@ -4,10 +4,10 @@ This is the AutoRest configuration file for StreamAnalytics. - - --- + ## Getting Started + To build the SDK for StreamAnalytics, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -15,28 +15,75 @@ To build the SDK for StreamAnalytics, simply [Install AutoRest](https://aka.ms/a To see additional help and options, run: > `autorest --help` + --- ## Configuration - - ### Basic Information + These are the global settings for the StreamAnalytics API. ``` yaml title: Stream Analytics Management Client description: Stream Analytics Client openapi-type: arm -tag: package-2016-03 +tag: package-2020-03-preview ``` +### Tag: package-2020-03-preview + +These settings apply only when `--tag=package-2020-03-preview` is specified on the command line. + +This section contains the composite set of APIs. Stream Analytics Cluster and Private Endpoint related APIs are under 2020-03-01-preview version. Streamingjobs related APIs are under 2017-04-01-preview version. + +```yaml $(tag) == 'package-2020-03-preview' +input-file: + - Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json + - Microsoft.StreamAnalytics/preview/2017-04-01-preview/inputs.json + - Microsoft.StreamAnalytics/preview/2017-04-01-preview/outputs.json + - Microsoft.StreamAnalytics/preview/2017-04-01-preview/streamingjobs.json + - Microsoft.StreamAnalytics/preview/2017-04-01-preview/subscriptions.json + - Microsoft.StreamAnalytics/preview/2017-04-01-preview/transformations.json + - Microsoft.StreamAnalytics/preview/2017-04-01-preview/operations.json + - Microsoft.StreamAnalytics/preview/2020-03-01-preview/clusters.json + - Microsoft.StreamAnalytics/preview/2020-03-01-preview/privateEndpoints.json +``` + +### Tag: package-pure-2020-03-preview + +These settings apply only when `--tag=package-pure-2020-03-preview` is specified on the command line. + +This section only contains input swagger files for version 2020-03-01-preview, including Stream Analytics Cluster and Private Endpoint related APIs. + +```yaml $(tag) == 'package-pure-2020-03-preview' +input-file: + - Microsoft.StreamAnalytics/preview/2020-03-01-preview/clusters.json + - Microsoft.StreamAnalytics/preview/2020-03-01-preview/privateEndpoints.json +``` + +### Tag: package-pure-2017-04-preview + +These settings apply only when `--tag=package-pure-2017-04-preview` is specified on the command line. + +This section only contains input swagger files for version 2017-04-01-preview, including streamingjobs related APIs. + +```yaml $(tag) == 'package-pure-2017-04-preview' +input-file: + - Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json + - Microsoft.StreamAnalytics/preview/2017-04-01-preview/inputs.json + - Microsoft.StreamAnalytics/preview/2017-04-01-preview/outputs.json + - Microsoft.StreamAnalytics/preview/2017-04-01-preview/streamingjobs.json + - Microsoft.StreamAnalytics/preview/2017-04-01-preview/subscriptions.json + - Microsoft.StreamAnalytics/preview/2017-04-01-preview/transformations.json + - Microsoft.StreamAnalytics/preview/2017-04-01-preview/operations.json +``` -### Tag: package-2016-03 +### Tag: package-pure-2016-03 -These settings apply only when `--tag=package-2016-03` is specified on the command line. +These settings apply only when `--tag=package-pure-2016-03` is specified on the command line. -``` yaml $(tag) == 'package-2016-03' +``` yaml $(tag) == 'package-pure-2016-03' input-file: - Microsoft.StreamAnalytics/stable/2016-03-01/streamingjobs.json - Microsoft.StreamAnalytics/stable/2016-03-01/inputs.json @@ -46,10 +93,9 @@ input-file: - Microsoft.StreamAnalytics/stable/2016-03-01/subscriptions.json ``` - --- -# Code Generation +# Code Generation ## Swagger to SDK @@ -70,7 +116,6 @@ swagger-to-sdk: - node sdkauto_afterscript.js streamanalytics/resource-manager ``` - ## C# These settings apply only when `--csharp` is specified on the command line. @@ -107,15 +152,15 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-streamanalytics ``` yaml $(java) && $(multiapi) batch: - - tag: package-2016-03 + - tag: package-2020-03-preview ``` -### Tag: package-2016-03 and java +### Tag: package-pure-2016-03 and java -These settings apply only when `--tag=package-2016-03 --java` is specified on the command line. +These settings apply only when `--tag=package-pure-2016-03 --java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. -``` yaml $(tag) == 'package-2016-03' && $(java) && $(multiapi) +``` yaml $(tag) == 'package-pure-2016-03' && $(java) && $(multiapi) java: namespace: com.microsoft.azure.management.streamanalytics.v2016_03_01 output-folder: $(azure-libraries-for-java-folder)/sdk/streamanalytics/mgmt-v2016_03_01 @@ -123,6 +168,31 @@ regenerate-manager: true generate-interface: true ``` +### Tag: package-pure-2017-04-preview and java + +These settings apply only when `--tag=package-pure-2017-04-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-pure-2017-04-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.streamanalytics.v2017_04_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/streamanalytics/mgmt-v2017_04_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2020-03-preview and java + +These settings apply only when `--tag=package-2020-03-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2020-03-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.streamanalytics.v2020_03_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/streamanalytics/mgmt-v2020_03_01_preview +regenerate-manager: true +generate-interface: true +``` # Suppression @@ -152,13 +222,16 @@ directive: where: $.definitions.SubscriptionQuota from: subscriptions.json reason: Need the “name” property to be writable on nested resources so that our RP can support a DEEP PUT scenario which at the time, ARM did not have a native way to support. + + - suppress: R3023 # Operations API must be implemented for '/providers/Microsoft.StreamAnalytics/operations'. + reason: Operations API under 2017-04-01-preview is the super-set of all RPs operations (across all API-versions). ``` ## AzureResourceSchema See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators +## Multi-API/Profile support for AutoRest v3 generators AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. @@ -179,11 +252,10 @@ input-file: ``` -If there are files that should not be in the `all-api-versions` set, +If there are files that should not be in the `all-api-versions` set, uncomment the `exclude-file` section below and add the file paths. ``` yaml $(tag) == 'all-api-versions' #exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json ``` - diff --git a/specification/streamanalytics/resource-manager/readme.python.md b/specification/streamanalytics/resource-manager/readme.python.md new file mode 100644 index 000000000000..9e43992844d1 --- /dev/null +++ b/specification/streamanalytics/resource-manager/readme.python.md @@ -0,0 +1,26 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.streamanalytics + package-name: azure-mgmt-streamanalytics + package-version: 0.1.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/streamanalytics/azure-mgmt-streamanalytics/azure/mgmt/streamanalytics +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/streamanalytics/azure-mgmt-streamanalytics \ No newline at end of file diff --git a/specification/streamanalytics/resource-manager/readme.ruby.md b/specification/streamanalytics/resource-manager/readme.ruby.md index 913b3d34fef8..ae73ffd1413d 100644 --- a/specification/streamanalytics/resource-manager/readme.ruby.md +++ b/specification/streamanalytics/resource-manager/readme.ruby.md @@ -12,15 +12,34 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: - - tag: package-2016-03 + - tag: package-2020-03-preview ``` -### Tag: package-2016-03 and ruby +### Tag: package-pure-2016-03 and ruby -These settings apply only when `--tag=package-2016-03 --ruby` is specified on the command line. +These settings apply only when `--tag=package-pure-2016-03 --ruby` is specified on the command line. Please also specify `--ruby-sdks-folder=`. -``` yaml $(tag) == 'package-2016-03' && $(ruby) +``` yaml $(tag) == 'package-pure-2016-03' && $(ruby) namespace: "Azure::StreamAnalytics::Mgmt::V2016_03_01" output-folder: $(ruby-sdks-folder)/management/azure_mgmt_stream_analytics/lib ``` + +### Tag: package-pure-2017-04-preview and ruby + +These settings apply only when `--tag=package-pure-2017-04-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-pure-2017-04-preview' && $(ruby) +namespace: "Azure::StreamAnalytics::Mgmt::V2017_04_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_stream_analytics/lib +``` + +### Tag: package-2020-03-preview and ruby + +These settings apply only when `--tag=package-2020-03-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-03-preview' && $(ruby) +namespace: "Azure::StreamAnalytics::Mgmt::V2020_03_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_stream_analytics/lib \ No newline at end of file From 4c0054d815c3ead4b4ef12350ee6379197d4be1a Mon Sep 17 00:00:00 2001 From: Xing Wu Date: Fri, 11 Sep 2020 09:53:05 -0700 Subject: [PATCH 044/164] Update batch sdk comments (#10517) --- custom-words.txt | 2 ++ .../stable/2020-03-01.11.0/BatchService.json | 7 ++++--- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/custom-words.txt b/custom-words.txt index 7f50f40e9f62..58407c721c65 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -583,6 +583,8 @@ fileservers fileshare Filestream filesystems +fileuploaderr +fileuploadout fileurl findsimilars findsquare diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-03-01.11.0/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-03-01.11.0/BatchService.json index 4cb90f36b1e5..166919d73a79 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2020-03-01.11.0/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-03-01.11.0/BatchService.json @@ -574,7 +574,7 @@ "Accounts" ], "operationId": "Account_ListPoolNodeCounts", - "description": "Gets the number of Compute Nodes in each state, grouped by Pool.", + "description": "Gets the number of Compute Nodes in each state, grouped by Pool. Note that the numbers returned may not always be up to date. If you need exact node counts, use a list query.", "x-ms-examples": { "NodeCountsPayload": { "$ref": "./examples/AccountListPoolNodeCounts.json" @@ -5875,7 +5875,7 @@ } }, "summary": "Gets the Task counts for the specified Job.", - "description": "Task counts provide a count of the Tasks by active, running or completed Task state, and a count of Tasks which succeeded or failed. Tasks in the preparing state are counted as running.", + "description": "Task counts provide a count of the Tasks by active, running or completed Task state, and a count of Tasks which succeeded or failed. Tasks in the preparing state are counted as running. Note that the numbers returned may not always be up to date. If you need exact task counts, use a list query.", "x-ms-request-id": "request-id", "parameters": [ { @@ -15822,7 +15822,8 @@ "destination", "uploadOptions" ], - "title": "A specification for uploading files from an Azure Batch Compute Node to another location after the Batch service has finished executing the Task process." + "title": "A specification for uploading files from an Azure Batch Compute Node to another location after the Batch service has finished executing the Task process.", + "description": "On every file uploads, Batch service writes two log files to the compute node, 'fileuploadout.txt' and 'fileuploaderr.txt'. These log files are used to learn more about a specific failure." }, "OutputFileDestination": { "properties": { From faf8e1c19e3b36e6d16622bf168369a838b04a7f Mon Sep 17 00:00:00 2001 From: yifalu <67350794+yifalu@users.noreply.github.com> Date: Fri, 11 Sep 2020 10:59:26 -0700 Subject: [PATCH 045/164] Changes for new api version sdk generate (#10685) --- specification/mariadb/resource-manager/readme.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/specification/mariadb/resource-manager/readme.md b/specification/mariadb/resource-manager/readme.md index b857b1dd4b6b..61fc6d377c47 100644 --- a/specification/mariadb/resource-manager/readme.md +++ b/specification/mariadb/resource-manager/readme.md @@ -28,7 +28,7 @@ These are the global settings for the MariaDB API. title: MariaDBManagementClient description: The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MariaDB resources including servers, databases, firewall rules, VNET rules, log files and configurations with new business model. openapi-type: arm -tag: package-2018-06-01 +tag: package-2020-01-01 ``` ### Tag: package-2018-06-01-preview @@ -85,6 +85,10 @@ These settings apply only when `--tag=package-2020-01-01` is specified on the co ``` yaml $(tag) == 'package-2020-01-01' input-file: - Microsoft.DBforMariaDB/stable/2018-06-01/mariadb.json +- Microsoft.DBforMariaDB/stable/2018-06-01/QueryPerformanceInsights.json +- Microsoft.DBforMariaDB/stable/2018-06-01/PerformanceRecommendations.json +- Microsoft.DBforMariaDB/stable/2018-06-01/PrivateEndpointConnections.json +- Microsoft.DBforMariaDB/stable/2018-06-01/PrivateLinkResources.json - Microsoft.DBforMariaDB/stable/2018-06-01/ServerSecurityAlertPolicies.json - Microsoft.DBforMariaDB/stable/2020-01-01/Servers.json ``` From ff5dc59e935931f74b081b645a767dadce3c22d1 Mon Sep 17 00:00:00 2001 From: Vishnu Priya Ananthu Sundaram Date: Fri, 11 Sep 2020 15:47:04 -0700 Subject: [PATCH 046/164] [Azure Stack] Updates to Azs.AzureBridge.Admin spec (#9035) * Cumulative commit message: commit adaabc1bd3b17d60f9ac39b4d95e7d0df60019ca Author: bganapa Date: Wed Mar 4 18:07:20 2020 -0800 Changing casing in resourcgroups to resourceGroups commit fb5e9ae972e454ad5a743803e904e0eb7b19e117 Author: bganapa Date: Wed Feb 26 14:00:37 2020 -0800 Update Readme.md to have $(this-folder)/ for the input-file commit 82343294a9676c37f14b2ece2dac8770a9cbb5c6 Author: bganapa Date: Sun Feb 9 17:11:33 2020 -0800 Fix-Renaming ResourceGroupParameter to ResourceGroupNameParmameter (#8345) * bug fixes and autorest config addition * Fix path, read-only properties and example * Fix model validation * Suppress camelcase warnings in Activation.json * Suppress RequiredPropertiesMissingInResourceModel * Suppress PathResoourceProviderNamePascalCase * Add default error response * Add 204 response for delete * Remove 404 and add 202 in examples * Fix model validation failures --- .../preview/2016-01-01/Activation.json | 74 +++++++++++++++++-- .../preview/2016-01-01/AzureBridge.json | 34 ++++----- .../preview/2016-01-01/DownloadedProduct.json | 41 +++++++--- .../preview/2016-01-01/Product.json | 32 +++++--- .../examples/Activation/Create.json | 6 +- .../examples/Activation/Delete.json | 5 +- .../2016-01-01/examples/Activation/Get.json | 5 +- .../2016-01-01/examples/Activation/List.json | 2 +- .../examples/DownloadedProduct/Delete.json | 4 +- .../examples/DownloadedProduct/Get.json | 5 +- .../examples/DownloadedProduct/List.json | 2 +- .../examples/DownloadedProduct/Put.json | 2 +- .../2016-01-01/examples/Product/Get.json | 5 +- .../2016-01-01/examples/Product/List.json | 2 +- .../2016-01-01/examples/Product/download.json | 5 +- .../azurebridge/readme.azsautogen.md | 11 +++ .../resource-manager/azurebridge/readme.md | 50 +++++++------ 17 files changed, 193 insertions(+), 92 deletions(-) create mode 100644 specification/azsadmin/resource-manager/azurebridge/readme.azsautogen.md diff --git a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/Activation.json b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/Activation.json index 40fcb50e2a3f..9508e24e10c3 100644 --- a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/Activation.json +++ b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/Activation.json @@ -10,7 +10,7 @@ "https" ], "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}/providers/Microsoft.AzureBridge.Admin/activations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureBridge.Admin/activations": { "get": { "x-ms-examples": { "Return product name.": { @@ -27,7 +27,7 @@ "$ref": "AzureBridge.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "AzureBridge.json#/parameters/ResourceGroupParameter" + "$ref": "AzureBridge.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "AzureBridge.json#/parameters/ApiVersionParameter" @@ -39,6 +39,12 @@ "schema": { "$ref": "#/definitions/ActivationResourcesPage" } + }, + "default": { + "description": "Default Response.", + "schema": { + "$ref": "#/definitions/ExtendedErrorInfo" + } } }, "produces": [ @@ -52,7 +58,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}/providers/Microsoft.AzureBridge.Admin/activations/{activationName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureBridge.Admin/activations/{activationName}": { "get": { "x-ms-examples": { "Return activation name.": { @@ -69,7 +75,7 @@ "$ref": "AzureBridge.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "AzureBridge.json#/parameters/ResourceGroupParameter" + "$ref": "AzureBridge.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "AzureBridge.json#/parameters/ActivationNameParameter" @@ -85,8 +91,11 @@ "$ref": "#/definitions/ActivationResource" } }, - "404": { - "description": "Not Found" + "default": { + "description": "Default Response.", + "schema": { + "$ref": "#/definitions/ExtendedErrorInfo" + } } }, "produces": [ @@ -112,7 +121,7 @@ "$ref": "AzureBridge.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "AzureBridge.json#/parameters/ResourceGroupParameter" + "$ref": "AzureBridge.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "AzureBridge.json#/parameters/ActivationNameParameter" @@ -130,6 +139,12 @@ "schema": { "$ref": "#/definitions/ActivationResource" } + }, + "default": { + "description": "Default Response.", + "schema": { + "$ref": "#/definitions/ExtendedErrorInfo" + } } }, "produces": [ @@ -155,7 +170,7 @@ "$ref": "AzureBridge.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "AzureBridge.json#/parameters/ResourceGroupParameter" + "$ref": "AzureBridge.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "AzureBridge.json#/parameters/ActivationNameParameter" @@ -170,6 +185,15 @@ "schema": { "$ref": "#/definitions/ActivationResource" } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Default Response.", + "schema": { + "$ref": "#/definitions/ExtendedErrorInfo" + } } }, "produces": [ @@ -243,6 +267,40 @@ "description": "URI to the next page." } } + }, + "ExtendedErrorInfo": { + "type": "object", + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDefinition", + "description": "The error details." + } + } + }, + "ErrorDefinition": { + "type": "object", + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Internal error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDefinition" + }, + "readOnly": true + } + } } }, "parameters": { diff --git a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/AzureBridge.json b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/AzureBridge.json index 7006ed80e3eb..fda858d423a4 100644 --- a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/AzureBridge.json +++ b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/AzureBridge.json @@ -33,6 +33,12 @@ "schema": { "$ref": "#/definitions/OperationList" } + }, + "default": { + "description": "Default Response.", + "schema": { + "$ref": "Activation.json#/definitions/ExtendedErrorInfo" + } } }, "produces": [ @@ -50,17 +56,14 @@ "type": "object", "properties": { "id": { - "readOnly": true, "description": "URI of the resource.", "type": "string" }, "name": { - "readOnly": true, "description": "Name of the resource.", "type": "string" }, "type": { - "readOnly": true, "description": "Type of resource.", "type": "string" }, @@ -361,8 +364,7 @@ }, "galleryPackageBlobSasUri": { "description": "The URI to the .azpkg file that provides information required for showing product in the gallery.", - "type": "string", - "readOnly": true + "type": "string" }, "productDetailsProperties": { "description": "Specifies additional properties describing the product.", @@ -401,8 +403,7 @@ }, "isSystemExtension": { "description": "Specifies if product is a Virtual Machine Extension.", - "type": "boolean", - "readOnly": true + "type": "boolean" }, "sourceBlob": { "description": "Specifies a download location where content can be downloaded from.", @@ -412,13 +413,11 @@ }, "supportMultipleExtensions": { "description": "Indicates if specified product supports multiple extensions.", - "type": "boolean", - "readOnly": true + "type": "boolean" }, "version": { "description": "Specifies product version.", - "type": "string", - "readOnly": true + "type": "string" }, "vmOsType": { "description": "Specifies operating system used by the product.", @@ -427,8 +426,7 @@ }, "vmScaleSetEnabled": { "description": "Indicates if virtual machine Scale Set is enabled in the specified product.", - "type": "boolean", - "readOnly": true + "type": "boolean" } } }, @@ -438,8 +436,7 @@ "properties": { "version": { "description": "Specifies product version.", - "type": "string", - "readOnly": true + "type": "string" }, "osDiskImage": { "description": "OS disk image used by product.", @@ -475,8 +472,7 @@ "properties": { "uri": { "description": "The URI.", - "type": "string", - "readOnly": true + "type": "string" } } }, @@ -559,9 +555,9 @@ "type": "string", "x-ms-parameter-location": "method" }, - "ResourceGroupParameter": { + "ResourceGroupNameParameter": { "description": "The resource group the resource is located under.", - "name": "resourceGroup", + "name": "resourceGroupName", "in": "path", "type": "string", "required": true, diff --git a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/DownloadedProduct.json b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/DownloadedProduct.json index 443b8e82072e..dd432ffef5b8 100644 --- a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/DownloadedProduct.json +++ b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/DownloadedProduct.json @@ -10,7 +10,7 @@ "https" ], "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}/providers/Microsoft.AzureBridge.Admin/activations/{activationName}/downloadedProducts": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureBridge.Admin/activations/{activationName}/downloadedProducts": { "get": { "x-ms-examples": { "Get a list of downloaded products.": { @@ -27,7 +27,7 @@ "$ref": "AzureBridge.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "AzureBridge.json#/parameters/ResourceGroupParameter" + "$ref": "AzureBridge.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "AzureBridge.json#/parameters/ActivationNameParameter" @@ -42,6 +42,12 @@ "schema": { "$ref": "#/definitions/DownloadedProductResourcesPage" } + }, + "default": { + "description": "Default Response.", + "schema": { + "$ref": "Activation.json#/definitions/ExtendedErrorInfo" + } } }, "produces": [ @@ -55,7 +61,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}/providers/Microsoft.AzureBridge.Admin/activations/{activationName}/downloadedProducts/{productName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureBridge.Admin/activations/{activationName}/downloadedProducts/{productName}": { "get": { "x-ms-examples": { "Gets the specified downloaded product.": { @@ -72,7 +78,7 @@ "$ref": "AzureBridge.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "AzureBridge.json#/parameters/ResourceGroupParameter" + "$ref": "AzureBridge.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "AzureBridge.json#/parameters/ActivationNameParameter" @@ -91,8 +97,11 @@ "$ref": "AzureBridge.json#/definitions/DownloadedProductResource" } }, - "404": { - "description": "Not Found" + "default": { + "description": "Default Response.", + "schema": { + "$ref": "Activation.json#/definitions/ExtendedErrorInfo" + } } }, "produces": [ @@ -118,7 +127,7 @@ "$ref": "AzureBridge.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "AzureBridge.json#/parameters/ResourceGroupParameter" + "$ref": "AzureBridge.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "AzureBridge.json#/parameters/ActivationNameParameter" @@ -143,8 +152,14 @@ "$ref": "AzureBridge.json#/definitions/DownloadedProductResource" } }, - "404": { - "description": "Not Found" + "204": { + "description": "No Content" + }, + "default": { + "description": "Default Response.", + "schema": { + "$ref": "Activation.json#/definitions/ExtendedErrorInfo" + } } }, "x-ms-long-running-operation": true, @@ -171,7 +186,7 @@ "$ref": "AzureBridge.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "AzureBridge.json#/parameters/ResourceGroupParameter" + "$ref": "AzureBridge.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "AzureBridge.json#/parameters/ActivationNameParameter" @@ -198,6 +213,12 @@ "schema": { "$ref": "AzureBridge.json#/definitions/DownloadedProductResource" } + }, + "default": { + "description": "Default Response.", + "schema": { + "$ref": "Activation.json#/definitions/ExtendedErrorInfo" + } } }, "x-ms-long-running-operation": true, diff --git a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/Product.json b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/Product.json index d3f9266f56b7..46b143618c60 100644 --- a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/Product.json +++ b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/Product.json @@ -10,7 +10,7 @@ "https" ], "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}/providers/Microsoft.AzureBridge.Admin/activations/{activationName}/products": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureBridge.Admin/activations/{activationName}/products": { "get": { "x-ms-examples": { "Return product name.": { @@ -27,7 +27,7 @@ "$ref": "AzureBridge.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "AzureBridge.json#/parameters/ResourceGroupParameter" + "$ref": "AzureBridge.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "AzureBridge.json#/parameters/ActivationNameParameter" @@ -42,6 +42,12 @@ "schema": { "$ref": "#/definitions/ProductResourcesPage" } + }, + "default": { + "description": "Default Response.", + "schema": { + "$ref": "Activation.json#/definitions/ExtendedErrorInfo" + } } }, "produces": [ @@ -55,7 +61,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}/providers/Microsoft.AzureBridge.Admin/activations/{activationName}/products/{productName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureBridge.Admin/activations/{activationName}/products/{productName}": { "get": { "x-ms-examples": { "Return product name.": { @@ -72,7 +78,7 @@ "$ref": "AzureBridge.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "AzureBridge.json#/parameters/ResourceGroupParameter" + "$ref": "AzureBridge.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "AzureBridge.json#/parameters/ActivationNameParameter" @@ -91,8 +97,11 @@ "$ref": "#/definitions/ProductResource" } }, - "404": { - "description": "Not Found" + "default": { + "description": "Default Response.", + "schema": { + "$ref": "Activation.json#/definitions/ExtendedErrorInfo" + } } }, "produces": [ @@ -103,7 +112,7 @@ ] } }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroup}/providers/Microsoft.AzureBridge.Admin/activations/{activationName}/products/{productName}/download": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureBridge.Admin/activations/{activationName}/products/{productName}/download": { "post": { "x-ms-examples": { "Return product name.": { @@ -120,7 +129,7 @@ "$ref": "AzureBridge.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "AzureBridge.json#/parameters/ResourceGroupParameter" + "$ref": "AzureBridge.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "AzureBridge.json#/parameters/ActivationNameParameter" @@ -145,8 +154,11 @@ "$ref": "AzureBridge.json#/definitions/DownloadedProductResource" } }, - "404": { - "description": "Not Found" + "default": { + "description": "Default Response.", + "schema": { + "$ref": "Activation.json#/definitions/ExtendedErrorInfo" + } } }, "x-ms-long-running-operation": true, diff --git a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Activation/Create.json b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Activation/Create.json index 6548cbf55c22..fd4f8bbb1f2d 100644 --- a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Activation/Create.json +++ b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Activation/Create.json @@ -3,8 +3,10 @@ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", "location": "local", "api-version": "2015-06-01-preview", - "resourceGroup": "azurestack", - "activation": "default", + "resourceGroupName": "azurestack", + "activation": { + "displayName": "default" + }, "activationName": "default" }, "responses": { diff --git a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Activation/Delete.json b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Activation/Delete.json index 8f2e3a03d53a..94bb60730558 100644 --- a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Activation/Delete.json +++ b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Activation/Delete.json @@ -3,7 +3,7 @@ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", "location": "local", "api-version": "2015-06-01-preview", - "resourceGroup": "azurestack", + "resourceGroupName": "azurestack", "activationName": "default" }, "responses": { @@ -12,6 +12,7 @@ "id": "/subscriptions/b6a34e73-810f-4564-881a-8434c6c2e5c8/resourceGroups/azurestack-activation/providers/Microsoft.AzureBridge.Admin/activations/default", "name": "default" } - } + }, + "204": {} } } diff --git a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Activation/Get.json b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Activation/Get.json index 3594658e9e70..99793c4e0364 100644 --- a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Activation/Get.json +++ b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Activation/Get.json @@ -3,7 +3,7 @@ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", "location": "local", "api-version": "2015-06-01-preview", - "resourceGroup": "azurestack", + "resourceGroupName": "azurestack", "activationName": "default" }, "responses": { @@ -22,7 +22,6 @@ "provisioningState": "Succeeded" } } - }, - "404": {} + } } } diff --git a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Activation/List.json b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Activation/List.json index 143ec75e4ac8..2d7382dc81e6 100644 --- a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Activation/List.json +++ b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Activation/List.json @@ -3,7 +3,7 @@ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", "location": "local", "api-version": "2015-06-01-preview", - "resourceGroup": "azurestack" + "resourceGroupName": "azurestack" }, "responses": { "200": { diff --git a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/DownloadedProduct/Delete.json b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/DownloadedProduct/Delete.json index c7533bec0320..dc2f421dfeda 100644 --- a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/DownloadedProduct/Delete.json +++ b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/DownloadedProduct/Delete.json @@ -3,7 +3,7 @@ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", "location": "local", "api-version": "2015-06-01-preview", - "resourceGroup": "azurestack", + "resourceGroupName": "azurestack", "activationName": "default", "productName": "Canonical.UbuntuServer1710-ARM.1.0.6" }, @@ -14,6 +14,6 @@ "202": { "body": {} }, - "404": {} + "204": {} } } diff --git a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/DownloadedProduct/Get.json b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/DownloadedProduct/Get.json index 34858fe08def..3ece1e75221e 100644 --- a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/DownloadedProduct/Get.json +++ b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/DownloadedProduct/Get.json @@ -3,7 +3,7 @@ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", "location": "local", "api-version": "2015-06-01-preview", - "resourceGroup": "azurestack", + "resourceGroupName": "azurestack", "activationName": "default", "productName": "Canonical.UbuntuServer1710-ARM.1.0.6" }, @@ -57,7 +57,6 @@ } } } - }, - "404": {} + } } } diff --git a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/DownloadedProduct/List.json b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/DownloadedProduct/List.json index 1dd20c4d85ae..ad8ce850e1a2 100644 --- a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/DownloadedProduct/List.json +++ b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/DownloadedProduct/List.json @@ -3,7 +3,7 @@ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", "location": "local", "api-version": "2015-06-01-preview", - "resourceGroup": "azurestack", + "resourceGroupName": "azurestack", "activationName": "default" }, "responses": { diff --git a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/DownloadedProduct/Put.json b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/DownloadedProduct/Put.json index 9b50491c0898..64863fc9b9d6 100644 --- a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/DownloadedProduct/Put.json +++ b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/DownloadedProduct/Put.json @@ -3,7 +3,7 @@ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", "location": "local", "api-version": "2015-06-01-preview", - "resourceGroup": "azurestack", + "resourceGroupName": "azurestack", "activationName": "default", "productName": "Canonical.UbuntuServer1710-ARM.1.0.6", "downloadedProduct": { diff --git a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Product/Get.json b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Product/Get.json index bdbf6a51dbdb..2ded67835365 100644 --- a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Product/Get.json +++ b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Product/Get.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", "location": "local", - "resourceGroup": "azurestack", + "resourceGroupName": "azurestack", "activationName": "default", "productName": "Canonical.UbuntuServer1710-ARM.1.0.6", "api-version": "2015-06-01-preview" @@ -57,7 +57,6 @@ } } } - }, - "404": {} + } } } diff --git a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Product/List.json b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Product/List.json index d5c05976c5d5..1cfadeb5e0f3 100644 --- a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Product/List.json +++ b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Product/List.json @@ -3,7 +3,7 @@ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", "location": "local", "api-version": "2015-06-01-preview", - "resourceGroup": "azurestack", + "resourceGroupName": "azurestack", "activationName": "default" }, "responses": { diff --git a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Product/download.json b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Product/download.json index b2140e732112..91f899e839e7 100644 --- a/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Product/download.json +++ b/specification/azsadmin/resource-manager/azurebridge/Microsoft.AzureBridge.Admin/preview/2016-01-01/examples/Product/download.json @@ -3,7 +3,7 @@ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", "location": "local", "api-version": "2015-06-01-preview", - "resourceGroup": "azurestack", + "resourceGroupName": "azurestack", "activationName": "default", "productName": "Canonical.UbuntuServer1710-ARM.1.0.6" }, @@ -107,7 +107,6 @@ } } } - }, - "404": {} + } } } diff --git a/specification/azsadmin/resource-manager/azurebridge/readme.azsautogen.md b/specification/azsadmin/resource-manager/azurebridge/readme.azsautogen.md new file mode 100644 index 000000000000..fab4d9021c9d --- /dev/null +++ b/specification/azsadmin/resource-manager/azurebridge/readme.azsautogen.md @@ -0,0 +1,11 @@ +# AutoRest v3 generators + +> see https://aka.ms/autorest + +``` yaml +input-file: + - Microsoft.AzureBridge.Admin/preview/2016-01-01/AzureBridge.json + - Microsoft.AzureBridge.Admin/preview/2016-01-01/DownloadedProduct.json + - Microsoft.AzureBridge.Admin/preview/2016-01-01/Product.json + - Microsoft.AzureBridge.Admin/preview/2016-01-01/Activation.json +``` \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/azurebridge/readme.md b/specification/azsadmin/resource-manager/azurebridge/readme.md index 81167054852a..09e4e09eecc6 100644 --- a/specification/azsadmin/resource-manager/azurebridge/readme.md +++ b/specification/azsadmin/resource-manager/azurebridge/readme.md @@ -39,6 +39,26 @@ input-file: - Microsoft.AzureBridge.Admin/preview/2016-01-01/Activation.json ``` +## Suppression +``` yaml +directive: + - suppress: RequiredPropertiesMissingInResourceModel + from: Activation.json + where: $.definitions.ActivationResource + - suppress: RequiredPropertiesMissingInResourceModel + from: AzureBridge.json + where: $.definitions.DownloadedProductResource + - suppress: RequiredPropertiesMissingInResourceModel + from: Product.json + where: $.definitions.ProductResource + - suppress: PathResourceProviderNamePascalCase + from: Activation.json + - suppress: PathResourceProviderNamePascalCase + from: DownloadedProduct.json + - suppress: PathResourceProviderNamePascalCase + from: Product.json +``` + --- # Code Generation @@ -54,30 +74,14 @@ csharp: clear-output-folder: true ``` -## Multi-API/Profile support for AutoRest v3 generators +# AutoRest v3 generators -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../../profiles/readme.md +> see https://aka.ms/autorest -# all the input files across all versions +``` yaml input-file: - - $(this-folder)/Microsoft.AzureBridge.Admin/preview/2016-01-01/AzureBridge.json - - $(this-folder)/Microsoft.AzureBridge.Admin/preview/2016-01-01/DownloadedProduct.json - - $(this-folder)/Microsoft.AzureBridge.Admin/preview/2016-01-01/Product.json - - $(this-folder)/Microsoft.AzureBridge.Admin/preview/2016-01-01/Activation.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json + - Microsoft.AzureBridge.Admin/preview/2016-01-01/AzureBridge.json + - Microsoft.AzureBridge.Admin/preview/2016-01-01/DownloadedProduct.json + - Microsoft.AzureBridge.Admin/preview/2016-01-01/Product.json + - Microsoft.AzureBridge.Admin/preview/2016-01-01/Activation.json ``` - From 1c32b72538860885beb6a534b93a646330a1f6ef Mon Sep 17 00:00:00 2001 From: Tyler James Leonhardt Date: Fri, 11 Sep 2020 20:20:10 -0700 Subject: [PATCH 047/164] Connected machine az cli (#10640) --- .../resource-manager/readme.az.md | 23 +++++++++++++++++++ .../resource-manager/readme.cli.md | 17 ++++---------- .../hybridcompute/resource-manager/readme.md | 5 ++++ 3 files changed, 33 insertions(+), 12 deletions(-) create mode 100644 specification/hybridcompute/resource-manager/readme.az.md diff --git a/specification/hybridcompute/resource-manager/readme.az.md b/specification/hybridcompute/resource-manager/readme.az.md new file mode 100644 index 000000000000..fe93ce29dfae --- /dev/null +++ b/specification/hybridcompute/resource-manager/readme.az.md @@ -0,0 +1,23 @@ +# AZ HybridCompute + +These settings apply only when `--az` is specified on the command line. + +``` yaml $(az) +az: + extensions: connectedmachine + namespace: azure.mgmt.connectedmachine + package-name: azure-mgmt-connectedmachine +az-output-folder: $(azure-cli-extension-folder)/src/connectedmachine +python-sdk-output-folder: "$(az-output-folder)/azext_connectedmachine/vendored_sdks/connectedmachine" +directive: + - where: + subject: MachineExtension + parameter-name: name + set: + parameter-name: machine-name + - where: + subject: MachineExtension + parameter-name: extension-name + set: + parameter-name: name +``` diff --git a/specification/hybridcompute/resource-manager/readme.cli.md b/specification/hybridcompute/resource-manager/readme.cli.md index 98ef22df6da5..47bc1407e07e 100644 --- a/specification/hybridcompute/resource-manager/readme.cli.md +++ b/specification/hybridcompute/resource-manager/readme.cli.md @@ -1,27 +1,20 @@ - -# Dns -This directory contains the Cli common model for the Dns service. +# CLI HybridCompute + +This directory contains the Cli common model for the Hybrid Compute service. > Metadata ``` yaml -# Migrated from Powershell's readme - title: 'ConnectedMachine' cli: cli-directive: - select: 'operationGroup' where: - operatoinGroup: 'operations' + operationGroup: 'operations' hidden: true - select: 'operation' where: operationGroup: 'machines' operation: '(reconnect|createOrUpdate|update)' removed: true - - select: 'operation' - where: - operationGroup: 'machineExtensions' - operation: '(createOrUpdate|update|delete|get|list)' - removed: true -``` \ No newline at end of file +``` diff --git a/specification/hybridcompute/resource-manager/readme.md b/specification/hybridcompute/resource-manager/readme.md index 8a979ba5fe64..6f44b7cef442 100644 --- a/specification/hybridcompute/resource-manager/readme.md +++ b/specification/hybridcompute/resource-manager/readme.md @@ -100,6 +100,7 @@ swagger-to-sdk: - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js + - repo: azure-cli-extensions - repo: azure-resource-manager-schemas after_scripts: - node sdkauto_afterscript.js hybridcompute/resource-manager @@ -111,6 +112,10 @@ swagger-to-sdk: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) +## az CLI + +See configuration in [readme.az.md](./readme.az.md) and [readme.cli.md](./readme.cli.md) + ## C# See configuration in [readme.csharp.md](./readme.csharp.md) From 7a82688ad135270e84b2316dc2463485d1152c74 Mon Sep 17 00:00:00 2001 From: Liang Wang Date: Mon, 14 Sep 2020 10:04:48 +0800 Subject: [PATCH 048/164] Fix Billing Swagger (#10276) --- .../preview/2018-03-01-preview/billingV2.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/billingV2.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/billingV2.json index 94e961a7fdee..e9b752a24fda 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/billingV2.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/billingV2.json @@ -109,7 +109,7 @@ }, "parameters": [ { - "$ref": "#/parameters/subscriptionGuidParameter" + "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" @@ -171,7 +171,7 @@ }, "parameters": [ { - "$ref": "#/parameters/subscriptionGuidParameter" + "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" @@ -365,10 +365,10 @@ "type": "string", "description": "Version of the API to be used with the client request. The current version is 2018-03-01-preview." }, - "subscriptionGuidParameter": { + "subscriptionIdParameter": { "name": "subscriptionId", "in": "path", - "description": "Azure Subscription ID.", + "description": "The ID that uniquely identifies an Azure subscription.", "required": true, "type": "string" } From c008c1004d7da4c831834b2943325a230d606713 Mon Sep 17 00:00:00 2001 From: moranraz <59017169+moranraz@users.noreply.github.com> Date: Mon, 14 Sep 2020 05:40:33 +0300 Subject: [PATCH 049/164] Incident entities (#10648) * added incident entities operation * change example name * change operationId * add format to integer Co-authored-by: Moran Raz Mizrahi --- .../2019-01-01-preview/SecurityInsights.json | 86 +++++++++++++++++++ .../entities/GetAllIncidentEntities.json | 35 ++++++++ 2 files changed, 121 insertions(+) create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/incidents/entities/GetAllIncidentEntities.json diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json index cadf9002a0ce..a70e71a83dc5 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json @@ -3105,6 +3105,54 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/entities": { + "post": { + "x-ms-examples": { + "Gets all incident related entities": { + "$ref": "./examples/incidents/entities/GetAllIncidentEntities.json" + } + }, + "tags": [ + "IncidentEntities" + ], + "description": "Gets all incident related entities.", + "operationId": "Incidents_ListOfEntities", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentEntitiesResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations": { "get": { "x-ms-examples": { @@ -6738,6 +6786,44 @@ ], "type": "object" }, + "IncidentEntitiesResponse": { + "description": "The incident related entities response.", + "properties": { + "entities": { + "description": "Array of the incident related entities.", + "type": "array", + "items": { + "$ref": "#/definitions/Entity" + } + }, + "metaData": { + "description": "The metadata from the incident related entities results.", + "type": "array", + "items": { + "$ref": "#/definitions/IncidentEntitiesResultsMetadata" + } + } + } + }, + "IncidentEntitiesResultsMetadata": { + "description": "Information of a specific aggregation in the incident related entities result.", + "properties": { + "count": { + "description": "Total number of aggregations of the given kind in the incident related entities result.", + "type": "integer", + "format": "int32" + }, + "entityKind": { + "$ref": "#/definitions/EntityInnerKind", + "description": "The kind of the aggregated entity." + } + }, + "required": [ + "entityKind", + "count" + ], + "type": "object" + }, "IncidentLabel": { "description": "Represents an incident label", "properties": { diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/incidents/entities/GetAllIncidentEntities.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/incidents/entities/GetAllIncidentEntities.json new file mode 100644 index 000000000000..4db37d3eb932 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/incidents/entities/GetAllIncidentEntities.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "responses": { + "200": { + "body": { + "entities": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/Entities", + "kind": "Account", + "properties": { + "friendlyName": "administrator", + "accountName": "administrator", + "ntDomain": "domain" + } + } + ], + "metaData": [ + { + "entityKind": "Account", + "count": 1 + } + ] + } + } + } +} From e52e85befd22e22223a1cc10c245f6e8f546fb04 Mon Sep 17 00:00:00 2001 From: Stephen Owen <69686895+stowen-msft@users.noreply.github.com> Date: Sun, 13 Sep 2020 23:13:21 -0400 Subject: [PATCH 050/164] Update Readmes for Python for Automanage (#10633) * Update readme.md * Update readme.python.md * Update readme.python.md --- specification/automanage/resource-manager/readme.python.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/specification/automanage/resource-manager/readme.python.md b/specification/automanage/resource-manager/readme.python.md index 66953bf45ec5..caf9a094f45f 100644 --- a/specification/automanage/resource-manager/readme.python.md +++ b/specification/automanage/resource-manager/readme.python.md @@ -4,7 +4,7 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) && !$(track2) +``` yaml $(python) && !$(track2) python-mode: create python: azure-arm: true @@ -29,8 +29,6 @@ no-namespace-folders: true python: no-namespace-folders: true output-folder: $(python-sdks-folder)/automanage/azure-mgmt-automanage/azure/mgmt/automanage -no-namespace-folders: true -output-folder: $(python-sdks-folder)/automanage/azure-mgmt-automanage/azure/mgmt/automanage ``` ``` yaml $(python) && $(python-mode) == 'create' From bd9aa6d93b1ba8c6a7f23dd6b614d06bbca6500a Mon Sep 17 00:00:00 2001 From: huizlAzure <43765498+huizlAzure@users.noreply.github.com> Date: Sun, 13 Sep 2020 20:23:33 -0700 Subject: [PATCH 051/164] [SRP] Introduce 2020-08-01-preview version. (#10570) * [SRP] Introduce 2020-08-01-preview version. * Change versions in example files as well * Introduce list deletedAccounts API. * Fix default error message schema to conform to OData v4 * Address CR comments * Support GetDeletedAccount * prettier * Update readme.azureresourceschema.md Co-authored-by: Lei Ni <7233663+leni-msft@users.noreply.github.com> --- .../preview/2020-08-01-preview/blob.json | 1378 ++++ .../preview/2020-08-01-preview/common.json | 137 + .../BlobContainersClearLegalHold.json | 25 + .../examples/BlobContainersDelete.json | 14 + ...lobContainersDeleteImmutabilityPolicy.json | 26 + ...lobContainersExtendImmutabilityPolicy.json | 30 + .../examples/BlobContainersGet.json | 81 + .../BlobContainersGetImmutabilityPolicy.json | 26 + .../examples/BlobContainersLease_Acquire.json | 24 + .../examples/BlobContainersLease_Break.json | 24 + .../examples/BlobContainersList.json | 46 + .../BlobContainersLockImmutabilityPolicy.json | 25 + .../examples/BlobContainersPatch.json | 35 + .../examples/BlobContainersPut.json | 27 + ...obContainersPutDefaultEncryptionScope.json | 40 + .../BlobContainersPutImmutabilityPolicy.json | 32 + .../examples/BlobContainersSetLegalHold.json | 29 + .../examples/BlobRangesRestore.json | 61 + .../examples/BlobServicesGet.json | 95 + .../examples/BlobServicesList.json | 98 + .../examples/BlobServicesPut.json | 169 + .../examples/DeletedAccountGet.json | 25 + .../examples/DeletedAccountList.json | 39 + .../examples/DeletedBlobContainersList.json | 50 + .../examples/DeletedFileSharesList.json | 42 + .../examples/FileServicesGet.json | 86 + .../examples/FileServicesList.json | 89 + .../examples/FileServicesPut.json | 151 + .../examples/FileSharesDelete.json | 14 + .../examples/FileSharesGet.json | 24 + .../examples/FileSharesGet_Stats.json | 26 + .../examples/FileSharesList.json | 38 + .../examples/FileSharesPatch.json | 31 + .../examples/FileSharesPut.json | 27 + .../examples/FileSharesPut_AccessTier.json | 37 + .../examples/FileSharesPut_NFS.json | 37 + .../examples/FileSharesRestore.json | 17 + .../examples/OperationsList.json | 473 ++ .../examples/QueueOperationDelete.json | 13 + .../examples/QueueOperationGet.json | 25 + .../examples/QueueOperationList.json | 40 + .../examples/QueueOperationPatch.json | 20 + .../examples/QueueOperationPut.json | 20 + .../QueueOperationPutWithMetadata.json | 33 + .../examples/QueueServicesGet.json | 82 + .../examples/QueueServicesList.json | 85 + .../examples/QueueServicesPut.json | 147 + .../2020-08-01-preview/examples/SKUList.json | 6454 +++++++++++++++++ .../StorageAccountCheckNameAvailability.json | 17 + .../examples/StorageAccountCreate.json | 118 + ...eObjectReplicationPolicyOnDestination.json | 55 + ...CreateObjectReplicationPolicyOnSource.json | 59 + .../examples/StorageAccountDelete.json | 13 + .../StorageAccountDeleteManagementPolicy.json | 14 + ...eAccountDeleteObjectReplicationPolicy.json | 14 + ...ccountDeletePrivateEndpointConnection.json | 14 + .../examples/StorageAccountEnableAD.json | 71 + .../examples/StorageAccountEnableCMK.json | 94 + .../StorageAccountEncryptionScopeList.json | 43 + .../examples/StorageAccountFailover.json | 13 + .../StorageAccountGetEncryptionScope.json | 25 + .../StorageAccountGetManagementPolicy.json | 59 + ...rageAccountGetObjectReplicationPolicy.json | 47 + ...geAccountGetPrivateEndpointConnection.json | 30 + .../examples/StorageAccountGetProperties.json | 91 + ...StorageAccountGetPropertiesCMKEnabled.json | 103 + .../examples/StorageAccountList.json | 307 + .../StorageAccountListAccountSAS.json | 25 + .../StorageAccountListByResourceGroup.json | 78 + .../examples/StorageAccountListKeys.json | 27 + .../StorageAccountListLocationUsage.json | 24 + ...eAccountListObjectReplicationPolicies.json | 35 + ...AccountListPrivateEndpointConnections.json | 49 + ...torageAccountListPrivateLinkResources.json | 101 + .../StorageAccountListServiceSAS.json | 22 + .../StorageAccountPatchEncryptionScope.json | 36 + .../StorageAccountPutEncryptionScope.json | 39 + ...geAccountPutPrivateEndpointConnection.json | 38 + .../StorageAccountRegenerateKerbKey.json | 35 + .../examples/StorageAccountRegenerateKey.json | 30 + ...torageAccountRevokeUserDelegationKeys.json | 11 + .../StorageAccountSetManagementPolicy.json | 180 + .../examples/StorageAccountUpdate.json | 115 + ...eObjectReplicationPolicyOnDestination.json | 65 + ...UpdateObjectReplicationPolicyOnSource.json | 67 + .../examples/TableOperationDelete.json | 13 + .../examples/TableOperationGet.json | 22 + .../examples/TableOperationList.json | 34 + .../examples/TableOperationPatch.json | 22 + .../examples/TableOperationPut.json | 22 + .../examples/TableServicesGet.json | 82 + .../examples/TableServicesList.json | 85 + .../examples/TableServicesPut.json | 147 + .../preview/2020-08-01-preview/file.json | 795 ++ .../2020-08-01-preview/privatelinks.json | 174 + .../preview/2020-08-01-preview/queue.json | 560 ++ .../preview/2020-08-01-preview/storage.json | 3847 ++++++++++ .../preview/2020-08-01-preview/table.json | 495 ++ .../readme.azureresourceschema.md | 16 + .../storage/resource-manager/readme.go.md | 10 + .../storage/resource-manager/readme.java.md | 14 + .../storage/resource-manager/readme.md | 32 + .../storage/resource-manager/readme.python.md | 14 + .../storage/resource-manager/readme.ruby.md | 11 + 104 files changed, 19106 insertions(+) create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/blob.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/common.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersClearLegalHold.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersDelete.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersDeleteImmutabilityPolicy.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersExtendImmutabilityPolicy.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersGet.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersGetImmutabilityPolicy.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersLease_Acquire.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersLease_Break.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersList.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersLockImmutabilityPolicy.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersPatch.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersPut.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersPutDefaultEncryptionScope.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersPutImmutabilityPolicy.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersSetLegalHold.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobRangesRestore.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobServicesGet.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobServicesList.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobServicesPut.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/DeletedAccountGet.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/DeletedAccountList.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/DeletedBlobContainersList.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/DeletedFileSharesList.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileServicesGet.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileServicesList.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileServicesPut.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesDelete.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesGet.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesGet_Stats.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesList.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesPatch.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesPut.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesPut_AccessTier.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesPut_NFS.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesRestore.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/OperationsList.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationDelete.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationGet.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationList.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationPatch.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationPut.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationPutWithMetadata.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueServicesGet.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueServicesList.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueServicesPut.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/SKUList.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCheckNameAvailability.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCreate.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCreateObjectReplicationPolicyOnDestination.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCreateObjectReplicationPolicyOnSource.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountDelete.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountDeleteManagementPolicy.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountDeleteObjectReplicationPolicy.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountDeletePrivateEndpointConnection.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountEnableAD.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountEnableCMK.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountEncryptionScopeList.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountFailover.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetEncryptionScope.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetManagementPolicy.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetObjectReplicationPolicy.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetPrivateEndpointConnection.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetProperties.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetPropertiesCMKEnabled.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountList.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListAccountSAS.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListByResourceGroup.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListKeys.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListLocationUsage.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListObjectReplicationPolicies.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListPrivateEndpointConnections.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListPrivateLinkResources.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListServiceSAS.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountPatchEncryptionScope.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountPutEncryptionScope.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountPutPrivateEndpointConnection.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountRegenerateKerbKey.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountRegenerateKey.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountRevokeUserDelegationKeys.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountSetManagementPolicy.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountUpdate.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountUpdateObjectReplicationPolicyOnDestination.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountUpdateObjectReplicationPolicyOnSource.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableOperationDelete.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableOperationGet.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableOperationList.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableOperationPatch.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableOperationPut.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableServicesGet.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableServicesList.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableServicesPut.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/file.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/privatelinks.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/queue.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/storage.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/table.json diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/blob.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/blob.json new file mode 100644 index 000000000000..b07b7afda9ad --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/blob.json @@ -0,0 +1,1378 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-08-01-preview", + "title": "StorageManagementClient", + "description": "The Azure Storage Management API." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices": { + "get": { + "tags": [ + "BlobService" + ], + "operationId": "BlobServices_List", + "x-ms-examples": { + "ListBlobServices": { + "$ref": "./examples/BlobServicesList.json" + } + }, + "description": "List blob services of storage account. It returns a collection of one object named default.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- List blob services operation completed successfully.", + "schema": { + "$ref": "#/definitions/BlobServiceItems" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/{BlobServicesName}": { + "put": { + "tags": [ + "BlobService" + ], + "operationId": "BlobServices_SetServiceProperties", + "x-ms-examples": { + "PutBlobServices": { + "$ref": "./examples/BlobServicesPut.json" + } + }, + "description": "Sets the properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. ", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/BlobServicesName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BlobServiceProperties" + }, + "description": "The properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules." + } + ], + "responses": { + "200": { + "description": "OK -- Sets The properties of a storage account’s Blob service successfully.", + "schema": { + "$ref": "#/definitions/BlobServiceProperties" + } + } + } + }, + "get": { + "tags": [ + "BlobService" + ], + "operationId": "BlobServices_GetServiceProperties", + "x-ms-examples": { + "GetBlobServices": { + "$ref": "./examples/BlobServicesGet.json" + } + }, + "description": "Gets the properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/BlobServicesName" + } + ], + "responses": { + "200": { + "description": "OK -- returned the properties of a storage account’s Blob service.", + "schema": { + "$ref": "#/definitions/BlobServiceProperties" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers": { + "get": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_List", + "x-ms-examples": { + "ListContainers": { + "$ref": "./examples/BlobContainersList.json" + }, + "ListDeletedContainers": { + "$ref": "./examples/DeletedBlobContainersList.json" + } + }, + "description": "Lists all containers and does not support a prefix like data plane. Also SRP today does not return continuation token.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$maxpagesize", + "in": "query", + "type": "string", + "description": "Optional. Specified maximum number of containers that can be included in the list." + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "Optional. When specified, only container names starting with the filter will be listed." + }, + { + "name": "$include", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "deleted" + ], + "x-ms-enum": { + "name": "ListContainersInclude", + "modelAsString": true + }, + "description": "Optional, used to include the properties for soft deleted blob containers." + } + ], + "responses": { + "200": { + "description": "OK -- List Container operation completed successfully.", + "schema": { + "$ref": "#/definitions/ListContainerItems" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}": { + "put": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_Create", + "x-ms-examples": { + "PutContainers": { + "$ref": "./examples/BlobContainersPut.json" + }, + "PutContainerWithDefaultEncryptionScope": { + "$ref": "./examples/BlobContainersPutDefaultEncryptionScope.json" + } + }, + "description": "Creates a new container under the specified account as described by request body. The container resource includes metadata and properties for that container. It does not include a list of the blobs contained by the container. ", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "blobContainer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BlobContainer" + }, + "description": "Properties of the blob container to create." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Created -- Create Container operation completed successfully.", + "schema": { + "$ref": "#/definitions/BlobContainer" + } + }, + "200": { + "description": "OK -- The Container is already created.", + "schema": { + "$ref": "#/definitions/BlobContainer" + } + } + } + }, + "patch": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_Update", + "x-ms-examples": { + "UpdateContainers": { + "$ref": "./examples/BlobContainersPatch.json" + } + }, + "description": "Updates container properties as specified in request body. Properties not mentioned in the request will be unchanged. Update fails if the specified container doesn't already exist. ", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "name": "blobContainer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BlobContainer" + }, + "description": "Properties to update for the blob container." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Update Container operation completed successfully.", + "schema": { + "$ref": "#/definitions/BlobContainer", + "description": "Properties of the updated blob container." + } + } + } + }, + "get": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_Get", + "x-ms-examples": { + "GetContainers": { + "$ref": "./examples/BlobContainersGet.json" + } + }, + "description": "Gets properties of a specified container. ", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get Container operation completed successfully.", + "schema": { + "$ref": "#/definitions/BlobContainer" + } + } + } + }, + "delete": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_Delete", + "x-ms-examples": { + "DeleteContainers": { + "$ref": "./examples/BlobContainersDelete.json" + } + }, + "description": "Deletes specified container under its account.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete Container operation completed successfully." + }, + "204": { + "description": "No Content -- The Container not exist." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/setLegalHold": { + "post": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_SetLegalHold", + "x-ms-examples": { + "SetLegalHoldContainers": { + "$ref": "./examples/BlobContainersSetLegalHold.json" + } + }, + "description": "Sets legal hold tags. Setting the same tag results in an idempotent operation. SetLegalHold follows an append pattern and does not clear out the existing tags that are not specified in the request.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "LegalHold", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LegalHold" + }, + "description": "The LegalHold property that will be set to a blob container." + } + ], + "responses": { + "200": { + "description": "OK -- Set legal hold tags for Container completed successfully.", + "schema": { + "$ref": "#/definitions/LegalHold" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/clearLegalHold": { + "post": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_ClearLegalHold", + "x-ms-examples": { + "ClearLegalHoldContainers": { + "$ref": "./examples/BlobContainersClearLegalHold.json" + } + }, + "description": "Clears legal hold tags. Clearing the same or non-existent tag results in an idempotent operation. ClearLegalHold clears out only the specified tags in the request.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "LegalHold", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LegalHold" + }, + "description": "The LegalHold property that will be clear from a blob container." + } + ], + "responses": { + "200": { + "description": "OK -- Clear legal hold tags for Container completed successfully.", + "schema": { + "$ref": "#/definitions/LegalHold" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/{immutabilityPolicyName}": { + "put": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_CreateOrUpdateImmutabilityPolicy", + "x-ms-examples": { + "CreateOrUpdateImmutabilityPolicy": { + "$ref": "./examples/BlobContainersPutImmutabilityPolicy.json" + } + }, + "description": "Creates or updates an unlocked immutability policy. ETag in If-Match is honored if given but not required for this operation.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/ImmutabilityPolicy" + }, + "description": "The ImmutabilityPolicy Properties that will be created or updated to a blob container." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied." + } + ], + "responses": { + "200": { + "description": "OK -- Creates or updates container ImmutabilityPolicy operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImmutabilityPolicy" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + } + } + }, + "get": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_GetImmutabilityPolicy", + "x-ms-examples": { + "GetImmutabilityPolicy": { + "$ref": "./examples/BlobContainersGetImmutabilityPolicy.json" + } + }, + "description": "Gets the existing immutability policy along with the corresponding ETag in response headers and body.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied." + } + ], + "responses": { + "200": { + "description": "OK -- Gets container ImmutabilityPolicy operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImmutabilityPolicy" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + } + } + }, + "delete": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_DeleteImmutabilityPolicy", + "x-ms-examples": { + "DeleteImmutabilityPolicy": { + "$ref": "./examples/BlobContainersDeleteImmutabilityPolicy.json" + } + }, + "description": "Aborts an unlocked immutability policy. The response of delete has immutabilityPeriodSinceCreationInDays set to 0. ETag in If-Match is required for this operation. Deleting a locked immutability policy is not allowed, the only way is to delete the container after deleting all expired blobs inside the policy locked container.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "#/parameters/ImmutabilityPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied." + } + ], + "responses": { + "200": { + "description": "OK -- Deletes container ImmutabilityPolicy operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImmutabilityPolicy" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/default/lock": { + "post": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_LockImmutabilityPolicy", + "x-ms-examples": { + "LockImmutabilityPolicy": { + "$ref": "./examples/BlobContainersLockImmutabilityPolicy.json" + } + }, + "description": "Sets the ImmutabilityPolicy to Locked state. The only action allowed on a Locked policy is ExtendImmutabilityPolicy action. ETag in If-Match is required for this operation.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied." + } + ], + "responses": { + "200": { + "description": "OK -- Locks container ImmutabilityPolicy operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImmutabilityPolicy" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/default/extend": { + "post": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_ExtendImmutabilityPolicy", + "x-ms-examples": { + "ExtendImmutabilityPolicy": { + "$ref": "./examples/BlobContainersExtendImmutabilityPolicy.json" + } + }, + "description": "Extends the immutabilityPeriodSinceCreationInDays of a locked immutabilityPolicy. The only action allowed on a Locked policy will be this action. ETag in If-Match is required for this operation.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/ImmutabilityPolicy" + }, + "description": "The ImmutabilityPolicy Properties that will be extended for a blob container." + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied." + } + ], + "responses": { + "200": { + "description": "OK -- Extends container ImmutabilityPolicy operation completed successfully..", + "schema": { + "$ref": "#/definitions/ImmutabilityPolicy" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/lease": { + "post": { + "tags": [ + "BlobContainers" + ], + "operationId": "BlobContainers_Lease", + "x-ms-examples": { + "Acquire a lease on a container": { + "$ref": "./examples/BlobContainersLease_Acquire.json" + }, + "Break a lease on a container": { + "$ref": "./examples/BlobContainersLease_Break.json" + } + }, + "description": "The Lease Container operation establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ContainerName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/LeaseContainerRequest" + }, + "description": "Lease Container request body." + } + ], + "responses": { + "200": { + "description": "OK -- Lease Container operation completed successfully.", + "schema": { + "$ref": "#/definitions/LeaseContainerResponse" + } + } + } + } + } + }, + "definitions": { + "ContainerProperties": { + "properties": { + "version": { + "type": "string", + "readOnly": true, + "description": "The version of the deleted blob container." + }, + "deleted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates whether the blob container was deleted." + }, + "deletedTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Blob container deletion time." + }, + "remainingRetentionDays": { + "type": "integer", + "readOnly": true, + "description": "Remaining retention days for soft deleted blob container." + }, + "defaultEncryptionScope": { + "type": "string", + "description": "Default the container to use specified encryption scope for all writes." + }, + "denyEncryptionScopeOverride": { + "type": "boolean", + "description": "Block override of encryption scope from the container default." + }, + "publicAccess": { + "type": "string", + "enum": [ + "Container", + "Blob", + "None" + ], + "x-ms-enum": { + "name": "PublicAccess", + "modelAsString": false + }, + "description": "Specifies whether data in the container may be accessed publicly and the level of access." + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Returns the date and time the container was last modified." + }, + "leaseStatus": { + "type": "string", + "readOnly": true, + "enum": [ + "Locked", + "Unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatus", + "modelAsString": true + }, + "description": "The lease status of the container." + }, + "leaseState": { + "type": "string", + "readOnly": true, + "enum": [ + "Available", + "Leased", + "Expired", + "Breaking", + "Broken" + ], + "x-ms-enum": { + "name": "LeaseState", + "modelAsString": true + }, + "description": "Lease state of the container." + }, + "leaseDuration": { + "type": "string", + "readOnly": true, + "enum": [ + "Infinite", + "Fixed" + ], + "x-ms-enum": { + "name": "LeaseDuration", + "modelAsString": true + }, + "description": "Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased." + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "A name-value pair to associate with the container as metadata." + }, + "immutabilityPolicy": { + "readOnly": true, + "$ref": "#/definitions/ImmutabilityPolicyProperties", + "x-ms-client-name": "ImmutabilityPolicy", + "description": "The ImmutabilityPolicy property of the container." + }, + "legalHold": { + "readOnly": true, + "$ref": "#/definitions/LegalHoldProperties", + "description": "The LegalHold property of the container." + }, + "hasLegalHold": { + "type": "boolean", + "readOnly": true, + "description": "The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account." + }, + "hasImmutabilityPolicy": { + "type": "boolean", + "readOnly": true, + "description": "The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container." + } + }, + "description": "The properties of a container." + }, + "BlobContainer": { + "properties": { + "properties": { + "$ref": "#/definitions/ContainerProperties", + "x-ms-client-flatten": true, + "x-ms-client-name": "ContainerProperties", + "description": "Properties of the blob container." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/AzureEntityResource" + } + ], + "description": "Properties of the blob container, including Id, resource name, resource type, Etag." + }, + "ImmutabilityPolicyProperty": { + "properties": { + "immutabilityPeriodSinceCreationInDays": { + "type": "integer", + "description": "The immutability period for the blobs in the container since the policy creation, in days." + }, + "state": { + "type": "string", + "readOnly": true, + "enum": [ + "Locked", + "Unlocked" + ], + "x-ms-enum": { + "name": "ImmutabilityPolicyState", + "modelAsString": true + }, + "description": "The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked." + }, + "allowProtectedAppendWrites": { + "type": "boolean", + "description": "This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API" + } + }, + "description": "The properties of an ImmutabilityPolicy of a blob container." + }, + "ImmutabilityPolicyProperties": { + "properties": { + "properties": { + "$ref": "#/definitions/ImmutabilityPolicyProperty", + "x-ms-client-flatten": true, + "description": "The properties of an ImmutabilityPolicy of a blob container." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "ImmutabilityPolicy Etag." + }, + "updateHistory": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/UpdateHistoryProperty" + }, + "description": "The ImmutabilityPolicy update history of the blob container." + } + }, + "description": "The properties of an ImmutabilityPolicy of a blob container." + }, + "ImmutabilityPolicy": { + "properties": { + "properties": { + "$ref": "#/definitions/ImmutabilityPolicyProperty", + "x-ms-client-flatten": true, + "description": "The properties of an ImmutabilityPolicy of a blob container." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/AzureEntityResource" + } + ], + "required": [ + "properties" + ], + "description": "The ImmutabilityPolicy property of a blob container, including Id, resource name, resource type, Etag." + }, + "UpdateHistoryProperty": { + "properties": { + "update": { + "type": "string", + "readOnly": true, + "enum": [ + "put", + "lock", + "extend" + ], + "x-ms-enum": { + "name": "ImmutabilityPolicyUpdateType", + "modelAsString": true + }, + "description": "The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend." + }, + "immutabilityPeriodSinceCreationInDays": { + "type": "integer", + "readOnly": true, + "description": "The immutability period for the blobs in the container since the policy creation, in days." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Returns the date and time the ImmutabilityPolicy was updated." + }, + "objectIdentifier": { + "type": "string", + "readOnly": true, + "description": "Returns the Object ID of the user who updated the ImmutabilityPolicy." + }, + "tenantId": { + "type": "string", + "readOnly": true, + "description": "Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy." + }, + "upn": { + "type": "string", + "readOnly": true, + "description": "Returns the User Principal Name of the user who updated the ImmutabilityPolicy." + } + }, + "description": "An update history of the ImmutabilityPolicy of a blob container." + }, + "LegalHoldProperties": { + "properties": { + "hasLegalHold": { + "type": "boolean", + "readOnly": true, + "description": "The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account." + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/definitions/TagProperty" + }, + "description": "The list of LegalHold tags of a blob container." + } + }, + "description": "The LegalHold property of a blob container." + }, + "TagProperty": { + "properties": { + "tag": { + "type": "string", + "readOnly": true, + "description": "The tag value." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Returns the date and time the tag was added." + }, + "objectIdentifier": { + "type": "string", + "readOnly": true, + "description": "Returns the Object ID of the user who added the tag." + }, + "tenantId": { + "type": "string", + "readOnly": true, + "description": "Returns the Tenant ID that issued the token for the user who added the tag." + }, + "upn": { + "type": "string", + "readOnly": true, + "description": "Returns the User Principal Name of the user who added the tag." + } + }, + "description": "A tag of the LegalHold of a blob container." + }, + "LegalHold": { + "properties": { + "hasLegalHold": { + "type": "boolean", + "readOnly": true, + "description": "The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account." + }, + "tags": { + "type": "array", + "items": { + "type": "string", + "maxLength": 23, + "minLength": 3 + }, + "description": "Each tag should be 3 to 23 alphanumeric characters and is normalized to lower case at SRP." + } + }, + "required": [ + "tags" + ], + "description": "The LegalHold property of a blob container." + }, + "ListContainerItem": { + "properties": { + "properties": { + "$ref": "#/definitions/ContainerProperties", + "x-ms-client-flatten": true, + "description": "The blob container properties be listed out." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/AzureEntityResource" + } + ], + "description": "The blob container properties be listed out." + }, + "ListContainerItems": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ListContainerItem" + }, + "description": "List of blobs containers returned.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.", + "readOnly": true + } + }, + "description": "Response schema. Contains list of blobs returned, and if paging is requested or required, a URL to next page of containers." + }, + "BlobServiceProperties": { + "properties": { + "properties": { + "properties": { + "cors": { + "$ref": "./common.json#/definitions/CorsRules", + "description": "Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Blob service." + }, + "defaultServiceVersion": { + "type": "string", + "description": "DefaultServiceVersion indicates the default version to use for requests to the Blob service if an incoming request’s version is not specified. Possible values include version 2008-10-27 and all more recent versions." + }, + "deleteRetentionPolicy": { + "$ref": "./common.json#/definitions/DeleteRetentionPolicy", + "description": "The blob service properties for blob soft delete." + }, + "isVersioningEnabled": { + "type": "boolean", + "description": "Versioning is enabled if set to true." + }, + "automaticSnapshotPolicyEnabled": { + "type": "boolean", + "description": "Deprecated in favor of isVersioningEnabled property." + }, + "changeFeed": { + "$ref": "#/definitions/ChangeFeed", + "description": "The blob service properties for change feed events." + }, + "restorePolicy": { + "$ref": "#/definitions/RestorePolicyProperties", + "description": "The blob service properties for blob restore policy." + }, + "containerDeleteRetentionPolicy": { + "$ref": "./common.json#/definitions/DeleteRetentionPolicy", + "description": "The blob service properties for container soft delete." + } + }, + "x-ms-client-flatten": true, + "x-ms-client-name": "BlobServiceProperties", + "description": "The properties of a storage account’s Blob service." + }, + "sku": { + "$ref": "./common.json#/definitions/Sku", + "readOnly": true, + "description": "Sku name and tier." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "description": "The properties of a storage account’s Blob service." + }, + "BlobServiceItems": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BlobServiceProperties" + }, + "description": "List of blob services returned.", + "readOnly": true + } + } + }, + "ChangeFeed": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates whether change feed event logging is enabled for the Blob service." + } + }, + "description": "The blob service properties for change feed events." + }, + "RestorePolicyProperties": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Blob restore is enabled if set to true." + }, + "days": { + "type": "integer", + "minimum": 1, + "maximum": 365, + "description": "how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days." + }, + "lastEnabledTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Deprecated in favor of minRestoreTime property." + }, + "minRestoreTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Returns the minimum date and time that the restore can be started." + } + }, + "required": [ + "enabled" + ], + "description": "The blob service properties for blob restore policy" + }, + "LeaseContainerRequest": { + "properties": { + "action": { + "type": "string", + "enum": [ + "Acquire", + "Renew", + "Change", + "Release", + "Break" + ], + "description": "Specifies the lease action. Can be one of the available actions." + }, + "leaseId": { + "type": "string", + "description": "Identifies the lease. Can be specified in any valid GUID string format." + }, + "breakPeriod": { + "type": "integer", + "description": "Optional. For a break action, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60." + }, + "leaseDuration": { + "type": "integer", + "description": "Required for acquire. Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires." + }, + "proposedLeaseId": { + "type": "string", + "description": "Optional for acquire, required for change. Proposed lease ID, in a GUID string format." + } + }, + "required": [ + "action" + ], + "description": "Lease Container request schema." + }, + "LeaseContainerResponse": { + "properties": { + "leaseId": { + "type": "string", + "description": "Returned unique lease ID that must be included with any request to delete the container, or to renew, change, or release the lease." + }, + "leaseTimeSeconds": { + "type": "string", + "description": "Approximate time remaining in the lease period, in seconds." + } + }, + "description": "Lease Container response schema." + } + }, + "parameters": { + "ContainerName": { + "name": "containerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.", + "maxLength": 63, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ImmutabilityPolicyName": { + "name": "immutabilityPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be 'default'", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "BlobServicesName": { + "name": "BlobServicesName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the blob Service within the specified storage account. Blob Service Name must be 'default'", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/common.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/common.json new file mode 100644 index 000000000000..2aaaf5dadb5a --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/common.json @@ -0,0 +1,137 @@ +{ + "swagger": "2.0", + "info": { + "title": "Storage", + "description": "Storage Resource Provider API Common Types", + "version": "2020-08-01-preview" + }, + "paths": {}, + "definitions": { + "CorsRules": { + "properties": { + "corsRules": { + "type": "array", + "items": { + "description": "Specifies a CORS rule for the Blob service. ", + "$ref": "#/definitions/CorsRule" + }, + "description": "The List of CORS rules. You can include up to five CorsRule elements in the request. " + } + }, + "description": "Sets the CORS rules. You can include up to five CorsRule elements in the request. " + }, + "CorsRule": { + "properties": { + "allowedOrigins": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or \"*\" to allow all domains" + }, + "allowedMethods": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "DELETE", + "GET", + "HEAD", + "MERGE", + "POST", + "OPTIONS", + "PUT" + ] + }, + "description": "Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin." + }, + "maxAgeInSeconds": { + "type": "integer", + "description": "Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response." + }, + "exposedHeaders": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Required if CorsRule element is present. A list of response headers to expose to CORS clients." + }, + "allowedHeaders": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request." + } + }, + "required": [ + "allowedOrigins", + "allowedMethods", + "maxAgeInSeconds", + "exposedHeaders", + "allowedHeaders" + ], + "description": "Specifies a CORS rule for the Blob service." + }, + "DeleteRetentionPolicy": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates whether DeleteRetentionPolicy is enabled." + }, + "days": { + "type": "integer", + "minimum": 1, + "maximum": 365, + "description": "Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365." + } + }, + "description": "The service properties for soft delete." + }, + "Sku": { + "properties": { + "name": { + "$ref": "#/definitions/SkuName" + }, + "tier": { + "$ref": "#/definitions/Tier" + } + }, + "required": [ + "name" + ], + "description": "The SKU of the storage account." + }, + "SkuName": { + "type": "string", + "description": "The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.", + "enum": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS", + "Standard_ZRS", + "Premium_LRS", + "Premium_ZRS", + "Standard_GZRS", + "Standard_RAGZRS" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "Tier": { + "readOnly": true, + "type": "string", + "description": "The SKU tier. This is based on the SKU name.", + "enum": [ + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": false + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersClearLegalHold.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersClearLegalHold.json new file mode 100644 index 000000000000..10cb1f973985 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersClearLegalHold.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4303", + "accountName": "sto7280", + "containerName": "container8723", + "api-version": "2020-08-01-preview", + "monitor": "true", + "LegalHold": { + "tags": [ + "tag1", + "tag2", + "tag3" + ] + } + }, + "responses": { + "200": { + "body": { + "hasLegalHold": false, + "tags": [] + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersDelete.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersDelete.json new file mode 100644 index 000000000000..1b458fc42fbf --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4079", + "accountName": "sto4506", + "containerName": "container9689", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersDeleteImmutabilityPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersDeleteImmutabilityPolicy.json new file mode 100644 index 000000000000..8e3c544f52ce --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersDeleteImmutabilityPolicy.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res1581", + "accountName": "sto9621", + "containerName": "container4910", + "immutabilityPolicyName": "default", + "If-Match": "\"8d59f81a7fa7be0\"", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res1581/providers/Microsoft.Storage/storageAccounts/sto9621/blobServices/default/containers/container4910/immutabilityPolicies/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies", + "etag": "\"8d59f81a87b40c0\"", + "properties": { + "immutabilityPeriodSinceCreationInDays": 0, + "state": "Unlocked" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersExtendImmutabilityPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersExtendImmutabilityPolicy.json new file mode 100644 index 000000000000..012711dc8900 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersExtendImmutabilityPolicy.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6238", + "accountName": "sto232", + "containerName": "container5023", + "If-Match": "\"8d59f830d0c3bf9\"", + "api-version": "2020-08-01-preview", + "monitor": "true", + "parameters": { + "properties": { + "immutabilityPeriodSinceCreationInDays": 100 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res6238/providers/Microsoft.Storage/storageAccounts/sto232/blobServices/default/containers/container5023/immutabilityPolicies/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies", + "etag": "\"8d57a8b2ff50332\"", + "properties": { + "immutabilityPeriodSinceCreationInDays": 100, + "state": "Locked" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersGet.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersGet.json new file mode 100644 index 000000000000..fcd31bb5b494 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersGet.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9871", + "accountName": "sto6217", + "containerName": "container1634", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/blobServices/default/containers/container1634", + "name": "container1634", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers", + "etag": "\"0x8D592D74CC20EBA\"", + "properties": { + "publicAccess": "None", + "leaseStatus": "Unlocked", + "leaseState": "Available", + "lastModifiedTime": "2018-03-26T05:06:14Z", + "immutabilityPolicy": { + "etag": "\"8d592d74cb3011a\"", + "properties": { + "immutabilityPeriodSinceCreationInDays": 100, + "state": "Locked" + }, + "updateHistory": [ + { + "update": "put", + "immutabilityPeriodSinceCreationInDays": 3, + "timestamp": "2018-03-26T05:06:11.431403Z", + "objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + { + "update": "lock", + "immutabilityPeriodSinceCreationInDays": 3, + "timestamp": "2018-03-26T05:06:13.0907641Z", + "objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + { + "update": "extend", + "immutabilityPeriodSinceCreationInDays": 100, + "timestamp": "2018-03-26T05:06:14.7097716Z", + "objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + ] + }, + "legalHold": { + "hasLegalHold": true, + "tags": [ + { + "tag": "tag1", + "timestamp": "2018-03-26T05:06:09.6964643Z", + "objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + { + "tag": "tag2", + "timestamp": "2018-03-26T05:06:09.6964643Z", + "objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + { + "tag": "tag3", + "timestamp": "2018-03-26T05:06:09.6964643Z", + "objectIdentifier": "ce7cd28a-fc25-4bf1-8fb9-e1b9833ffd4b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + ] + }, + "hasImmutabilityPolicy": true, + "hasLegalHold": true + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersGetImmutabilityPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersGetImmutabilityPolicy.json new file mode 100644 index 000000000000..a252a1fab23b --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersGetImmutabilityPolicy.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res5221", + "accountName": "sto9177", + "containerName": "container3489", + "immutabilityPolicyName": "default", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res5221/providers/Microsoft.Storage/storageAccounts/sto9177/blobServices/default/containers/container3489/immutabilityPolicies/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies", + "etag": "\"8d59f828e64b75c\"", + "properties": { + "immutabilityPeriodSinceCreationInDays": 5, + "allowProtectedAppendWrites": true, + "state": "Unlocked" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersLease_Acquire.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersLease_Acquire.json new file mode 100644 index 000000000000..06e750eed70a --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersLease_Acquire.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "containerName": "container6185", + "api-version": "2020-08-01-preview", + "monitor": "true", + "parameters": { + "action": "Acquire", + "leaseId": null, + "breakPeriod": null, + "leaseDuration": -1, + "proposedLeaseId": null + } + }, + "responses": { + "200": { + "body": { + "leaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d" + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersLease_Break.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersLease_Break.json new file mode 100644 index 000000000000..5478c1ddb953 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersLease_Break.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "containerName": "container6185", + "api-version": "2020-08-01-preview", + "monitor": "true", + "parameters": { + "action": "Break", + "leaseId": "8698f513-fa75-44a1-b8eb-30ba336af27d", + "breakPeriod": null, + "leaseDuration": null, + "proposedLeaseId": null + } + }, + "responses": { + "200": { + "body": { + "leaseTimeSeconds": "0" + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersList.json new file mode 100644 index 000000000000..f36181499495 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersList.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9290", + "accountName": "sto1590", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/blobServices/default/containers/container1644", + "name": "container1644", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers", + "etag": "\"0x8D589847D51C7DE\"", + "properties": { + "publicAccess": "Container", + "leaseStatus": "Unlocked", + "leaseState": "Available", + "lastModifiedTime": "2018-03-14T08:20:47Z", + "hasImmutabilityPolicy": false, + "hasLegalHold": false + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/blobServices/default/containers/container4052", + "name": "container4052", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers", + "etag": "\"0x8D589847DAB5AF9\"", + "properties": { + "publicAccess": "None", + "leaseStatus": "Unlocked", + "leaseState": "Available", + "lastModifiedTime": "2018-03-14T08:20:47Z", + "hasImmutabilityPolicy": false, + "hasLegalHold": false + } + } + ], + "nextLink": "https://sto1590endpoint/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/blobServices/default/containers?api-version=2020-08-01-preview&$maxpagesize=2&$skipToken=/sto1590/container5103" + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersLockImmutabilityPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersLockImmutabilityPolicy.json new file mode 100644 index 000000000000..df3fe04ade92 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersLockImmutabilityPolicy.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res2702", + "accountName": "sto5009", + "containerName": "container1631", + "If-Match": "\"8d59f825b721dd3\"", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res2702/providers/Microsoft.Storage/storageAccounts/sto5009/blobServices/default/containers/container1631/immutabilityPolicies/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies", + "etag": "\"8d57a8a5edb084a\"", + "properties": { + "immutabilityPeriodSinceCreationInDays": 3, + "state": "Locked" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersPatch.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersPatch.json new file mode 100644 index 000000000000..c72b4b1035f9 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersPatch.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "containerName": "container6185", + "api-version": "2020-08-01-preview", + "monitor": "true", + "blobContainer": { + "properties": { + "publicAccess": "Container", + "metadata": { + "metadata": "true" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185", + "name": "container6185", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers", + "properties": { + "metadata": { + "metadata": "true" + }, + "publicAccess": "Container", + "hasImmutabilityPolicy": false, + "hasLegalHold": false + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersPut.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersPut.json new file mode 100644 index 000000000000..f5b3a3d5794b --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersPut.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "containerName": "container6185", + "api-version": "2020-08-01-preview", + "monitor": "true", + "blobContainer": {} + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185", + "name": "container6185", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185", + "name": "container6185", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers" + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersPutDefaultEncryptionScope.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersPutDefaultEncryptionScope.json new file mode 100644 index 000000000000..a59517407b49 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersPutDefaultEncryptionScope.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "containerName": "container6185", + "api-version": "2020-08-01-preview", + "monitor": "true", + "blobContainer": { + "properties": { + "defaultEncryptionScope": "encryptionscope185", + "denyEncryptionScopeOverride": true + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185", + "name": "container6185", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers", + "properties": { + "defaultEncryptionScope": "encryptionscope185", + "denyEncryptionScopeOverride": true + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/blobServices/default/containers/container6185", + "name": "container6185", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers", + "properties": { + "defaultEncryptionScope": "encryptionscope185", + "denyEncryptionScopeOverride": true + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersPutImmutabilityPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersPutImmutabilityPolicy.json new file mode 100644 index 000000000000..27551892b1b6 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersPutImmutabilityPolicy.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res1782", + "accountName": "sto7069", + "containerName": "container6397", + "immutabilityPolicyName": "default", + "api-version": "2020-08-01-preview", + "monitor": "true", + "parameters": { + "properties": { + "immutabilityPeriodSinceCreationInDays": 3, + "allowProtectedAppendWrites": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res1782/providers/Microsoft.Storage/storageAccounts/sto7069/blobServices/default/containers/container6397/immutabilityPolicies/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies", + "etag": "\"8d59f830cb130e5\"", + "properties": { + "immutabilityPeriodSinceCreationInDays": 3, + "allowProtectedAppendWrites": true, + "state": "Unlocked" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersSetLegalHold.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersSetLegalHold.json new file mode 100644 index 000000000000..6b1ab8d4b261 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobContainersSetLegalHold.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4303", + "accountName": "sto7280", + "containerName": "container8723", + "api-version": "2020-08-01-preview", + "monitor": "true", + "LegalHold": { + "tags": [ + "tag1", + "tag2", + "tag3" + ] + } + }, + "responses": { + "200": { + "body": { + "hasLegalHold": true, + "tags": [ + "tag1", + "tag2", + "tag3" + ] + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobRangesRestore.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobRangesRestore.json new file mode 100644 index 000000000000..f0734ba8bffe --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobRangesRestore.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9101", + "accountName": "sto4445", + "api-version": "2020-08-01-preview", + "parameters": { + "timeToRestore": "2019-04-20T15:30:00.0000000Z", + "blobRanges": [ + { + "startRange": "container/blobpath1", + "endRange": "container/blobpath2" + }, + { + "startRange": "container2/blobpath3", + "endRange": "" + } + ] + } + }, + "responses": { + "200": { + "body": { + "status": "Complete", + "restoreId": "{restore_id}", + "parameters": { + "timeToRestore": "2019-04-20T15:30:00.0000000Z", + "blobRanges": [ + { + "startRange": "container/blobpath1", + "endRange": "container/blobpath2" + }, + { + "startRange": "container2/blobpath3", + "endRange": "" + } + ] + } + } + }, + "202": { + "body": { + "status": "InProgress", + "restoreId": "{restore_id}", + "parameters": { + "timeToRestore": "2019-04-20T15:30:00.0000000Z", + "blobRanges": [ + { + "startRange": "container/blobpath1", + "endRange": "container/blobpath2" + }, + { + "startRange": "container2/blobpath3", + "endRange": "" + } + ] + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobServicesGet.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobServicesGet.json new file mode 100644 index 000000000000..2c798564c013 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobServicesGet.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4410", + "accountName": "sto8607", + "BlobServicesName": "default", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/blobServices/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/blobServices", + "properties": { + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ], + "allowedMethods": [ + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" + ], + "maxAgeInSeconds": 100, + "exposedHeaders": [ + "x-ms-meta-*" + ], + "allowedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ] + }, + { + "allowedOrigins": [ + "*" + ], + "allowedMethods": [ + "GET" + ], + "maxAgeInSeconds": 2, + "exposedHeaders": [ + "*" + ], + "allowedHeaders": [ + "*" + ] + }, + { + "allowedOrigins": [ + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], + "allowedMethods": [ + "GET", + "PUT" + ], + "maxAgeInSeconds": 2000, + "exposedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x -ms-meta-target*" + ], + "allowedHeaders": [ + "x-ms-meta-12345675754564*" + ] + } + ] + }, + "defaultServiceVersion": "2017-07-29", + "deleteRetentionPolicy": { + "enabled": true, + "days": 300 + }, + "isVersioningEnabled": true, + "changeFeed": { + "enabled": true + } + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobServicesList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobServicesList.json new file mode 100644 index 000000000000..ea401b4bdff1 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobServicesList.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4410", + "accountName": "sto8607", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/blobServices/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/blobServices", + "properties": { + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ], + "allowedMethods": [ + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" + ], + "maxAgeInSeconds": 100, + "exposedHeaders": [ + "x-ms-meta-*" + ], + "allowedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ] + }, + { + "allowedOrigins": [ + "*" + ], + "allowedMethods": [ + "GET" + ], + "maxAgeInSeconds": 2, + "exposedHeaders": [ + "*" + ], + "allowedHeaders": [ + "*" + ] + }, + { + "allowedOrigins": [ + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], + "allowedMethods": [ + "GET", + "PUT" + ], + "maxAgeInSeconds": 2000, + "exposedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x -ms-meta-target*" + ], + "allowedHeaders": [ + "x-ms-meta-12345675754564*" + ] + } + ] + }, + "defaultServiceVersion": "2017-07-29", + "deleteRetentionPolicy": { + "enabled": true, + "days": 300 + }, + "isVersioningEnabled": true, + "changeFeed": { + "enabled": true + } + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobServicesPut.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobServicesPut.json new file mode 100644 index 000000000000..c9c5721201aa --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/BlobServicesPut.json @@ -0,0 +1,169 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4410", + "accountName": "sto8607", + "BlobServicesName": "default", + "api-version": "2020-08-01-preview", + "monitor": "true", + "parameters": { + "properties": { + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ], + "allowedMethods": [ + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" + ], + "maxAgeInSeconds": 100, + "exposedHeaders": [ + "x-ms-meta-*" + ], + "allowedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ] + }, + { + "allowedOrigins": [ + "*" + ], + "allowedMethods": [ + "GET" + ], + "maxAgeInSeconds": 2, + "exposedHeaders": [ + "*" + ], + "allowedHeaders": [ + "*" + ] + }, + { + "allowedOrigins": [ + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], + "allowedMethods": [ + "GET", + "PUT" + ], + "maxAgeInSeconds": 2000, + "exposedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x -ms-meta-target*" + ], + "allowedHeaders": [ + "x-ms-meta-12345675754564*" + ] + } + ] + }, + "defaultServiceVersion": "2017-07-29", + "deleteRetentionPolicy": { + "enabled": true, + "days": 300 + }, + "isVersioningEnabled": true, + "changeFeed": { + "enabled": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/blobServices/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/blobServices", + "properties": { + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ], + "allowedMethods": [ + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" + ], + "maxAgeInSeconds": 100, + "exposedHeaders": [ + "x-ms-meta-*" + ], + "allowedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ] + }, + { + "allowedOrigins": [ + "*" + ], + "allowedMethods": [ + "GET" + ], + "maxAgeInSeconds": 2, + "exposedHeaders": [ + "*" + ], + "allowedHeaders": [ + "*" + ] + }, + { + "allowedOrigins": [ + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], + "allowedMethods": [ + "GET", + "PUT" + ], + "maxAgeInSeconds": 2000, + "exposedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x -ms-meta-target*" + ], + "allowedHeaders": [ + "x-ms-meta-12345675754564*" + ] + } + ] + }, + "defaultServiceVersion": "2017-07-29", + "deleteRetentionPolicy": { + "enabled": true, + "days": 300 + }, + "isVersioningEnabled": true, + "changeFeed": { + "enabled": true + } + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/DeletedAccountGet.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/DeletedAccountGet.json new file mode 100644 index 000000000000..ba101108e6a1 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/DeletedAccountGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "deletedAccountName": "sto1125", + "location": "eastus", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/providers/Microsoft.Storage/locations/eastus/deletedAccounts/sto1125", + "name": "sto1125", + "type": "Microsoft.Storage/deletedAccounts", + "properties": { + "storageAccountResourceId": "/subscriptions/{subscription-id}/resourceGroups/sto/providers/Microsoft.Storage/storageAccounts/sto1125", + "location": "eastus", + "restoreReference": "sto1125|2020-08-17T03:35:37.4588848Z", + "creationTime": "2020-08-17T03:35:37.4588848Z", + "deletionTime": "2020-08-17T04:41:37.3442475Z" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/DeletedAccountList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/DeletedAccountList.json new file mode 100644 index 000000000000..349a61b71f5f --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/DeletedAccountList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/providers/Microsoft.Storage/locations/eastus/deletedAccounts/sto1125", + "name": "sto1125", + "type": "Microsoft.Storage/deletedAccounts", + "properties": { + "storageAccountResourceId": "/subscriptions/{subscription-id}/resourceGroups/sto/providers/Microsoft.Storage/storageAccounts/sto1125", + "location": "eastus", + "restoreReference": "sto1125|2020-08-17T03:35:37.4588848Z", + "creationTime": "2020-08-17T03:35:37.4588848Z", + "deletionTime": "2020-08-17T04:41:37.3442475Z" + } + }, + { + "id": "/subscriptions/{subscription-id}/providers/Microsoft.Storage/locations/eastus/deletedAccounts/sto1126", + "name": "sto1126", + "type": "Microsoft.Storage/deletedAccounts", + "properties": { + "storageAccountResourceId": "/subscriptions/{subscription-id}/resourceGroups/sto/providers/Microsoft.Storage/storageAccounts/sto1126", + "location": "eastus", + "restoreReference": "sto1126|2020-08-17T03:35:37.4588848Z", + "creationTime": "2020-08-19T15:10:21.5902165Z", + "deletionTime": "2020-08-20T06:11:55.1957302Z" + } + } + ] + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/DeletedBlobContainersList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/DeletedBlobContainersList.json new file mode 100644 index 000000000000..07187362cf95 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/DeletedBlobContainersList.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9290", + "accountName": "sto1590", + "$include": "deleted", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/blobServices/default/containers/container1644", + "name": "container1644", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers", + "etag": "\"0x8D589847D51C7DE\"", + "properties": { + "publicAccess": "Container", + "leaseStatus": "Unlocked", + "leaseState": "Available", + "lastModifiedTime": "2018-03-14T08:20:47Z", + "hasImmutabilityPolicy": false, + "hasLegalHold": false + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/blobServices/default/containers/container4052", + "name": "container4052", + "type": "Microsoft.Storage/storageAccounts/blobServices/containers", + "etag": "\"0x8D589847DAB5AF9\"", + "properties": { + "publicAccess": "None", + "leaseStatus": "Unlocked", + "leaseState": "Expired", + "lastModifiedTime": "2018-03-14T08:20:47Z", + "hasImmutabilityPolicy": false, + "hasLegalHold": false, + "version": "1234567890", + "deleted": true, + "deletedTime": "2019-12-14T08:20:47Z", + "remainingRetentionDays": 30 + } + } + ] + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/DeletedFileSharesList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/DeletedFileSharesList.json new file mode 100644 index 000000000000..367bdc496aef --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/DeletedFileSharesList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9290", + "accountName": "sto1590", + "$expand": "deleted", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares/share1644_1234567890", + "name": "share1644", + "type": "Microsoft.Storage/storageAccounts/fileServices/shares", + "etag": "\"0x8D589847D51C7DE\"", + "properties": { + "lastModifiedTime": "2019-05-14T08:20:47Z", + "shareQuota": 1024, + "version": "1234567890", + "deleted": true, + "deletedTime": "2019-12-14T08:20:47Z", + "remainingRetentionDays": 30 + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares/share4052", + "name": "share4052", + "type": "Microsoft.Storage/storageAccounts/fileServices/shares", + "etag": "\"0x8D589847DAB5AF9\"", + "properties": { + "lastModifiedTime": "2019-05-14T08:20:47Z", + "shareQuota": 1024 + } + } + ] + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileServicesGet.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileServicesGet.json new file mode 100644 index 000000000000..8eb74767f742 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileServicesGet.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4410", + "accountName": "sto8607", + "FileServicesName": "default", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/fileServices/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/fileServices", + "properties": { + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ], + "allowedMethods": [ + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" + ], + "maxAgeInSeconds": 100, + "exposedHeaders": [ + "x-ms-meta-*" + ], + "allowedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ] + }, + { + "allowedOrigins": [ + "*" + ], + "allowedMethods": [ + "GET" + ], + "maxAgeInSeconds": 2, + "exposedHeaders": [ + "*" + ], + "allowedHeaders": [ + "*" + ] + }, + { + "allowedOrigins": [ + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], + "allowedMethods": [ + "GET", + "PUT" + ], + "maxAgeInSeconds": 2000, + "exposedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ], + "allowedHeaders": [ + "x-ms-meta-12345675754564*" + ] + } + ] + } + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileServicesList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileServicesList.json new file mode 100644 index 000000000000..35748bd6bbd9 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileServicesList.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9290", + "accountName": "sto1590", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/fileServices/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/fileServices", + "properties": { + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ], + "allowedMethods": [ + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" + ], + "maxAgeInSeconds": 100, + "exposedHeaders": [ + "x-ms-meta-*" + ], + "allowedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ] + }, + { + "allowedOrigins": [ + "*" + ], + "allowedMethods": [ + "GET" + ], + "maxAgeInSeconds": 2, + "exposedHeaders": [ + "*" + ], + "allowedHeaders": [ + "*" + ] + }, + { + "allowedOrigins": [ + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], + "allowedMethods": [ + "GET", + "PUT" + ], + "maxAgeInSeconds": 2000, + "exposedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ], + "allowedHeaders": [ + "x-ms-meta-12345675754564*" + ] + } + ] + } + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileServicesPut.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileServicesPut.json new file mode 100644 index 000000000000..4ec0318cbdb9 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileServicesPut.json @@ -0,0 +1,151 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4410", + "accountName": "sto8607", + "FileServicesName": "default", + "api-version": "2020-08-01-preview", + "monitor": "true", + "parameters": { + "properties": { + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ], + "allowedMethods": [ + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" + ], + "maxAgeInSeconds": 100, + "exposedHeaders": [ + "x-ms-meta-*" + ], + "allowedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ] + }, + { + "allowedOrigins": [ + "*" + ], + "allowedMethods": [ + "GET" + ], + "maxAgeInSeconds": 2, + "exposedHeaders": [ + "*" + ], + "allowedHeaders": [ + "*" + ] + }, + { + "allowedOrigins": [ + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], + "allowedMethods": [ + "GET", + "PUT" + ], + "maxAgeInSeconds": 2000, + "exposedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ], + "allowedHeaders": [ + "x-ms-meta-12345675754564*" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/fileServices/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/fileServices", + "properties": { + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ], + "allowedMethods": [ + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" + ], + "maxAgeInSeconds": 100, + "exposedHeaders": [ + "x-ms-meta-*" + ], + "allowedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ] + }, + { + "allowedOrigins": [ + "*" + ], + "allowedMethods": [ + "GET" + ], + "maxAgeInSeconds": 2, + "exposedHeaders": [ + "*" + ], + "allowedHeaders": [ + "*" + ] + }, + { + "allowedOrigins": [ + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], + "allowedMethods": [ + "GET", + "PUT" + ], + "maxAgeInSeconds": 2000, + "exposedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ], + "allowedHeaders": [ + "x-ms-meta-12345675754564*" + ] + } + ] + } + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesDelete.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesDelete.json new file mode 100644 index 000000000000..5c9c087b70bc --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4079", + "accountName": "sto4506", + "shareName": "share9689", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesGet.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesGet.json new file mode 100644 index 000000000000..40249307aaa9 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9871", + "accountName": "sto6217", + "shareName": "share1634", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634", + "name": "share1634", + "type": "Microsoft.Storage/storageAccounts/fileServices/shares", + "etag": "\"0x8D592D74CC20EBA\"", + "properties": { + "lastModifiedTime": "2019-05-26T05:06:14Z", + "shareQuota": 1024 + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesGet_Stats.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesGet_Stats.json new file mode 100644 index 000000000000..1e1bcb64860f --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesGet_Stats.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9871", + "accountName": "sto6217", + "shareName": "share1634", + "$expand": "stats", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634", + "name": "share1634", + "type": "Microsoft.Storage/storageAccounts/fileServices/shares", + "etag": "\"0x8D592D74CC20EBA\"", + "properties": { + "lastModifiedTime": "2019-05-26T05:06:14Z", + "shareQuota": 1024, + "shareUsageBytes": 652945 + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesList.json new file mode 100644 index 000000000000..c14b8688d0af --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9290", + "accountName": "sto1590", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares/share1644", + "name": "share1644", + "type": "Microsoft.Storage/storageAccounts/fileServices/shares", + "etag": "\"0x8D589847D51C7DE\"", + "properties": { + "lastModifiedTime": "2019-05-14T08:20:47Z", + "shareQuota": 1024 + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares/share4052", + "name": "share4052", + "type": "Microsoft.Storage/storageAccounts/fileServices/shares", + "etag": "\"0x8D589847DAB5AF9\"", + "properties": { + "lastModifiedTime": "2019-05-14T08:20:47Z", + "shareQuota": 1024 + } + } + ], + "nextLink": "https://sto1590endpoint/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/fileServices/default/shares?api-version=2020-08-01-preview&$maxpagesize=2&$skipToken=/sto1590/share5103" + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesPatch.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesPatch.json new file mode 100644 index 000000000000..874b847a9066 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesPatch.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "shareName": "share6185", + "api-version": "2020-08-01-preview", + "monitor": "true", + "fileShare": { + "properties": { + "metadata": { + "type": "image" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185", + "name": "share6185", + "type": "Microsoft.Storage/storageAccounts/fileServices/shares", + "properties": { + "metadata": { + "type": "image" + } + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesPut.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesPut.json new file mode 100644 index 000000000000..7e5874fbd6ec --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesPut.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "shareName": "share6185", + "api-version": "2020-08-01-preview", + "monitor": "true", + "fileShare": {} + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185", + "name": "share6185", + "type": "Microsoft.Storage/storageAccounts/fileServices/shares" + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185", + "name": "share6185", + "type": "Microsoft.Storage/storageAccounts/fileServices/shares" + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesPut_AccessTier.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesPut_AccessTier.json new file mode 100644 index 000000000000..60f4fcddcdbd --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesPut_AccessTier.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res346", + "accountName": "sto666", + "shareName": "share1235", + "api-version": "2020-08-01-preview", + "monitor": "true", + "fileShare": { + "properties": { + "accessTier": "Hot" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235", + "name": "share1235", + "type": "Microsoft.Storage/storageAccounts/fileServices/shares", + "properties": { + "accessTier": "Hot" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235", + "name": "share1235", + "type": "Microsoft.Storage/storageAccounts/fileServices/shares", + "properties": { + "accessTier": "Hot" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesPut_NFS.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesPut_NFS.json new file mode 100644 index 000000000000..911098c05a16 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesPut_NFS.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res346", + "accountName": "sto666", + "shareName": "share1235", + "api-version": "2020-08-01-preview", + "monitor": "true", + "fileShare": { + "properties": { + "enabledProtocols": "NFS" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235", + "name": "share1235", + "type": "Microsoft.Storage/storageAccounts/fileServices/shares", + "properties": { + "enabledProtocols": "NFS" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235", + "name": "share1235", + "type": "Microsoft.Storage/storageAccounts/fileServices/shares", + "properties": { + "enabledProtocols": "NFS" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesRestore.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesRestore.json new file mode 100644 index 000000000000..e7f3e769af29 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/FileSharesRestore.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "shareName": "share1249", + "deletedShare": { + "deletedShareName": "share1249", + "deletedShareVersion": "1234567890" + }, + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": {} + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/OperationsList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/OperationsList.json new file mode 100644 index 000000000000..0cae850d4c35 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/OperationsList.json @@ -0,0 +1,473 @@ +{ + "parameters": { + "api-version": "2020-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Storage/storageAccounts/write", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "Create/Update Storage Account", + "description": "Creates a storage account with the specified parameters or update the properties or tags or adds custom domain for the specified storage account." + } + }, + { + "name": "Microsoft.Storage/storageAccounts/delete", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "Delete Storage Account", + "description": "Deletes an existing storage account." + } + }, + { + "name": "Microsoft.Storage/storageAccounts/listkeys/action", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "List Storage Account Keys", + "description": "Returns the access keys for the specified storage account." + } + }, + { + "name": "Microsoft.Storage/storageAccounts/regeneratekey/action", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "Regenerate Storage Account Keys", + "description": "Regenerates the access keys for the specified storage account." + } + }, + { + "name": "Microsoft.Storage/checknameavailability/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Name Availability", + "operation": "Check Name Availability", + "description": "Checks that account name is valid and is not in use." + } + }, + { + "name": "Microsoft.Storage/storageAccounts/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "List/Get Storage Account(s)", + "description": "Returns the list of storage accounts or gets the properties for the specified storage account." + } + }, + { + "name": "Microsoft.Storage/usages/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Usage Metrics", + "operation": "Get Subscription Usages", + "description": "Returns the limit and the current usage count for resources in the specified subscription" + } + }, + { + "name": "Microsoft.Storage/storageAccounts/listAccountSas/action", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Account SAS Token", + "operation": "Returns Storage Account SAS Token", + "description": "Returns the Account SAS token for the specified storage account." + } + }, + { + "name": "Microsoft.Storage/storageAccounts/listServiceSas/action", + "display": { + "provider": "Microsoft Storage", + "resource": "Returns the Service SAS token for the specified storage account.", + "operation": "Returns Storage Service SAS Token", + "description": "Storage Service SAS Token" + } + }, + { + "name": "Microsoft.Storage/locations/deleteVirtualNetworkOrSubnets/action", + "display": { + "provider": "Microsoft Storage", + "resource": "Location", + "operation": "Delete virtual network or subnets notifications", + "description": "Notifies Microsoft.Storage that virtual network or subnet is being deleted" + } + }, + { + "name": "Microsoft.Storage/operations/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Operations", + "operation": "Poll Asynchronous Operation", + "description": "Polls the status of an asynchronous operation." + } + }, + { + "name": "Microsoft.Storage/register/action", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Resource Provider", + "operation": "Registers the Storage Resource Provider", + "description": "Registers the subscription for the storage resource provider and enables the creation of storage accounts." + } + }, + { + "name": "Microsoft.Storage/skus/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Skus", + "operation": "List Skus", + "description": "Lists the Skus supported by Microsoft.Storage." + } + }, + { + "name": "Microsoft.Storage/storageAccounts/services/diagnosticSettings/write", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "Create/Update Diagnostic Settings", + "description": "Create/Update storage account diagnostic settings." + } + }, + { + "name": "Microsoft.Storage/storageAccounts/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "Get list of Microsoft Storage Metrics definitions", + "description": "Get list of Microsoft Storage Metrics definitions." + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "UsedCapacity", + "displayName": "Used capacity", + "displayDescription": "Account used capacity", + "unit": "Bytes", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity", + "resourceIdDimensionNameOverride": "AccountResourceId" + } + ] + } + } + }, + { + "name": "Microsoft.Storage/storageAccounts/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Storage", + "resource": "Storage Accounts", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/blobServices/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Blob service", + "operation": "Get list of Microsoft Storage Metrics definitions", + "description": "Get list of Microsoft Storage Metrics definitions." + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "BlobCapacity", + "displayName": "Blob Capacity", + "displayDescription": "The amount of storage used by the storage account’s Blob service in bytes.", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [ + { + "name": "BlobType", + "displayName": "Blob type" + } + ], + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "BlobCount", + "displayName": "Blob Count", + "displayDescription": "The number of Blob in the storage account’s Blob service.", + "unit": "Count", + "aggregationType": "Average", + "dimensions": [ + { + "name": "BlobType", + "displayName": "Blob type" + } + ], + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "ContainerCount", + "displayName": "Blob Container Count", + "displayDescription": "The number of containers in the storage account’s Blob service.", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "BlobProvisionedSize", + "displayName": "Blob Provisioned Size", + "displayDescription": "The amount of storage provisioned in the storage account’s Blob service in bytes.", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [ + { + "name": "BlobType", + "displayName": "Blob type" + } + ], + "fillGapWithZero": false, + "category": "Capacity" + } + ] + } + } + }, + { + "name": "Microsoft.Storage/storageAccounts/blobServices/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Blob service", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/blobServices/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Storage", + "resource": "Blob service", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/tableServices/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Table service", + "operation": "Get list of Microsoft Storage Metrics definitions", + "description": "Get list of Microsoft Storage Metrics definitions." + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "TableCapacity", + "displayName": "Table Capacity", + "displayDescription": "The amount of storage used by the storage account’s Table service in bytes.", + "unit": "Bytes", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "TableCount", + "displayName": "Table Count", + "displayDescription": "The number of table in the storage account’s Table service.", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "TableEntityCount", + "displayName": "Table Entity Count", + "displayDescription": "The number of table entities in the storage account’s Table service.", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + } + ] + } + } + }, + { + "name": "Microsoft.Storage/storageAccounts/tableServices/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Table service", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/tableServices/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Storage", + "resource": "Table service", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/queueServices/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Queue service", + "operation": "Get list of Microsoft Storage Metrics definitions", + "description": "Get list of Microsoft Storage Metrics definitions." + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "QueueCapacity", + "displayName": "Queue Capacity", + "displayDescription": "The amount of storage used by the storage account’s Queue service in bytes.", + "unit": "Bytes", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "QueueCount", + "displayName": "Queue Count", + "displayDescription": "The number of queue in the storage account’s Queue service.", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "QueueMessageCount", + "displayName": "Queue Message Count", + "displayDescription": "The approximate number of queue messages in the storage account’s Queue service.", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + } + ] + } + } + }, + { + "name": "Microsoft.Storage/storageAccounts/queueServices/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Storage", + "resource": "Queue service", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/queueServices/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Storage", + "resource": "Queue service", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/fileServices/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Storage", + "resource": "File service", + "operation": "Get list of Microsoft Storage Metrics definitions", + "description": "Get list of Microsoft Storage Metrics definitions." + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "FileCapacity", + "displayName": "File Capacity", + "displayDescription": "The amount of storage used by the storage account’s File service in bytes.", + "unit": "Bytes", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "FileProvisionedSize", + "displayName": "File Provisioned Size", + "displayDescription": "The amount of storage provisioned in the storage account’s File service in bytes.", + "unit": "Bytes", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "FileCount", + "displayName": "File Count", + "displayDescription": "The number of file in the storage account’s File service.", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + }, + { + "name": "FileShareCount", + "displayName": "File Share Count", + "displayDescription": "The number of file shares in the storage account’s File service.", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": false, + "category": "Capacity" + } + ] + } + } + }, + { + "name": "Microsoft.Storage/storageAccounts/fileServices/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Storage", + "resource": "File service", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Storage/storageAccounts/fileServices/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Storage", + "resource": "File service", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + } + ] + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationDelete.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationDelete.json new file mode 100644 index 000000000000..a5bdc3c353a4 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "queueName": "queue6185", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "204": {} + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationGet.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationGet.json new file mode 100644 index 000000000000..9bdc029019f2 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "queueName": "queue6185", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/queueServices/default/queues/queue6185", + "name": "queue6185", + "type": "Microsoft.Storage/storageAccounts/queueServices/queues", + "properties": { + "metadata": { + "sample1": "meta1", + "sample2": "meta2" + } + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationList.json new file mode 100644 index 000000000000..a4d26ef075b0 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9290", + "accountName": "sto328", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/queueServices/default/queues/queue6185", + "name": "queue6185", + "type": "Microsoft.Storage/storageAccounts/queueServices/queues", + "properties": { + "metadata": { + "sample1": "meta1", + "sample2": "meta2" + } + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/queueServices/default/queues/queue6186", + "name": "queue6186", + "type": "Microsoft.Storage/storageAccounts/queueServices/queues", + "properties": { + "metadata": { + "sample1": "meta1", + "sample2": "meta2" + } + } + } + ], + "nextLink": "https://sto1590endpoint/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto328/queueServices/default/queues?api-version=2020-08-01-preview&$maxpagesize=2&$skipToken=/sto328/queue6187" + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationPatch.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationPatch.json new file mode 100644 index 000000000000..b662a6e6fc0b --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationPatch.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "queueName": "queue6185", + "api-version": "2020-08-01-preview", + "monitor": "true", + "queue": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/queueServices/default/queues/queue6185", + "name": "queue6185", + "type": "Microsoft.Storage/storageAccounts/queueServices/queues" + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationPut.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationPut.json new file mode 100644 index 000000000000..b662a6e6fc0b --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationPut.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "queueName": "queue6185", + "api-version": "2020-08-01-preview", + "monitor": "true", + "queue": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/queueServices/default/queues/queue6185", + "name": "queue6185", + "type": "Microsoft.Storage/storageAccounts/queueServices/queues" + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationPutWithMetadata.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationPutWithMetadata.json new file mode 100644 index 000000000000..715f0a90e034 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueOperationPutWithMetadata.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "queueName": "queue6185", + "api-version": "2020-08-01-preview", + "monitor": "true", + "queue": { + "properties": { + "metadata": { + "sample1": "meta1", + "sample2": "meta2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/queueServices/default/queues/queue6185", + "name": "queue6185", + "type": "Microsoft.Storage/storageAccounts/queueServices/queues", + "properties": { + "metadata": { + "sample1": "meta1", + "sample2": "meta2" + } + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueServicesGet.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueServicesGet.json new file mode 100644 index 000000000000..57674fe2aa55 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueServicesGet.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4410", + "accountName": "sto8607", + "queueServiceName": "default", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/queueServices/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/queueServices", + "properties": { + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ], + "allowedMethods": [ + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" + ], + "maxAgeInSeconds": 100, + "exposedHeaders": [ + "x-ms-meta-*" + ], + "allowedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ] + }, + { + "allowedOrigins": [ + "*" + ], + "allowedMethods": [ + "GET" + ], + "maxAgeInSeconds": 2, + "exposedHeaders": [ + "*" + ], + "allowedHeaders": [ + "*" + ] + }, + { + "allowedOrigins": [ + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], + "allowedMethods": [ + "GET", + "PUT" + ], + "maxAgeInSeconds": 2000, + "exposedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ], + "allowedHeaders": [ + "x-ms-meta-12345675754564*" + ] + } + ] + } + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueServicesList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueServicesList.json new file mode 100644 index 000000000000..9856b332de60 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueServicesList.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9290", + "accountName": "sto1590", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/queueServices/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/queueServices", + "properties": { + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ], + "allowedMethods": [ + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" + ], + "maxAgeInSeconds": 100, + "exposedHeaders": [ + "x-ms-meta-*" + ], + "allowedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ] + }, + { + "allowedOrigins": [ + "*" + ], + "allowedMethods": [ + "GET" + ], + "maxAgeInSeconds": 2, + "exposedHeaders": [ + "*" + ], + "allowedHeaders": [ + "*" + ] + }, + { + "allowedOrigins": [ + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], + "allowedMethods": [ + "GET", + "PUT" + ], + "maxAgeInSeconds": 2000, + "exposedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ], + "allowedHeaders": [ + "x-ms-meta-12345675754564*" + ] + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueServicesPut.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueServicesPut.json new file mode 100644 index 000000000000..19b5de24e288 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/QueueServicesPut.json @@ -0,0 +1,147 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4410", + "accountName": "sto8607", + "queueServiceName": "default", + "api-version": "2020-08-01-preview", + "monitor": "true", + "parameters": { + "properties": { + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ], + "allowedMethods": [ + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" + ], + "maxAgeInSeconds": 100, + "exposedHeaders": [ + "x-ms-meta-*" + ], + "allowedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ] + }, + { + "allowedOrigins": [ + "*" + ], + "allowedMethods": [ + "GET" + ], + "maxAgeInSeconds": 2, + "exposedHeaders": [ + "*" + ], + "allowedHeaders": [ + "*" + ] + }, + { + "allowedOrigins": [ + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], + "allowedMethods": [ + "GET", + "PUT" + ], + "maxAgeInSeconds": 2000, + "exposedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ], + "allowedHeaders": [ + "x-ms-meta-12345675754564*" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/queueServices/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/queueServices", + "properties": { + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ], + "allowedMethods": [ + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" + ], + "maxAgeInSeconds": 100, + "exposedHeaders": [ + "x-ms-meta-*" + ], + "allowedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ] + }, + { + "allowedOrigins": [ + "*" + ], + "allowedMethods": [ + "GET" + ], + "maxAgeInSeconds": 2, + "exposedHeaders": [ + "*" + ], + "allowedHeaders": [ + "*" + ] + }, + { + "allowedOrigins": [ + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], + "allowedMethods": [ + "GET", + "PUT" + ], + "maxAgeInSeconds": 2000, + "exposedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ], + "allowedHeaders": [ + "x-ms-meta-12345675754564*" + ] + } + ] + } + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/SKUList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/SKUList.json new file mode 100644 index 000000000000..47724c855202 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/SKUList.json @@ -0,0 +1,6454 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2020-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "true" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2(stage)" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westeurope" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastasia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southeastasia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "japaneast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "japanwest" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "northcentralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southcentralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "northeurope" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "brazilsouth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "australiaeast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "australiasoutheast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "southindia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centralindia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westindia" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "canadaeast" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "canadacentral" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westus2" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "westcentralus" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "true" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uksouth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "ukwest" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "koreacentral" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "koreasouth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uknorth" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "uksouth2" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "false" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "eastus2euap" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_ZRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "Storage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "true" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Premium_LRS", + "tier": "Premium", + "kind": "Storage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_LRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportsarchivepreview", + "value": "false" + }, + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_GRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "true" + } + ], + "restrictions": [] + }, + { + "resourceType": "storageAccounts", + "name": "Standard_RAGRS", + "tier": "Standard", + "kind": "BlobStorage", + "locations": [ + "centraluseuap" + ], + "capabilities": [ + { + "name": "supportschangenotification", + "value": "true" + }, + { + "name": "supportsfileencryption", + "value": "false" + }, + { + "name": "supportshoeboxcapacitymetrics", + "value": "false" + }, + { + "name": "supportsnetworkacls", + "value": "false" + } + ], + "restrictions": [] + } + ] + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCheckNameAvailability.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCheckNameAvailability.json new file mode 100644 index 000000000000..14dea4e1e9f8 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCheckNameAvailability.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2020-08-01-preview", + "accountName": { + "name": "sto3363", + "type": "Microsoft.Storage/storageAccounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCreate.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCreate.json new file mode 100644 index 000000000000..f560f583aac1 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCreate.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9101", + "accountName": "sto4445", + "api-version": "2020-08-01-preview", + "parameters": { + "sku": { + "name": "Standard_GRS" + }, + "kind": "Storage", + "location": "eastus", + "properties": { + "isHnsEnabled": true, + "allowBlobPublicAccess": false, + "minimumTlsVersion": "TLS1_2", + "routingPreference": { + "routingChoice": "MicrosoftRouting", + "publishMicrosoftEndpoints": true, + "publishInternetEndpoints": true + }, + "encryption": { + "services": { + "file": { + "keyType": "Account", + "enabled": true + }, + "blob": { + "keyType": "Account", + "enabled": true + } + }, + "requireInfrastructureEncryption": false, + "keySource": "Microsoft.Storage" + } + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9101/providers/Microsoft.Storage/storageAccounts/sto4445", + "kind": "Storage", + "location": "eastus", + "name": "sto4445", + "properties": { + "isHnsEnabled": true, + "allowBlobPublicAccess": false, + "minimumTlsVersion": "TLS1_2", + "creationTime": "2017-05-24T13:25:33.4863236Z", + "primaryEndpoints": { + "web": "https://sto4445.web.core.windows.net/", + "dfs": "https://sto4445.dfs.core.windows.net/", + "blob": "https://sto4445.blob.core.windows.net/", + "file": "https://sto4445.file.core.windows.net/", + "queue": "https://sto4445.queue.core.windows.net/", + "table": "https://sto4445.table.core.windows.net/", + "microsoftEndpoints": { + "web": "https://sto4445-microsoftrouting.web.core.windows.net/", + "dfs": "https://sto4445-microsoftrouting.dfs.core.windows.net/", + "blob": "https://sto4445-microsoftrouting.blob.core.windows.net/", + "file": "https://sto4445-microsoftrouting.file.core.windows.net/", + "queue": "https://sto4445-microsoftrouting.queue.core.windows.net/", + "table": "https://sto4445-microsoftrouting.table.core.windows.net/" + }, + "internetEndpoints": { + "web": "https://sto4445-internetrouting.web.core.windows.net/", + "dfs": "https://sto4445-internetrouting.dfs.core.windows.net/", + "blob": "https://sto4445-internetrouting.blob.core.windows.net/", + "file": "https://sto4445-internetrouting.file.core.windows.net/" + } + }, + "primaryLocation": "eastus2euap", + "provisioningState": "Succeeded", + "routingPreference": { + "routingChoice": "MicrosoftRouting", + "publishMicrosoftEndpoints": true, + "publishInternetEndpoints": true + }, + "encryption": { + "services": { + "file": { + "keyType": "Account", + "enabled": true, + "lastEnabledTime": "2019-12-11T20:49:31.7036140Z" + }, + "blob": { + "keyType": "Account", + "enabled": true, + "lastEnabledTime": "2019-12-11T20:49:31.7036140Z" + } + }, + "requireInfrastructureEncryption": false, + "keySource": "Microsoft.Storage" + }, + "secondaryLocation": "centraluseuap", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": true + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + } + }, + "202": {} + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCreateObjectReplicationPolicyOnDestination.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCreateObjectReplicationPolicyOnDestination.json new file mode 100644 index 000000000000..921811358da9 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCreateObjectReplicationPolicyOnDestination.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res7687", + "accountName": "dst112", + "objectReplicationPolicyId": "default", + "api-version": "2020-08-01-preview", + "monitor": "true", + "properties": { + "properties": { + "sourceAccount": "src1122", + "destinationAccount": "dst112", + "rules": [ + { + "sourceContainer": "scont139", + "destinationContainer": "dcont139", + "filters": { + "prefixMatch": [ + "blobA", + "blobB" + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7687/providers/Microsoft.Storage/storageAccounts/dst112/objectReplicationPolicies/2a20bb73-5717-4635-985a-5d4cf777438f", + "name": "2a20bb73-5717-4635-985a-5d4cf777438f", + "type": "Microsoft.Storage/storageAccounts/objectReplicationPolicies", + "properties": { + "policyId": "2a20bb73-5717-4635-985a-5d4cf777438f", + "sourceAccount": "src1122", + "destinationAccount": "dst112", + "rules": [ + { + "ruleId": "d5d18a48-8801-4554-aeaa-74faf65f5ef9", + "sourceContainer": "sourceContainer1", + "destinationContainer": "destContainer1", + "filters": { + "prefixMatch": [ + "blobA", + "blobB" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCreateObjectReplicationPolicyOnSource.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCreateObjectReplicationPolicyOnSource.json new file mode 100644 index 000000000000..c651efb45d70 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCreateObjectReplicationPolicyOnSource.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res7687", + "accountName": "src1122", + "objectReplicationPolicyId": "2a20bb73-5717-4635-985a-5d4cf777438f", + "api-version": "2020-08-01-preview", + "monitor": "true", + "properties": { + "properties": { + "sourceAccount": "src1122", + "destinationAccount": "dst112", + "rules": [ + { + "ruleId": "d5d18a48-8801-4554-aeaa-74faf65f5ef9", + "sourceContainer": "scont139", + "destinationContainer": "dcont139", + "filters": { + "prefixMatch": [ + "blobA", + "blobB" + ], + "minCreationTime": "2020-02-19T16:05:00Z" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7687/providers/Microsoft.Storage/storageAccounts/src1122/objectReplicationPolicies/2a20bb73-5717-4635-985a-5d4cf777438f", + "name": "2a20bb73-5717-4635-985a-5d4cf777438f", + "type": "Microsoft.Storage/storageAccounts/objectReplicationPolicies", + "properties": { + "policyId": "2a20bb73-5717-4635-985a-5d4cf777438f", + "enabledTime": "2019-06-08T03:01:55.7168089Z", + "sourceAccount": "src1122", + "destinationAccount": "dst112", + "rules": [ + { + "ruleId": "d5d18a48-8801-4554-aeaa-74faf65f5ef9", + "sourceContainer": "sourceContainer1", + "destinationContainer": "destContainer1", + "filters": { + "prefixMatch": [ + "blobA", + "blobB" + ], + "minCreationTime": "2020-02-19T16:05:00Z" + } + } + ] + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountDelete.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountDelete.json new file mode 100644 index 000000000000..0231254b70e7 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4228", + "accountName": "sto2434", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountDeleteManagementPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountDeleteManagementPolicy.json new file mode 100644 index 000000000000..bc6a3dbaee8b --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountDeleteManagementPolicy.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "managementPolicyName": "default", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountDeleteObjectReplicationPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountDeleteObjectReplicationPolicy.json new file mode 100644 index 000000000000..db976a80fec2 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountDeleteObjectReplicationPolicy.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "objectReplicationPolicyId": "{objectReplicationPolicy-Id}", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountDeletePrivateEndpointConnection.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..2cb4619cc9f1 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountDeletePrivateEndpointConnection.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountEnableAD.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountEnableAD.json new file mode 100644 index 000000000000..609ddf8a2eaa --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountEnableAD.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9407", + "accountName": "sto8596", + "api-version": "2020-08-01-preview", + "monitor": "true", + "parameters": { + "properties": { + "azureFilesIdentityBasedAuthentication": { + "directoryServiceOptions": "AD", + "activeDirectoryProperties": { + "domainName": "adtest.com", + "netBiosDomainName": "adtest.com", + "forestName": "adtest.com", + "domainGuid": "aebfc118-9fa9-4732-a21f-d98e41a77ae1", + "domainSid": "S-1-5-21-2400535526-2334094090-2402026252", + "azureStorageSid": "S-1-5-21-2400535526-2334094090-2402026252-0012" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596", + "kind": "Storage", + "location": "eastus2(stage)", + "name": "sto8596", + "properties": { + "creationTime": "2017-06-01T02:42:41.7633306Z", + "azureFilesIdentityBasedAuthentication": { + "directoryServiceOptions": "AD", + "activeDirectoryProperties": { + "domainName": "adtest.com", + "netBiosDomainName": "adtest.com", + "forestName": "adtest.com", + "domainGuid": "aebfc118-9fa9-4732-a21f-d98e41a77ae1", + "domainSid": "S-1-5-21-2400535526-2334094090-2402026252", + "azureStorageSid": "S-1-5-21-2400535526-2334094090-2402026252-0012" + } + }, + "primaryEndpoints": { + "web": "https://sto8596.web.core.windows.net/", + "dfs": "https://sto8596.dfs.core.windows.net/", + "blob": "https://sto8596.blob.core.windows.net/", + "file": "https://sto8596.file.core.windows.net/", + "queue": "https://sto8596.queue.core.windows.net/", + "table": "https://sto8596.table.core.windows.net/" + }, + "primaryLocation": "eastus2(stage)", + "provisioningState": "Succeeded", + "secondaryLocation": "northcentralus(stage)", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountEnableCMK.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountEnableCMK.json new file mode 100644 index 000000000000..cbc8b711edca --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountEnableCMK.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9407", + "accountName": "sto8596", + "api-version": "2020-08-01-preview", + "monitor": "true", + "parameters": { + "properties": { + "encryption": { + "services": { + "file": { + "keyType": "Account", + "enabled": true + }, + "blob": { + "keyType": "Account", + "enabled": true + } + }, + "keySource": "Microsoft.Keyvault", + "keyvaultproperties": { + "keyvaulturi": "https://myvault8569.vault.azure.net", + "keyname": "wrappingKey", + "keyversion": "" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596", + "identity": { + "principalId": "911871cc-ffd1-4fc4-ac11-7a316433ea66", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "kind": "Storage", + "location": "eastus2(stage)", + "name": "sto8596", + "properties": { + "creationTime": "2017-06-01T02:42:41.7633306Z", + "encryption": { + "services": { + "file": { + "keyType": "Account", + "enabled": true, + "lastEnabledTime": "2019-12-11T20:49:31.7036140Z" + }, + "blob": { + "keyType": "Account", + "enabled": true, + "lastEnabledTime": "2019-12-11T20:49:31.7036140Z" + } + }, + "keySource": "Microsoft.Keyvault", + "keyvaultproperties": { + "keyvaulturi": "https://myvault8569.vault.azure.net", + "keyname": "wrappingKey", + "keyversion": "", + "currentVersionedKeyIdentifier": "https://myvault8569.vault.azure.net/keys/wrappingKey/0682afdd9c104f4285df20107e956cad", + "lastKeyRotationTimestamp": "2019-12-13T20:36:23.7023290Z" + } + }, + "primaryEndpoints": { + "web": "https://sto8596.web.core.windows.net/", + "dfs": "https://sto8596.dfs.core.windows.net/", + "blob": "https://sto8596.blob.core.windows.net/", + "file": "https://sto8596.file.core.windows.net/", + "queue": "https://sto8596.queue.core.windows.net/", + "table": "https://sto8596.table.core.windows.net/" + }, + "primaryLocation": "eastus2(stage)", + "provisioningState": "Succeeded", + "secondaryLocation": "northcentralus(stage)", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountEncryptionScopeList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountEncryptionScopeList.json new file mode 100644 index 000000000000..6a71efff520e --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountEncryptionScopeList.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "resource-group-name", + "accountName": "{storage-account-name}", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/resource-group-name/providers/Microsoft.Storage/storageAccounts/{storage-account-name}/encryptionScopes/scope-1", + "name": "scope-1", + "type": "Microsoft.Storage/storageAccounts/encryptionScopes", + "properties": { + "source": "Microsoft.Storage", + "state": "Enabled", + "creationTime": "2018-10-16T02:42:41.7633306Z", + "lastModifiedTime": "2018-10-16T02:42:41.7633306Z" + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/resource-group-name/providers/Microsoft.Storage/storageAccounts/{storage-account-name}/encryptionScopes/scope-2", + "name": "scope-2", + "type": "Microsoft.Storage/storageAccounts/encryptionScopes", + "properties": { + "source": "Microsoft.KeyVault", + "state": "Enabled", + "keyVaultProperties": { + "keyUri": "https://testvault.vault.core.windows.net/keys/key1/863425f1358359c" + }, + "creationTime": "2018-10-16T04:32:14.3355306Z", + "lastModifiedTime": "2018-10-17T06:23:14.4513306Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountFailover.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountFailover.json new file mode 100644 index 000000000000..d5633f6c53a5 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountFailover.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4228", + "accountName": "sto2434", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetEncryptionScope.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetEncryptionScope.json new file mode 100644 index 000000000000..6ca8edf6f712 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetEncryptionScope.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "resource-group-name", + "accountName": "{storage-account-name}", + "encryptionScopeName": "{encryption-scope-name}", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/resource-group-name/providers/Microsoft.Storage/storageAccounts/{storage-account-name}/encryptionScopes/{encryption-scope-name}", + "name": "{encyrption-scope-name}", + "type": "Microsoft.Storage/storageAccounts/encryptionScopes", + "properties": { + "source": "Microsoft.Storage", + "state": "Enabled", + "creationTime": "2018-10-16T02:42:41.7633306Z", + "lastModifiedTime": "2018-10-16T02:42:41.7633306Z" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetManagementPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetManagementPolicy.json new file mode 100644 index 000000000000..59968b755c34 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetManagementPolicy.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "managementPolicyName": "default", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Storage/storageAccounts/sto288/managementPolicies/default", + "name": "DefaultManagementPolicy", + "type": "Microsoft.Storage/storageAccounts/managementPolicies", + "properties": { + "policy": { + "rules": [ + { + "enabled": true, + "name": "olcmtest", + "type": "Lifecycle", + "definition": { + "filters": { + "blobTypes": [ + "blockBlob" + ], + "prefixMatch": [ + "olcmtestcontainer" + ] + }, + "actions": { + "baseBlob": { + "tierToCool": { + "daysAfterModificationGreaterThan": 30 + }, + "tierToArchive": { + "daysAfterModificationGreaterThan": 90 + }, + "delete": { + "daysAfterModificationGreaterThan": 1000 + } + }, + "snapshot": { + "delete": { + "daysAfterCreationGreaterThan": 30 + } + } + } + } + } + ] + }, + "lastModifiedTime": "2018-06-08T03:01:55.7168089Z" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetObjectReplicationPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetObjectReplicationPolicy.json new file mode 100644 index 000000000000..4418839a88e8 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetObjectReplicationPolicy.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "objectReplicationPolicyId": "{objectReplicationPolicy-Id}", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/objectReplicationPolicies/{objectReplicationPolicy-Id}", + "name": "{objectReplicationPolicy-Id}", + "type": "Microsoft.Storage/storageAccounts/objectReplicationPolicies", + "properties": { + "policyId": "{objectReplicationPolicy-Id}", + "enabledTime": "2019-06-08T03:01:55.7168089Z", + "sourceAccount": "sto2527", + "destinationAccount": "destAccount1", + "rules": [ + { + "sourceContainer": "sourceContainer1", + "destinationContainer": "destContainer1", + "filters": { + "prefixMatch": [ + "blobA", + "blobB" + ] + } + }, + { + "sourceContainer": "sourceContainer1", + "destinationContainer": "destContainer1", + "filters": { + "prefixMatch": [ + "blobC", + "blobD" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetPrivateEndpointConnection.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..a75298ddc6a7 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetPrivateEndpointConnection.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Storage/storageAccounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.Storage/storageAccounts/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionRequired": "None" + } + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetProperties.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetProperties.json new file mode 100644 index 000000000000..5fe7647f8058 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetProperties.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9407", + "accountName": "sto8596", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596", + "kind": "Storage", + "location": "eastus2(stage)", + "name": "sto8596", + "properties": { + "geoReplicationStats": { + "status": "Live", + "lastSyncTime": "2018-10-30T00:25:34Z", + "canFailover": true + }, + "isHnsEnabled": true, + "creationTime": "2017-06-01T02:42:41.7633306Z", + "networkAcls": { + "bypass": "AzureServices", + "defaultAction": "Allow", + "ipRules": [], + "virtualNetworkRules": [] + }, + "primaryEndpoints": { + "web": "https://sto8596.web.core.windows.net/", + "dfs": "https://sto8596.dfs.core.windows.net/", + "blob": "https://sto8596.blob.core.windows.net/", + "file": "https://sto8596.file.core.windows.net/", + "queue": "https://sto8596.queue.core.windows.net/", + "table": "https://sto8596.table.core.windows.net/", + "microsoftEndpoints": { + "web": "https://sto8596-microsoftrouting.web.core.windows.net/", + "dfs": "https://sto8596-microsoftrouting.dfs.core.windows.net/", + "blob": "https://sto8596-microsoftrouting.blob.core.windows.net/", + "file": "https://sto8596-microsoftrouting.file.core.windows.net/", + "queue": "https://sto8596-microsoftrouting.queue.core.windows.net/", + "table": "https://sto8596-microsoftrouting.table.core.windows.net/" + }, + "internetEndpoints": { + "web": "https://sto8596-internetrouting.web.core.windows.net/", + "dfs": "https://sto8596-internetrouting.dfs.core.windows.net/", + "blob": "https://sto8596-internetrouting.blob.core.windows.net/", + "file": "https://sto8596-internetrouting.file.core.windows.net/" + } + }, + "primaryLocation": "eastus2(stage)", + "provisioningState": "Succeeded", + "routingPreference": { + "routingChoice": "MicrosoftRouting", + "publishMicrosoftEndpoints": true, + "publishInternetEndpoints": true + }, + "encryption": { + "services": { + "file": { + "keyType": "Account", + "enabled": true, + "lastEnabledTime": "2019-12-11T20:49:31.7036140Z" + }, + "blob": { + "keyType": "Account", + "enabled": true, + "lastEnabledTime": "2019-12-11T20:49:31.7036140Z" + } + }, + "keySource": "Microsoft.Storage" + }, + "secondaryLocation": "northcentralus(stage)", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetPropertiesCMKEnabled.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetPropertiesCMKEnabled.json new file mode 100644 index 000000000000..5554a5a31755 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetPropertiesCMKEnabled.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9407", + "accountName": "sto8596", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596", + "identity": { + "principalId": "911871cc-ffd1-4fc4-ac11-7a316433ea66", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "kind": "Storage", + "location": "eastus2(stage)", + "name": "sto8596", + "properties": { + "geoReplicationStats": { + "status": "Live", + "lastSyncTime": "2018-10-30T00:25:34Z", + "canFailover": true + }, + "isHnsEnabled": true, + "creationTime": "2017-06-01T02:42:41.7633306Z", + "networkAcls": { + "bypass": "AzureServices", + "defaultAction": "Allow", + "ipRules": [], + "virtualNetworkRules": [] + }, + "primaryEndpoints": { + "web": "https://sto8596.web.core.windows.net/", + "dfs": "https://sto8596.dfs.core.windows.net/", + "blob": "https://sto8596.blob.core.windows.net/", + "file": "https://sto8596.file.core.windows.net/", + "queue": "https://sto8596.queue.core.windows.net/", + "table": "https://sto8596.table.core.windows.net/", + "microsoftEndpoints": { + "web": "https://sto8596-microsoftrouting.web.core.windows.net/", + "dfs": "https://sto8596-microsoftrouting.dfs.core.windows.net/", + "blob": "https://sto8596-microsoftrouting.blob.core.windows.net/", + "file": "https://sto8596-microsoftrouting.file.core.windows.net/", + "queue": "https://sto8596-microsoftrouting.queue.core.windows.net/", + "table": "https://sto8596-microsoftrouting.table.core.windows.net/" + }, + "internetEndpoints": { + "web": "https://sto8596-internetrouting.web.core.windows.net/", + "dfs": "https://sto8596-internetrouting.dfs.core.windows.net/", + "blob": "https://sto8596-internetrouting.blob.core.windows.net/", + "file": "https://sto8596-internetrouting.file.core.windows.net/" + } + }, + "primaryLocation": "eastus2(stage)", + "provisioningState": "Succeeded", + "routingPreference": { + "routingChoice": "MicrosoftRouting", + "publishMicrosoftEndpoints": true, + "publishInternetEndpoints": true + }, + "encryption": { + "services": { + "file": { + "keyType": "Account", + "enabled": true, + "lastEnabledTime": "2019-12-11T20:49:31.7036140Z" + }, + "blob": { + "keyType": "Account", + "enabled": true, + "lastEnabledTime": "2019-12-11T20:49:31.7036140Z" + } + }, + "keySource": "Microsoft.Keyvault", + "keyvaultproperties": { + "keyvaulturi": "https://myvault8569.vault.azure.net", + "keyname": "wrappingKey", + "keyversion": "", + "currentVersionedKeyIdentifier": "https://myvault8569.vault.azure.net/keys/wrappingKey/0682afdd9c104f4285df20107e956cad", + "lastKeyRotationTimestamp": "2019-12-13T20:36:23.7023290Z" + } + }, + "secondaryLocation": "northcentralus(stage)", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountList.json new file mode 100644 index 000000000000..4744fc9baf61 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountList.json @@ -0,0 +1,307 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res2627/providers/Microsoft.Storage/storageAccounts/sto1125", + "kind": "Storage", + "location": "eastus", + "name": "sto1125", + "properties": { + "isHnsEnabled": true, + "creationTime": "2017-05-24T13:28:53.4540398Z", + "primaryEndpoints": { + "web": "https://sto1125.web.core.windows.net/", + "dfs": "https://sto1125.dfs.core.windows.net/", + "blob": "https://sto1125.blob.core.windows.net/", + "file": "https://sto1125.file.core.windows.net/", + "queue": "https://sto1125.queue.core.windows.net/", + "table": "https://sto1125.table.core.windows.net/", + "microsoftEndpoints": { + "web": "https://sto1125-microsoftrouting.web.core.windows.net/", + "dfs": "https://sto1125-microsoftrouting.dfs.core.windows.net/", + "blob": "https://sto1125-microsoftrouting.blob.core.windows.net/", + "file": "https://sto1125-microsoftrouting.file.core.windows.net/", + "queue": "https://sto1125-microsoftrouting.queue.core.windows.net/", + "table": "https://sto1125-microsoftrouting.table.core.windows.net/" + }, + "internetEndpoints": { + "web": "https://sto1125-internetrouting.web.core.windows.net/", + "dfs": "https://sto1125-internetrouting.dfs.core.windows.net/", + "blob": "https://sto1125-internetrouting.blob.core.windows.net/", + "file": "https://sto1125-internetrouting.file.core.windows.net/" + } + }, + "primaryLocation": "eastus", + "provisioningState": "Succeeded", + "routingPreference": { + "routingChoice": "MicrosoftRouting", + "publishMicrosoftEndpoints": true, + "publishInternetEndpoints": true + }, + "encryption": { + "services": { + "file": { + "keyType": "Account", + "enabled": true, + "lastEnabledTime": "2019-12-11T20:49:31.7036140Z" + }, + "blob": { + "keyType": "Account", + "enabled": true, + "lastEnabledTime": "2019-12-11T20:49:31.7036140Z" + } + }, + "keySource": "Microsoft.Storage" + }, + "secondaryLocation": "centraluseuap", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/testcmk3/providers/Microsoft.Storage/storageAccounts/sto3699", + "identity": { + "principalId": "356d057d-cba5-44dd-8a30-b2e547bc416b", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "kind": "Storage", + "location": "eastus", + "name": "sto3699", + "properties": { + "creationTime": "2017-05-24T10:06:30.6093014Z", + "primaryEndpoints": { + "blob": "https://sto3699.blob.core.windows.net/", + "file": "https://sto3699.file.core.windows.net/", + "queue": "https://sto3699.queue.core.windows.net/", + "table": "https://sto3699.table.core.windows.net/" + }, + "primaryLocation": "eastus", + "provisioningState": "Succeeded", + "secondaryLocation": "centraluseuap", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596", + "identity": { + "principalId": "911871cc-ffd1-4fc4-ac11-7a316433ea66", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "kind": "Storage", + "location": "eastus2(stage)", + "name": "sto8596", + "properties": { + "geoReplicationStats": { + "status": "Live", + "lastSyncTime": "2018-10-30T00:25:34Z", + "canFailover": true + }, + "isHnsEnabled": true, + "creationTime": "2017-06-01T02:42:41.7633306Z", + "networkAcls": { + "bypass": "AzureServices", + "defaultAction": "Allow", + "ipRules": [], + "virtualNetworkRules": [] + }, + "primaryEndpoints": { + "web": "https://sto8596.web.core.windows.net/", + "dfs": "https://sto8596.dfs.core.windows.net/", + "blob": "https://sto8596.blob.core.windows.net/", + "file": "https://sto8596.file.core.windows.net/", + "queue": "https://sto8596.queue.core.windows.net/", + "table": "https://sto8596.table.core.windows.net/", + "microsoftEndpoints": { + "web": "https://sto8596-microsoftrouting.web.core.windows.net/", + "dfs": "https://sto8596-microsoftrouting.dfs.core.windows.net/", + "blob": "https://sto8596-microsoftrouting.blob.core.windows.net/", + "file": "https://sto8596-microsoftrouting.file.core.windows.net/", + "queue": "https://sto8596-microsoftrouting.queue.core.windows.net/", + "table": "https://sto8596-microsoftrouting.table.core.windows.net/" + }, + "internetEndpoints": { + "web": "https://sto8596-internetrouting.web.core.windows.net/", + "dfs": "https://sto8596-internetrouting.dfs.core.windows.net/", + "blob": "https://sto8596-internetrouting.blob.core.windows.net/", + "file": "https://sto8596-internetrouting.file.core.windows.net/" + } + }, + "primaryLocation": "eastus2(stage)", + "provisioningState": "Succeeded", + "routingPreference": { + "routingChoice": "MicrosoftRouting", + "publishMicrosoftEndpoints": true, + "publishInternetEndpoints": true + }, + "encryption": { + "services": { + "file": { + "keyType": "Account", + "enabled": true, + "lastEnabledTime": "2019-12-11T20:49:31.7036140Z" + }, + "blob": { + "keyType": "Account", + "enabled": true, + "lastEnabledTime": "2019-12-11T20:49:31.7036140Z" + } + }, + "keySource": "Microsoft.Keyvault", + "keyvaultproperties": { + "keyvaulturi": "https://myvault8569.vault.azure.net", + "keyname": "wrappingKey", + "keyversion": "", + "currentVersionedKeyIdentifier": "https://myvault8569.vault.azure.net/keys/wrappingKey/0682afdd9c104f4285df20107e956cad", + "lastKeyRotationTimestamp": "2019-12-13T20:36:23.7023290Z" + } + }, + "secondaryLocation": "northcentralus(stage)", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/testcmk3/providers/Microsoft.Storage/storageAccounts/sto6637", + "identity": { + "principalId": "911871cc-ffd1-4fc4-ac11-7a316433ea66", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "kind": "Storage", + "location": "eastus", + "name": "sto6637", + "properties": { + "creationTime": "2017-05-24T10:09:39.5625175Z", + "primaryEndpoints": { + "blob": "https://sto6637.blob.core.windows.net/", + "file": "https://sto6637.file.core.windows.net/", + "queue": "https://sto6637.queue.core.windows.net/", + "table": "https://sto6637.table.core.windows.net/" + }, + "primaryLocation": "eastus", + "provisioningState": "Succeeded", + "secondaryLocation": "centraluseuap", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res8186/providers/Microsoft.Storage/storageAccounts/sto834", + "kind": "Storage", + "location": "eastus", + "name": "sto834", + "properties": { + "creationTime": "2017-05-24T13:28:20.8686541Z", + "primaryEndpoints": { + "blob": "https://sto834.blob.core.windows.net/", + "file": "https://sto834.file.core.windows.net/", + "queue": "https://sto834.queue.core.windows.net/", + "table": "https://sto834.table.core.windows.net/" + }, + "primaryLocation": "eastus", + "provisioningState": "Succeeded", + "secondaryLocation": "centraluseuap", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/testcmk3/providers/Microsoft.Storage/storageAccounts/sto9174", + "identity": { + "principalId": "933e3ddf-1802-4a51-9469-18a33b576f88", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + }, + "kind": "Storage", + "location": "eastus", + "name": "sto9174", + "properties": { + "creationTime": "2017-05-24T09:46:19.6556989Z", + "primaryEndpoints": { + "blob": "https://sto9174.blob.core.windows.net/", + "file": "https://sto9174.file.core.windows.net/", + "queue": "https://sto9174.queue.core.windows.net/", + "table": "https://sto9174.table.core.windows.net/" + }, + "primaryLocation": "eastus", + "provisioningState": "Succeeded", + "secondaryLocation": "centraluseuap", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + } + ] + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListAccountSAS.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListAccountSAS.json new file mode 100644 index 000000000000..eaa3cc5ab9de --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListAccountSAS.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res7985", + "accountName": "sto8588", + "api-version": "2020-08-01-preview", + "monitor": "true", + "parameters": { + "signedServices": "b", + "signedResourceTypes": "s", + "signedPermission": "r", + "signedProtocol": "https,http", + "signedStart": "2017-05-24T10:42:03.1567373Z", + "signedExpiry": "2017-05-24T11:42:03.1567373Z", + "keyToSign": "key1" + } + }, + "responses": { + "200": { + "body": { + "accountSasToken": "sv=2015-04-05&ss=b&srt=s&sp=r&st=2017-05-24T10%3A42%3A03Z&se=2017-05-24T11%3A42%3A03Z&spr=https,http&sig=Z0I%2BEpM%2BPPlTC8ApfUf%2BcffO2aahMgZim3U0iArqsS0%3D" + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListByResourceGroup.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListByResourceGroup.json new file mode 100644 index 000000000000..0bda98930297 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListByResourceGroup.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6117", + "api-version": "2020-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res6117/providers/Microsoft.Storage/storageAccounts/sto4036", + "kind": "Storage", + "location": "eastus", + "name": "sto4036", + "properties": { + "isHnsEnabled": true, + "creationTime": "2017-05-24T13:24:47.818801Z", + "primaryEndpoints": { + "web": "https://sto4036.web.core.windows.net/", + "dfs": "https://sto4036.dfs.core.windows.net/", + "blob": "https://sto4036.blob.core.windows.net/", + "file": "https://sto4036.file.core.windows.net/", + "queue": "https://sto4036.queue.core.windows.net/", + "table": "https://sto4036.table.core.windows.net/" + }, + "primaryLocation": "eastus", + "provisioningState": "Succeeded", + "secondaryLocation": "centraluseuap", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res6117/providers/Microsoft.Storage/storageAccounts/sto4452", + "kind": "Storage", + "location": "eastus", + "name": "sto4452", + "properties": { + "creationTime": "2017-05-24T13:24:15.7068366Z", + "primaryEndpoints": { + "blob": "https://sto4452.blob.core.windows.net/", + "file": "https://sto4452.file.core.windows.net/", + "queue": "https://sto4452.queue.core.windows.net/", + "table": "https://sto4452.table.core.windows.net/" + }, + "primaryLocation": "eastus", + "provisioningState": "Succeeded", + "secondaryLocation": "centraluseuap", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + } + ] + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListKeys.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListKeys.json new file mode 100644 index 000000000000..603fc8a5d4b7 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListKeys.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res418", + "accountName": "sto2220", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "keys": [ + { + "keyName": "key1", + "permissions": "Full", + "value": "nVF7aKIvr9mV/RM5lOD0sYoi8ThXTRHQP7o66hvUmjCDkPKR3qxPu/otJcNciz2aQdqPuzJH3ECG4TU2yZjQ7Q==" + }, + { + "keyName": "key2", + "permissions": "Full", + "value": "dNJvKnULO586Ji3nFzB7987TJs4ovnGZhyGXeiVQ75HZGPhBmBfe8lXrI7EfyATff6S5ucxffCoEAQOWbmPK/Q==" + } + ] + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListLocationUsage.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListLocationUsage.json new file mode 100644 index 000000000000..9504459e58f4 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListLocationUsage.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "eastus2(stage)", + "api-version": "2020-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 55, + "limit": 250, + "name": { + "value": "StorageAccounts", + "localizedValue": "Storage Accounts" + } + } + ] + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListObjectReplicationPolicies.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListObjectReplicationPolicies.json new file mode 100644 index 000000000000..8941162c69e2 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListObjectReplicationPolicies.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/objectReplicationPolicies/c6c23999-fd4e-433a-bcf9-1db69d27cd8a", + "name": "c6c23999-fd4e-433a-bcf9-1db69d27cd8a", + "type": "Microsoft.Storage/storageAccounts/objectReplicationPolicies", + "properties": { + "sourceAccount": "sto2527", + "destinationAccount": "destAccount1" + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto1590/objectReplicationPolicies/141d23dc-8958-4b48-b6e6-5a40bf1af116", + "name": "141d23dc-8958-4b48-b6e6-5a40bf1af116", + "type": "Microsoft.Storage/storageAccounts/objectReplicationPolicies", + "properties": { + "sourceAccount": "sto2527", + "destinationAccount": "destAccount2" + } + } + ] + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListPrivateEndpointConnections.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListPrivateEndpointConnections.json new file mode 100644 index 000000000000..053af0095007 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListPrivateEndpointConnections.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Storage/storageAccounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.Storage/storageAccounts/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionRequired": "None" + } + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Storage/storageAccounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.Storage/storageAccounts/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest02" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListPrivateLinkResources.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListPrivateLinkResources.json new file mode 100644 index 000000000000..a44e440a5776 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListPrivateLinkResources.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "accountName": "sto2527", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/privateLinkResources/blob", + "name": "blob", + "type": "Microsoft.Storage/storageAccounts/privateLinkResources", + "properties": { + "groupId": "blob", + "requiredMembers": [ + "blob" + ], + "requiredZoneNames": [ + "privatelink.blob.core.windows.net" + ] + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/privateLinkResources/blob_secondary", + "name": "blob_secondary", + "type": "Microsoft.Storage/storageAccounts/privateLinkResources", + "properties": { + "groupId": "blob_secondary", + "requiredMembers": [ + "blob_secondary" + ], + "requiredZoneNames": [ + "privatelink.blob.core.windows.net" + ] + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/privateLinkResources/table", + "name": "table", + "type": "Microsoft.Storage/storageAccounts/privateLinkResources", + "properties": { + "groupId": "table", + "requiredMembers": [ + "table" + ], + "requiredZoneNames": [ + "privatelink.table.core.windows.net" + ] + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/privateLinkResources/table_secondary", + "name": "table_secondary", + "type": "Microsoft.Storage/storageAccounts/privateLinkResources", + "properties": { + "groupId": "table_secondary", + "requiredMembers": [ + "table_secondary" + ], + "requiredZoneNames": [ + "privatelink.table.core.windows.net" + ] + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/privateLinkResources/dfs", + "name": "dfs", + "type": "Microsoft.Storage/storageAccounts/privateLinkResources", + "properties": { + "groupId": "dfs", + "requiredMembers": [ + "dfs" + ], + "requiredZoneNames": [ + "privatelink.dfs.core.windows.net" + ] + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.Storage/storageAccounts/sto2527/privateLinkResources/dfs_secondary", + "name": "dfs_secondary", + "type": "Microsoft.Storage/storageAccounts/privateLinkResources", + "properties": { + "groupId": "dfs_secondary", + "requiredMembers": [ + "dfs_secondary" + ], + "requiredZoneNames": [ + "privatelink.dfs.core.windows.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListServiceSAS.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListServiceSAS.json new file mode 100644 index 000000000000..d850c4c45187 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountListServiceSAS.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res7439", + "accountName": "sto1299", + "api-version": "2020-08-01-preview", + "monitor": "true", + "parameters": { + "canonicalizedResource": "/blob/sto1299/music", + "signedResource": "c", + "signedPermission": "l", + "signedExpiry": "2017-05-24T11:32:48.8457197Z" + } + }, + "responses": { + "200": { + "body": { + "serviceSasToken": "sv=2015-04-05&sr=c&se=2017-05-24T11%3A32%3A48Z&sp=l&sig=PoF8yBUGixsjzwroLmw7vG3VbGz4KB2woZC2D4C2oio%3D" + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountPatchEncryptionScope.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountPatchEncryptionScope.json new file mode 100644 index 000000000000..79069549763c --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountPatchEncryptionScope.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "resource-group-name", + "accountName": "{storage-account-name}", + "encryptionScopeName": "{encryption-scope-name}", + "api-version": "2020-08-01-preview", + "monitor": "true", + "encryptionScope": { + "properties": { + "source": "Microsoft.KeyVault", + "keyVaultProperties": { + "keyUri": "https://testvault.vault.core.windows.net/keys/key1/863425f1358359c" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/resource-group-name/providers/Microsoft.Storage/storageAccounts/{storage-account-name}/encryptionScopes/{encryption-scope-name}", + "name": "{encryption-scope-name}", + "type": "Microsoft.Storage/storageAccounts/encryptionScopes", + "properties": { + "source": "Microsoft.KeyVault", + "state": "Enabled", + "keyVaultProperties": { + "keyUri": "https://testvault.vault.core.windows.net/keys/key1/863425f1358359c" + }, + "creationTime": "2018-10-16T02:42:41.7633306Z", + "lastModifiedTime": "2018-10-17T06:23:14.4513306Z" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountPutEncryptionScope.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountPutEncryptionScope.json new file mode 100644 index 000000000000..1dacabc55490 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountPutEncryptionScope.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "resource-group-name", + "accountName": "{storage-account-name}", + "encryptionScopeName": "{encryption-scope-name}", + "api-version": "2020-08-01-preview", + "monitor": "true", + "encryptionScope": {} + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/resource-group-name/providers/Microsoft.Storage/storageAccounts/{storage-account-name}/encryptionScopes/{encryption-scope-name}", + "name": "{encryption-scope-name}", + "type": "Microsoft.Storage/storageAccounts/encryptionScopes", + "properties": { + "source": "Microsoft.Storage", + "state": "Enabled", + "creationTime": "2018-10-16T02:42:41.7633306Z", + "lastModifiedTime": "2018-10-16T02:42:41.7633306Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/resource-group-name/providers/Microsoft.Storage/storageAccounts/{storage-account-name}/encryptionScopes/{encryption-scope-name}", + "name": "{encryption-scope-name}", + "type": "Microsoft.Storage/storageAccounts/encryptionScopes", + "properties": { + "source": "Microsoft.Storage", + "state": "Enabled", + "creationTime": "2018-10-16T02:42:41.7633306Z", + "lastModifiedTime": "2018-10-16T02:42:41.7633306Z" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountPutPrivateEndpointConnection.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountPutPrivateEndpointConnection.json new file mode 100644 index 000000000000..92a5d349a020 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountPutPrivateEndpointConnection.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res7687", + "accountName": "sto9699", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2020-08-01-preview", + "monitor": "true", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Storage/storageAccounts/sto288/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.Storage/storageAccounts/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionRequired": "None" + } + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountRegenerateKerbKey.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountRegenerateKerbKey.json new file mode 100644 index 000000000000..4534e7ec1c52 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountRegenerateKerbKey.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4167", + "accountName": "sto3539", + "api-version": "2020-08-01-preview", + "monitor": "true", + "regenerateKey": { + "keyName": "kerb1" + } + }, + "responses": { + "200": { + "body": { + "keys": [ + { + "keyName": "key1", + "permissions": "Full", + "value": "7xl+yQ4MrVpZCHspveCfy4f8jgTY1wv42gHO8k4bAX+EPvN4hY5uPau/bpofgeye+K9FtgvjkadkLISPfOxlMw==" + }, + { + "keyName": "key2", + "permissions": "Full", + "value": "uC+kyJ9/gT81E/+9I1Go4xtOe8sW5rdIm3n6PNIyQ5kGO5OpFq69aWnrn3jLeFIyItzpln9P392U0353RYKvbg==" + }, + { + "keyName": "kerb1", + "permissions": "Full", + "value": "34EzDQuCw1lYBXCGioUybN9dCWSLLzQPdAbYRcLhM957Fy/6IlO/SkaeR9QXKhVgCt8anDq4wYmDcaZ5VXr2Tg==" + } + ] + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountRegenerateKey.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountRegenerateKey.json new file mode 100644 index 000000000000..48fe2f665419 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountRegenerateKey.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4167", + "accountName": "sto3539", + "api-version": "2020-08-01-preview", + "monitor": "true", + "regenerateKey": { + "keyName": "key2" + } + }, + "responses": { + "200": { + "body": { + "keys": [ + { + "keyName": "key1", + "permissions": "Full", + "value": "7xl+yQ4MrVpZCHspveCfy4f8jgTY1wv42gHO8k4bAX+EPvN4hY5uPau/bpofgeye+K9FtgvjkadkLISPfOxlMw==" + }, + { + "keyName": "key2", + "permissions": "Full", + "value": "uC+kyJ9/gT81E/+9I1Go4xtOe8sW5rdIm3n6PNIyQ5kGO5OpFq69aWnrn3jLeFIyItzpln9P392U0353RYKvbg==" + } + ] + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountRevokeUserDelegationKeys.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountRevokeUserDelegationKeys.json new file mode 100644 index 000000000000..0e5d655a4e97 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountRevokeUserDelegationKeys.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4167", + "accountName": "sto3539", + "api-version": "2020-08-01-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountSetManagementPolicy.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountSetManagementPolicy.json new file mode 100644 index 000000000000..485abbb70d31 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountSetManagementPolicy.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res7687", + "accountName": "sto9699", + "managementPolicyName": "default", + "api-version": "2020-08-01-preview", + "monitor": "true", + "properties": { + "properties": { + "policy": { + "rules": [ + { + "enabled": true, + "name": "olcmtest1", + "type": "Lifecycle", + "definition": { + "filters": { + "blobTypes": [ + "blockBlob" + ], + "prefixMatch": [ + "olcmtestcontainer1" + ] + }, + "actions": { + "baseBlob": { + "tierToCool": { + "daysAfterModificationGreaterThan": 30 + }, + "tierToArchive": { + "daysAfterModificationGreaterThan": 90 + }, + "delete": { + "daysAfterModificationGreaterThan": 1000 + } + }, + "snapshot": { + "delete": { + "daysAfterCreationGreaterThan": 30 + } + } + } + } + }, + { + "enabled": true, + "name": "olcmtest2", + "type": "Lifecycle", + "definition": { + "filters": { + "blobTypes": [ + "blockBlob" + ], + "prefixMatch": [ + "olcmtestcontainer2" + ], + "blobIndexMatch": [ + { + "name": "tag1", + "op": "==", + "value": "val1" + }, + { + "name": "tag2", + "op": "==", + "value": "val2" + } + ] + }, + "actions": { + "baseBlob": { + "tierToCool": { + "daysAfterModificationGreaterThan": 30 + }, + "tierToArchive": { + "daysAfterModificationGreaterThan": 90 + }, + "delete": { + "daysAfterModificationGreaterThan": 1000 + } + } + } + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Storage/storageAccounts/sto288/managementPolicies/default", + "name": "DefaultManagementPolicy", + "type": "Microsoft.Storage/storageAccounts/managementPolicies", + "properties": { + "policy": { + "rules": [ + { + "enabled": true, + "name": "olcmtest1", + "type": "Lifecycle", + "definition": { + "filters": { + "blobTypes": [ + "blockBlob" + ], + "prefixMatch": [ + "olcmtestcontainer1" + ] + }, + "actions": { + "baseBlob": { + "tierToCool": { + "daysAfterModificationGreaterThan": 30 + }, + "tierToArchive": { + "daysAfterModificationGreaterThan": 90 + }, + "delete": { + "daysAfterModificationGreaterThan": 1000 + } + }, + "snapshot": { + "delete": { + "daysAfterCreationGreaterThan": 30 + } + } + } + } + }, + { + "enabled": true, + "name": "olcmtest2", + "type": "Lifecycle", + "definition": { + "filters": { + "blobTypes": [ + "blockBlob" + ], + "prefixMatch": [ + "olcmtestcontainer2" + ], + "blobIndexMatch": [ + { + "name": "tag1", + "op": "==", + "value": "val1" + }, + { + "name": "tag2", + "op": "==", + "value": "val2" + } + ] + }, + "actions": { + "baseBlob": { + "tierToCool": { + "daysAfterModificationGreaterThan": 30 + }, + "tierToArchive": { + "daysAfterModificationGreaterThan": 90 + }, + "delete": { + "daysAfterModificationGreaterThan": 1000 + } + } + } + } + } + ] + }, + "lastModifiedTime": "2018-06-08T02:53:39.0932539Z" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountUpdate.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountUpdate.json new file mode 100644 index 000000000000..52ad395f900c --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountUpdate.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9407", + "accountName": "sto8596", + "api-version": "2020-08-01-preview", + "monitor": "true", + "parameters": { + "properties": { + "allowBlobPublicAccess": false, + "minimumTlsVersion": "TLS1_2", + "networkAcls": { + "defaultAction": "Allow" + }, + "routingPreference": { + "routingChoice": "MicrosoftRouting", + "publishMicrosoftEndpoints": true, + "publishInternetEndpoints": true + }, + "encryption": { + "services": { + "file": { + "keyType": "Account", + "enabled": true + }, + "blob": { + "keyType": "Account", + "enabled": true + } + }, + "keySource": "Microsoft.Storage" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596", + "kind": "Storage", + "location": "eastus2(stage)", + "name": "sto8596", + "properties": { + "isHnsEnabled": true, + "allowBlobPublicAccess": false, + "minimumTlsVersion": "TLS1_2", + "creationTime": "2017-06-01T02:42:41.7633306Z", + "networkAcls": { + "bypass": "AzureServices", + "defaultAction": "Allow", + "ipRules": [], + "virtualNetworkRules": [] + }, + "primaryEndpoints": { + "web": "https://sto8596.web.core.windows.net/", + "dfs": "https://sto8596.dfs.core.windows.net/", + "blob": "https://sto8596.blob.core.windows.net/", + "file": "https://sto8596.file.core.windows.net/", + "queue": "https://sto8596.queue.core.windows.net/", + "table": "https://sto8596.table.core.windows.net/", + "microsoftEndpoints": { + "web": "https://sto8596-microsoftrouting.web.core.windows.net/", + "dfs": "https://sto8596-microsoftrouting.dfs.core.windows.net/", + "blob": "https://sto8596-microsoftrouting.blob.core.windows.net/", + "file": "https://sto8596-microsoftrouting.file.core.windows.net/", + "queue": "https://sto8596-microsoftrouting.queue.core.windows.net/", + "table": "https://sto8596-microsoftrouting.table.core.windows.net/" + }, + "internetEndpoints": { + "web": "https://sto8596-internetrouting.web.core.windows.net/", + "dfs": "https://sto8596-internetrouting.dfs.core.windows.net/", + "blob": "https://sto8596-internetrouting.blob.core.windows.net/", + "file": "https://sto8596-internetrouting.file.core.windows.net/" + } + }, + "primaryLocation": "eastus2(stage)", + "provisioningState": "Succeeded", + "routingPreference": { + "routingChoice": "MicrosoftRouting", + "publishMicrosoftEndpoints": true, + "publishInternetEndpoints": true + }, + "encryption": { + "services": { + "file": { + "keyType": "Account", + "enabled": true, + "lastEnabledTime": "2019-12-11T20:49:31.7036140Z" + }, + "blob": { + "keyType": "Account", + "enabled": true, + "lastEnabledTime": "2019-12-11T20:49:31.7036140Z" + } + }, + "keySource": "Microsoft.Storage" + }, + "secondaryLocation": "northcentralus(stage)", + "statusOfPrimary": "available", + "statusOfSecondary": "available", + "supportsHttpsTrafficOnly": false + }, + "sku": { + "name": "Standard_GRS", + "tier": "Standard" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.Storage/storageAccounts" + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountUpdateObjectReplicationPolicyOnDestination.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountUpdateObjectReplicationPolicyOnDestination.json new file mode 100644 index 000000000000..f900fa375fe1 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountUpdateObjectReplicationPolicyOnDestination.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res7687", + "accountName": "dst112", + "objectReplicationPolicyId": "2a20bb73-5717-4635-985a-5d4cf777438f", + "api-version": "2020-08-01-preview", + "monitor": "true", + "properties": { + "properties": { + "sourceAccount": "src1122", + "destinationAccount": "dst112", + "rules": [ + { + "ruleId": "d5d18a48-8801-4554-aeaa-74faf65f5ef9", + "sourceContainer": "scont139", + "destinationContainer": "dcont139", + "filters": { + "prefixMatch": [ + "blobA", + "blobB" + ] + } + }, + { + "sourceContainer": "scont179", + "destinationContainer": "dcont179" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7687/providers/Microsoft.Storage/storageAccounts/dst112/objectReplicationPolicies/2a20bb73-5717-4635-985a-5d4cf777438f", + "name": "2a20bb73-5717-4635-985a-5d4cf777438f", + "type": "Microsoft.Storage/storageAccounts/objectReplicationPolicies", + "properties": { + "policyId": "2a20bb73-5717-4635-985a-5d4cf777438f", + "sourceAccount": "src1122", + "destinationAccount": "dst112", + "rules": [ + { + "ruleId": "d5d18a48-8801-4554-aeaa-74faf65f5ef9", + "sourceContainer": "sourceContainer1", + "destinationContainer": "destContainer1", + "filters": { + "prefixMatch": [ + "blobA", + "blobB" + ] + } + }, + { + "ruleId": "cfbb4bc2-8b60-429f-b05a-d1e0942b33b2", + "sourceContainer": "scont179", + "destinationContainer": "dcont179" + } + ] + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountUpdateObjectReplicationPolicyOnSource.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountUpdateObjectReplicationPolicyOnSource.json new file mode 100644 index 000000000000..6ab1f1a9d4d1 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountUpdateObjectReplicationPolicyOnSource.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res7687", + "accountName": "src1122", + "objectReplicationPolicyId": "2a20bb73-5717-4635-985a-5d4cf777438f", + "api-version": "2020-08-01-preview", + "monitor": "true", + "properties": { + "properties": { + "sourceAccount": "src1122", + "destinationAccount": "dst112", + "rules": [ + { + "ruleId": "d5d18a48-8801-4554-aeaa-74faf65f5ef9", + "sourceContainer": "scont139", + "destinationContainer": "dcont139", + "filters": { + "prefixMatch": [ + "blobA", + "blobB" + ] + } + }, + { + "ruleId": "cfbb4bc2-8b60-429f-b05a-d1e0942b33b2", + "sourceContainer": "scont179", + "destinationContainer": "dcont179" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7687/providers/Microsoft.Storage/storageAccounts/src1122/objectReplicationPolicies/2a20bb73-5717-4635-985a-5d4cf777438f", + "name": "2a20bb73-5717-4635-985a-5d4cf777438f", + "type": "Microsoft.Storage/storageAccounts/objectReplicationPolicies", + "properties": { + "policyId": "2a20bb73-5717-4635-985a-5d4cf777438f", + "enabledTime": "2019-06-08T03:01:55.7168089Z", + "sourceAccount": "src1122", + "destinationAccount": "dst112", + "rules": [ + { + "ruleId": "d5d18a48-8801-4554-aeaa-74faf65f5ef9", + "sourceContainer": "sourceContainer1", + "destinationContainer": "destContainer1", + "filters": { + "prefixMatch": [ + "blobA", + "blobB" + ] + } + }, + { + "ruleId": "cfbb4bc2-8b60-429f-b05a-d1e0942b33b2", + "sourceContainer": "scont179", + "destinationContainer": "dcont179" + } + ] + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableOperationDelete.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableOperationDelete.json new file mode 100644 index 000000000000..3349b784dd1c --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableOperationDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "tableName": "table6185", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "204": {} + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableOperationGet.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableOperationGet.json new file mode 100644 index 000000000000..438403979f30 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableOperationGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "tableName": "table6185", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/tableServices/default/tables/table6185", + "name": "table6185", + "type": "Microsoft.Storage/storageAccounts/tableServices/tables", + "properties": { + "tableName": "table6185" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableOperationList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableOperationList.json new file mode 100644 index 000000000000..4e41c26c5639 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableOperationList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9290", + "accountName": "sto328", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/tableServices/default/tables/table6185", + "name": "table6185", + "type": "Microsoft.Storage/storageAccounts/tableServices/tables", + "properties": { + "tableName": "table6185" + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/tableServices/default/tables/table6186", + "name": "table6186", + "type": "Microsoft.Storage/storageAccounts/tableServices/tables", + "properties": { + "tableName": "table6186" + } + } + ], + "nextLink": "https://sto1590endpoint/subscriptions/{subscription-id}/resourceGroups/res9290/providers/Microsoft.Storage/storageAccounts/sto328/tableServices/default/tables?api-version=2020-08-01-preview&NextTableName=1!40!bXl0YWJsZXNoYzU0OAEwMWQ2MTI5ZTJmYjVmODFh" + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableOperationPatch.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableOperationPatch.json new file mode 100644 index 000000000000..438403979f30 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableOperationPatch.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "tableName": "table6185", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/tableServices/default/tables/table6185", + "name": "table6185", + "type": "Microsoft.Storage/storageAccounts/tableServices/tables", + "properties": { + "tableName": "table6185" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableOperationPut.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableOperationPut.json new file mode 100644 index 000000000000..438403979f30 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableOperationPut.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res3376", + "accountName": "sto328", + "tableName": "table6185", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/tableServices/default/tables/table6185", + "name": "table6185", + "type": "Microsoft.Storage/storageAccounts/tableServices/tables", + "properties": { + "tableName": "table6185" + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableServicesGet.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableServicesGet.json new file mode 100644 index 000000000000..1d3fd0c6657f --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableServicesGet.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4410", + "accountName": "sto8607", + "tableServiceName": "default", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/tableServices/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/tableServices", + "properties": { + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ], + "allowedMethods": [ + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" + ], + "maxAgeInSeconds": 100, + "exposedHeaders": [ + "x-ms-meta-*" + ], + "allowedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ] + }, + { + "allowedOrigins": [ + "*" + ], + "allowedMethods": [ + "GET" + ], + "maxAgeInSeconds": 2, + "exposedHeaders": [ + "*" + ], + "allowedHeaders": [ + "*" + ] + }, + { + "allowedOrigins": [ + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], + "allowedMethods": [ + "GET", + "PUT" + ], + "maxAgeInSeconds": 2000, + "exposedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ], + "allowedHeaders": [ + "x-ms-meta-12345675754564*" + ] + } + ] + } + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableServicesList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableServicesList.json new file mode 100644 index 000000000000..16ea1333e941 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableServicesList.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res9290", + "accountName": "sto1590", + "api-version": "2020-08-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/tableServices/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/tableServices", + "properties": { + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ], + "allowedMethods": [ + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" + ], + "maxAgeInSeconds": 100, + "exposedHeaders": [ + "x-ms-meta-*" + ], + "allowedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ] + }, + { + "allowedOrigins": [ + "*" + ], + "allowedMethods": [ + "GET" + ], + "maxAgeInSeconds": 2, + "exposedHeaders": [ + "*" + ], + "allowedHeaders": [ + "*" + ] + }, + { + "allowedOrigins": [ + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], + "allowedMethods": [ + "GET", + "PUT" + ], + "maxAgeInSeconds": 2000, + "exposedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ], + "allowedHeaders": [ + "x-ms-meta-12345675754564*" + ] + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableServicesPut.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableServicesPut.json new file mode 100644 index 000000000000..4a1f0d2c93a3 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/TableServicesPut.json @@ -0,0 +1,147 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4410", + "accountName": "sto8607", + "tableServiceName": "default", + "api-version": "2020-08-01-preview", + "monitor": "true", + "parameters": { + "properties": { + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ], + "allowedMethods": [ + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" + ], + "maxAgeInSeconds": 100, + "exposedHeaders": [ + "x-ms-meta-*" + ], + "allowedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ] + }, + { + "allowedOrigins": [ + "*" + ], + "allowedMethods": [ + "GET" + ], + "maxAgeInSeconds": 2, + "exposedHeaders": [ + "*" + ], + "allowedHeaders": [ + "*" + ] + }, + { + "allowedOrigins": [ + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], + "allowedMethods": [ + "GET", + "PUT" + ], + "maxAgeInSeconds": 2000, + "exposedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ], + "allowedHeaders": [ + "x-ms-meta-12345675754564*" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/tableServices/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/tableServices", + "properties": { + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ], + "allowedMethods": [ + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" + ], + "maxAgeInSeconds": 100, + "exposedHeaders": [ + "x-ms-meta-*" + ], + "allowedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ] + }, + { + "allowedOrigins": [ + "*" + ], + "allowedMethods": [ + "GET" + ], + "maxAgeInSeconds": 2, + "exposedHeaders": [ + "*" + ], + "allowedHeaders": [ + "*" + ] + }, + { + "allowedOrigins": [ + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], + "allowedMethods": [ + "GET", + "PUT" + ], + "maxAgeInSeconds": 2000, + "exposedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ], + "allowedHeaders": [ + "x-ms-meta-12345675754564*" + ] + } + ] + } + } + } + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/file.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/file.json new file mode 100644 index 000000000000..2035390ef5ef --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/file.json @@ -0,0 +1,795 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-08-01-preview", + "title": "StorageManagementClient", + "description": "The Azure Storage Management API." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices": { + "get": { + "tags": [ + "FileService" + ], + "operationId": "FileServices_List", + "x-ms-examples": { + "ListFileServices": { + "$ref": "./examples/FileServicesList.json" + } + }, + "description": "List all file services in storage accounts", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- List file services operation completed successfully.", + "schema": { + "$ref": "#/definitions/FileServiceItems" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/{FileServicesName}": { + "put": { + "tags": [ + "FileService" + ], + "operationId": "FileServices_SetServiceProperties", + "x-ms-examples": { + "PutFileServices": { + "$ref": "./examples/FileServicesPut.json" + } + }, + "description": "Sets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules. ", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/FileServicesName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FileServiceProperties" + }, + "description": "The properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules." + } + ], + "responses": { + "200": { + "description": "OK -- Sets The properties of a storage account’s File service successfully.", + "schema": { + "$ref": "#/definitions/FileServiceProperties" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "FileService" + ], + "operationId": "FileServices_GetServiceProperties", + "x-ms-examples": { + "GetFileServices": { + "$ref": "./examples/FileServicesGet.json" + } + }, + "description": "Gets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/FileServicesName" + } + ], + "responses": { + "200": { + "description": "OK -- returned the properties of a storage account’s File service.", + "schema": { + "$ref": "#/definitions/FileServiceProperties" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares": { + "get": { + "tags": [ + "FileShares" + ], + "operationId": "FileShares_List", + "x-ms-examples": { + "ListShares": { + "$ref": "./examples/FileSharesList.json" + }, + "ListDeletedShares": { + "$ref": "./examples/DeletedFileSharesList.json" + } + }, + "description": "Lists all shares.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$maxpagesize", + "in": "query", + "type": "string", + "description": "Optional. Specified maximum number of shares that can be included in the list." + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "Optional. When specified, only share names starting with the filter will be listed." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "deleted" + ], + "x-ms-enum": { + "name": "ListSharesExpand", + "modelAsString": false + }, + "description": "Optional, used to expand the properties within share's properties." + } + ], + "responses": { + "200": { + "description": "OK -- List Shares operation completed successfully.", + "schema": { + "$ref": "#/definitions/FileShareItems" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}": { + "put": { + "tags": [ + "FileShares" + ], + "operationId": "FileShares_Create", + "x-ms-examples": { + "PutShares": { + "$ref": "./examples/FileSharesPut.json" + }, + "Create NFS Shares": { + "$ref": "./examples/FileSharesPut_NFS.json" + }, + "PutShares with Access Tier": { + "$ref": "./examples/FileSharesPut_AccessTier.json" + } + }, + "description": "Creates a new share under the specified account as described by request body. The share resource includes metadata and properties for that share. It does not include a list of the files contained by the share. ", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "fileShare", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FileShare" + }, + "description": "Properties of the file share to create." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Created -- Create Share operation completed successfully.", + "schema": { + "$ref": "#/definitions/FileShare" + } + }, + "200": { + "description": "OK -- The Share is already created.", + "schema": { + "$ref": "#/definitions/FileShare" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "FileShares" + ], + "operationId": "FileShares_Update", + "x-ms-examples": { + "UpdateShares": { + "$ref": "./examples/FileSharesPatch.json" + } + }, + "description": "Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist. ", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "fileShare", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FileShare" + }, + "description": "Properties to update for the file share." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Update Share operation completed successfully.", + "schema": { + "$ref": "#/definitions/FileShare", + "description": "Properties of the updated file share." + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "FileShares" + ], + "operationId": "FileShares_Get", + "x-ms-examples": { + "GetShares": { + "$ref": "./examples/FileSharesGet.json" + }, + "GetShareStats": { + "$ref": "./examples/FileSharesGet_Stats.json" + } + }, + "description": "Gets properties of a specified share.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "stats" + ], + "x-ms-enum": { + "name": "GetShareExpand", + "modelAsString": false + }, + "description": "Optional, used to expand the properties within share's properties." + } + ], + "responses": { + "200": { + "description": "OK -- Get Share operation completed successfully.", + "schema": { + "$ref": "#/definitions/FileShare" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "FileShares" + ], + "operationId": "FileShares_Delete", + "x-ms-examples": { + "DeleteShares": { + "$ref": "./examples/FileSharesDelete.json" + } + }, + "description": "Deletes specified share under its account.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete Share operation completed successfully." + }, + "204": { + "description": "No Content -- The Share not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}/restore": { + "post": { + "tags": [ + "FileShares" + ], + "operationId": "FileShares_Restore", + "x-ms-examples": { + "RestoreShares": { + "$ref": "./examples/FileSharesRestore.json" + } + }, + "description": "Restore a file share within a valid retention days if share soft delete is enabled", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "deletedShare", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DeletedShare" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- The Share is successfully restored." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "FileServiceItems": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FileServiceProperties" + }, + "description": "List of file services returned.", + "readOnly": true + } + } + }, + "FileServiceProperties": { + "properties": { + "properties": { + "properties": { + "cors": { + "$ref": "./common.json#/definitions/CorsRules", + "description": "Specifies CORS rules for the File service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the File service." + }, + "shareDeleteRetentionPolicy": { + "$ref": "./common.json#/definitions/DeleteRetentionPolicy", + "description": "The file service properties for share soft delete." + } + }, + "x-ms-client-flatten": true, + "x-ms-client-name": "FileServiceProperties", + "description": "The properties of File services in storage account." + }, + "sku": { + "$ref": "./common.json#/definitions/Sku", + "readOnly": true, + "description": "Sku name and tier." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "description": "The properties of File services in storage account." + }, + "FileShare": { + "properties": { + "properties": { + "$ref": "#/definitions/FileShareProperties", + "x-ms-client-flatten": true, + "x-ms-client-name": "FileShareProperties", + "description": "Properties of the file share." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/AzureEntityResource" + } + ], + "description": "Properties of the file share, including Id, resource name, resource type, Etag." + }, + "DeletedShare": { + "properties": { + "deletedShareName": { + "type": "string", + "description": "Required. Identify the name of the deleted share that will be restored." + }, + "deletedShareVersion": { + "type": "string", + "description": "Required. Identify the version of the deleted share that will be restored." + } + }, + "required": [ + "deletedShareName", + "deletedShareVersion" + ], + "description": "The deleted share to be restored." + }, + "FileShareItem": { + "properties": { + "properties": { + "$ref": "#/definitions/FileShareProperties", + "x-ms-client-flatten": true, + "description": "The file share properties be listed out." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/AzureEntityResource" + } + ], + "description": "The file share properties be listed out." + }, + "FileShareItems": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FileShareItem" + }, + "description": "List of file shares returned.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Request URL that can be used to query next page of shares. Returned when total number of requested shares exceed maximum page size.", + "readOnly": true + } + }, + "description": "Response schema. Contains list of shares returned, and if paging is requested or required, a URL to next page of shares." + }, + "FileShareProperties": { + "properties": { + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Returns the date and time the share was last modified." + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "A name-value pair to associate with the share as metadata." + }, + "shareQuota": { + "type": "integer", + "minimum": 1, + "maximum": 102400, + "description": "The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400." + }, + "enabledProtocols": { + "type": "string", + "enum": [ + "SMB", + "NFS" + ], + "x-ms-enum": { + "name": "EnabledProtocols", + "modelAsString": true + }, + "description": "The authentication protocol that is used for the file share. Can only be specified when creating a share.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "rootSquash": { + "type": "string", + "enum": [ + "NoRootSquash", + "RootSquash", + "AllSquash" + ], + "x-ms-enum": { + "name": "RootSquashType", + "modelAsString": true + }, + "description": "The property is for NFS share only. The default is NoRootSquash." + }, + "version": { + "type": "string", + "readOnly": true, + "description": "The version of the share." + }, + "deleted": { + "type": "boolean", + "readOnly": true, + "description": "Indicates whether the share was deleted." + }, + "deletedTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The deleted time if the share was deleted." + }, + "remainingRetentionDays": { + "type": "integer", + "readOnly": true, + "description": "Remaining retention days for share that was soft deleted." + }, + "accessTier": { + "type": "string", + "enum": [ + "TransactionOptimized", + "Hot", + "Cool", + "Premium" + ], + "x-ms-enum": { + "name": "ShareAccessTier", + "modelAsString": true + }, + "description": "Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium." + }, + "accessTierChangeTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Indicates the last modification time for share access tier." + }, + "accessTierStatus": { + "type": "string", + "readOnly": true, + "description": "Indicates if there is a pending transition for access tier." + }, + "shareUsageBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files." + } + }, + "description": "The properties of the file share." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the Storage service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Storage service." + } + }, + "parameters": { + "FileServicesName": { + "name": "FileServicesName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the file Service within the specified storage account. File Service Name must be \"default\"", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "ShareName": { + "name": "shareName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.", + "maxLength": 63, + "minLength": 3, + "x-ms-parameter-location": "method" + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/privatelinks.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/privatelinks.json new file mode 100644 index 000000000000..1989c510b545 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/privatelinks.json @@ -0,0 +1,174 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-08-01-preview", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "PrivateEndpoint": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ARM identifier for Private Endpoint" + } + }, + "description": "The Private Endpoint resource." + }, + "PrivateEndpointConnection": { + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Resource properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "description": "The Private Endpoint Connection resource." + }, + "PrivateEndpointConnectionProperties": { + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the PrivateEndpointConnectProperties." + }, + "PrivateLinkServiceConnectionState": { + "properties": { + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "actionRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + } + }, + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "PrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Rejected" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "PrivateLinkResource": { + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "description": "A private link resource" + }, + "PrivateLinkResourceProperties": { + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource Private link DNS zone name." + } + }, + "description": "Properties of a private link resource." + }, + "PrivateEndpointConnectionListResult": { + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + }, + "description": "List of private endpoint connection associated with the specified storage account" + }, + "PrivateLinkResourceListResult": { + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + }, + "description": "A list of private link resources" + } + }, + "parameters": { + "PrivateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection associated with the Azure resource", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/queue.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/queue.json new file mode 100644 index 000000000000..96ba5c2f241d --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/queue.json @@ -0,0 +1,560 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-08-01-preview", + "title": "StorageManagementClient", + "description": "The Azure Storage Management API." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices": { + "get": { + "tags": [ + "QueueServiceProperties" + ], + "operationId": "QueueServices_List", + "x-ms-examples": { + "QueueServicesList": { + "$ref": "./examples/QueueServicesList.json" + } + }, + "description": "List all queue services for the storage account", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- returned the properties of a storage account’s Queue service.", + "schema": { + "$ref": "#/definitions/ListQueueServices" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./file.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/{queueServiceName}": { + "put": { + "tags": [ + "QueueServiceProperties" + ], + "operationId": "QueueServices_SetServiceProperties", + "x-ms-examples": { + "QueueServicesPut": { + "$ref": "./examples/QueueServicesPut.json" + } + }, + "description": "Sets the properties of a storage account’s Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. ", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/QueueServiceName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QueueServiceProperties" + }, + "description": "The properties of a storage account’s Queue service, only properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules can be specified." + } + ], + "responses": { + "200": { + "description": "OK -- Sets The properties of a storage account’s Queue service successfully.", + "schema": { + "$ref": "#/definitions/QueueServiceProperties" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./file.json#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "QueueServiceProperties" + ], + "operationId": "QueueServices_GetServiceProperties", + "x-ms-examples": { + "QueueServicesGet": { + "$ref": "./examples/QueueServicesGet.json" + } + }, + "description": "Gets the properties of a storage account’s Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/QueueServiceName" + } + ], + "responses": { + "200": { + "description": "OK -- returned the properties of a storage account’s Queue service.", + "schema": { + "$ref": "#/definitions/QueueServiceProperties" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./file.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues/{queueName}": { + "put": { + "tags": [ + "QueueService" + ], + "operationId": "Queue_Create", + "x-ms-examples": { + "QueueOperationPut": { + "$ref": "./examples/QueueOperationPut.json" + }, + "QueueOperationPutWithMetadata": { + "$ref": "./examples/QueueOperationPutWithMetadata.json" + } + }, + "description": "Creates a new queue with the specified queue name, under the specified account.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/QueueName" + }, + { + "name": "queue", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageQueue" + }, + "description": "Queue properties and metadata to be created with" + } + ], + "responses": { + "200": { + "description": "OK -- Creates a queue with the given queue name successfully.", + "schema": { + "$ref": "#/definitions/StorageQueue" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./file.json#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "QueueService" + ], + "operationId": "Queue_Update", + "x-ms-examples": { + "QueueOperationPatch": { + "$ref": "./examples/QueueOperationPatch.json" + } + }, + "description": "Creates a new queue with the specified queue name, under the specified account.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/QueueName" + }, + { + "name": "queue", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageQueue" + }, + "description": "Queue properties and metadata to be created with" + } + ], + "responses": { + "200": { + "description": "OK -- Creates a queue with the given queue name successfully.", + "schema": { + "$ref": "#/definitions/StorageQueue" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./file.json#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "QueueService" + ], + "operationId": "Queue_Get", + "x-ms-examples": { + "QueueOperationGet": { + "$ref": "./examples/QueueOperationGet.json" + } + }, + "description": "Gets the queue with the specified queue name, under the specified account if it exists.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/QueueName" + } + ], + "responses": { + "200": { + "description": "OK -- returned table with the specified table name successfully.", + "schema": { + "$ref": "#/definitions/StorageQueue" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./file.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "QueueService" + ], + "operationId": "Queue_Delete", + "x-ms-examples": { + "QueueOperationDelete": { + "$ref": "./examples/QueueOperationDelete.json" + } + }, + "description": "Deletes the queue with the specified queue name, under the specified account if it exists.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/QueueName" + } + ], + "responses": { + "204": { + "description": "No Content - Successfully deleted the queue with the specified queue name" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./file.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues": { + "get": { + "tags": [ + "QueueService" + ], + "operationId": "Queue_List", + "x-ms-examples": { + "QueueOperationList": { + "$ref": "./examples/QueueOperationList.json" + } + }, + "description": "Gets a list of all the queues under the specified storage account", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$maxpagesize", + "in": "query", + "type": "string", + "description": "Optional, a maximum number of queues that should be included in a list queue response" + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "Optional, When specified, only the queues with a name starting with the given filter will be listed." + } + ], + "responses": { + "200": { + "description": "OK -- returned a list of queues successfully.", + "schema": { + "$ref": "#/definitions/ListQueueResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./file.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ListQueueServices": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/QueueServiceProperties" + }, + "description": "List of queue services returned.", + "readOnly": true + } + } + }, + "QueueServiceProperties": { + "properties": { + "properties": { + "properties": { + "cors": { + "$ref": "./common.json#/definitions/CorsRules", + "description": "Specifies CORS rules for the Queue service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Queue service." + } + }, + "x-ms-client-flatten": true, + "x-ms-client-name": "QueueServiceProperties", + "description": "The properties of a storage account’s Queue service." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "description": "The properties of a storage account’s Queue service." + }, + "StorageQueue": { + "properties": { + "properties": { + "$ref": "#/definitions/QueueProperties", + "x-ms-client-flatten": true, + "x-ms-client-name": "QueueProperties", + "description": "Queue resource properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ] + }, + "QueueProperties": { + "properties": { + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "A name-value pair that represents queue metadata." + }, + "approximateMessageCount": { + "type": "integer", + "readOnly": true, + "description": "Integer indicating an approximate number of messages in the queue. This number is not lower than the actual number of messages in the queue, but could be higher." + } + } + }, + "ListQueue": { + "properties": { + "properties": { + "$ref": "#/definitions/ListQueueProperties", + "x-ms-client-flatten": true, + "x-ms-client-name": "QueueProperties", + "description": "List Queue resource properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ] + }, + "ListQueueProperties": { + "properties": { + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "A name-value pair that represents queue metadata." + } + } + }, + "ListQueueResource": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ListQueue" + }, + "description": "List of queues returned.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Request URL that can be used to list next page of queues", + "readOnly": true + } + }, + "description": "Response schema. Contains list of queues returned" + } + }, + "parameters": { + "QueueServiceName": { + "name": "queueServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Queue Service within the specified storage account. Queue Service Name must be 'default'", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "QueueName": { + "name": "queueName", + "in": "path", + "required": true, + "type": "string", + "description": "A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters.", + "maxLength": 63, + "minLength": 3, + "pattern": "^[a-z0-9]([a-z0-9]|(-(?!-))){1,61}[a-z0-9]$", + "x-ms-parameter-location": "method" + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/storage.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/storage.json new file mode 100644 index 000000000000..1bc46b6069ab --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/storage.json @@ -0,0 +1,3847 @@ +{ + "swagger": "2.0", + "info": { + "title": "StorageManagementClient", + "description": "The Azure Storage Management API.", + "version": "2020-08-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Storage/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Storage Rest API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/skus": { + "get": { + "tags": [ + "Skus" + ], + "operationId": "Skus_List", + "description": "Lists the available SKUs supported by Microsoft.Storage for given subscription.", + "x-ms-examples": { + "SkuList": { + "$ref": "./examples/SKUList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- List of storage SKUs in the given subscription retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/StorageSkuListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/checkNameAvailability": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_CheckNameAvailability", + "description": "Checks that the storage account name is valid and is not already in use.", + "x-ms-examples": { + "StorageAccountCheckNameAvailability": { + "$ref": "./examples/StorageAccountCheckNameAvailability.json" + } + }, + "parameters": [ + { + "name": "accountName", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountCheckNameAvailabilityParameters" + }, + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Operation to check the storage account name availability was successful.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}": { + "put": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Create", + "description": "Asynchronously creates a new storage account with the specified parameters. If an account is already created and a subsequent create request is issued with different properties, the account properties will be updated. If an account is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.", + "x-ms-examples": { + "StorageAccountCreate": { + "$ref": "./examples/StorageAccountCreate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountCreateParameters" + }, + "description": "The parameters to provide for the created account." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- returned when the storage account was already created from a previous request with the same properties specified in the request body.", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously." + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Delete", + "description": "Deletes a storage account in Microsoft Azure.", + "x-ms-examples": { + "StorageAccountDelete": { + "$ref": "./examples/StorageAccountDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- storage account deleted successfully." + }, + "204": { + "description": "NoContent -- account does not exist in the subscription." + } + } + }, + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_GetProperties", + "description": "Returns the properties for the specified storage account including but not limited to name, SKU name, location, and account status. The ListKeys operation should be used to retrieve storage keys.", + "x-ms-examples": { + "StorageAccountGetProperties": { + "$ref": "./examples/StorageAccountGetProperties.json" + }, + "StorageAccountGetPropertiesCMKEnabled": { + "$ref": "./examples/StorageAccountGetPropertiesCMKEnabled.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties within account's properties. By default, data is not included when fetching properties. Currently we only support geoReplicationStats and blobRestoreStatus.", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "geoReplicationStats", + "blobRestoreStatus" + ], + "x-ms-enum": { + "name": "StorageAccountExpand", + "modelAsString": false + } + } + ], + "responses": { + "200": { + "description": "OK -- properties retrieved successfully for the storage account.", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + } + } + }, + "patch": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Update", + "description": "The update operation can be used to update the SKU, encryption, access tier, or tags for a storage account. It can also be used to map the account to a custom domain. Only one custom domain is supported per storage account; the replacement/change of custom domain is not supported. In order to replace an old custom domain, the old value must be cleared/unregistered before a new value can be set. The update of multiple properties is supported. This call does not change the storage keys for the account. If you want to change the storage account keys, use the regenerate keys operation. The location and name of the storage account cannot be changed after creation.", + "x-ms-examples": { + "StorageAccountUpdate": { + "$ref": "./examples/StorageAccountUpdate.json" + }, + "StorageAccountEnableAD": { + "$ref": "./examples/StorageAccountEnableAD.json" + }, + "StorageAccountEnableCMK": { + "$ref": "./examples/StorageAccountEnableCMK.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountUpdateParameters" + }, + "description": "The parameters to provide for the updated account." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- storage account properties updated successfully.", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/deletedAccounts": { + "get": { + "tags": [ + "DeletedAccounts" + ], + "operationId": "DeletedAccounts_List", + "description": "Lists deleted accounts under the subscription.", + "x-ms-examples": { + "DeletedAccountList": { + "$ref": "./examples/DeletedAccountList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- List of deleted accounts was retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/DeletedAccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/locations/{location}/deletedAccounts/{deletedAccountName}": { + "get": { + "tags": [ + "DeletedAccounts" + ], + "operationId": "DeletedAccounts_Get", + "description": "Get properties of specified deleted account resource.", + "x-ms-examples": { + "DeletedAccountGet": { + "$ref": "./examples/DeletedAccountGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/DeletedAccountName" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the deleted storage account." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- properties retrieved and returned successfully for the deleted account.", + "schema": { + "$ref": "#/definitions/DeletedAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts": { + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_List", + "description": "Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.", + "x-ms-examples": { + "StorageAccountList": { + "$ref": "./examples/StorageAccountList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- List of storage accounts was retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/StorageAccountListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts": { + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListByResourceGroup", + "description": "Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.", + "x-ms-examples": { + "StorageAccountListByResourceGroup": { + "$ref": "./examples/StorageAccountListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- List of storage accounts in the given resource group retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/StorageAccountListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/listKeys": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListKeys", + "description": "Lists the access keys or Kerberos keys (if active directory enabled) for the specified storage account.", + "x-ms-examples": { + "StorageAccountListKeys": { + "$ref": "./examples/StorageAccountListKeys.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "kerb" + ], + "x-ms-enum": { + "name": "ListKeyExpand" + }, + "description": "Specifies type of the key to be listed. Possible value is kerb." + } + ], + "responses": { + "200": { + "description": "OK -- list of keys retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/StorageAccountListKeysResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_RegenerateKey", + "description": "Regenerates one of the access keys or Kerberos keys for the specified storage account.", + "x-ms-examples": { + "StorageAccountRegenerateKey": { + "$ref": "./examples/StorageAccountRegenerateKey.json" + }, + "StorageAccountRegenerateKerbKey": { + "$ref": "./examples/StorageAccountRegenerateKerbKey.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "name": "regenerateKey", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountRegenerateKeyParameters" + }, + "description": "Specifies name of the key which should be regenerated -- key1, key2, kerb1, kerb2." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- specified key regenerated successfully.", + "schema": { + "$ref": "#/definitions/StorageAccountListKeysResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/locations/{location}/usages": { + "get": { + "tags": [ + "LocationUsage" + ], + "operationId": "Usages_ListByLocation", + "description": "Gets the current usage count and the limit for the resources of the location under the subscription.", + "x-ms-examples": { + "UsageList": { + "$ref": "./examples/StorageAccountListLocationUsage.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the Azure Storage resource." + } + ], + "responses": { + "200": { + "description": "OK -- current usage count and limit retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListAccountSas": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListAccountSAS", + "description": "List SAS credentials of a storage account.", + "x-ms-examples": { + "StorageAccountListAccountSAS": { + "$ref": "./examples/StorageAccountListAccountSAS.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccountSasParameters" + }, + "description": "The parameters to provide to list SAS credentials for the storage account." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- returned the account SAS created for the storage account requested.", + "schema": { + "$ref": "#/definitions/ListAccountSasResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListServiceSas": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListServiceSAS", + "description": "List service SAS credentials of a specific resource.", + "x-ms-examples": { + "StorageAccountListServiceSAS": { + "$ref": "./examples/StorageAccountListServiceSAS.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceSasParameters" + }, + "description": "The parameters to provide to list service SAS credentials." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- returned the service SAS created for the storage service requested.", + "schema": { + "$ref": "#/definitions/ListServiceSasResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/failover": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Failover", + "description": "Failover request can be triggered for a storage account in case of availability issues. The failover occurs from the storage account's primary cluster to secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover.", + "x-ms-examples": { + "StorageAccountFailover": { + "$ref": "./examples/StorageAccountFailover.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Returned when the storage account failover is completed, and the secondary cluster has become primary." + }, + "202": { + "description": "Accepted -- Failover request accepted; operation will complete asynchronously." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/restoreBlobRanges": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_RestoreBlobRanges", + "description": "Restore blobs in the specified blob ranges", + "x-ms-examples": { + "BlobRangesRestore": { + "$ref": "./examples/BlobRangesRestore.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BlobRestoreParameters" + }, + "description": "The parameters to provide for restore blob ranges." + } + ], + "responses": { + "200": { + "description": "OK -- returned when blob ranges are restored completely with the same properties specified in the request body.", + "schema": { + "$ref": "#/definitions/BlobRestoreStatus" + } + }, + "202": { + "description": "Accepted -- Blob restore request accepted; operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/BlobRestoreStatus" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/managementPolicies/{managementPolicyName}": { + "get": { + "tags": [ + "ManagementPolicies" + ], + "operationId": "ManagementPolicies_Get", + "description": "Gets the managementpolicy associated with the specified storage account.", + "x-ms-examples": { + "StorageAccountGetManagementPolicies": { + "$ref": "./examples/StorageAccountGetManagementPolicy.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ManagementPolicyName" + } + ], + "responses": { + "200": { + "description": "OK -- Get the managementpolicy successfully.", + "schema": { + "$ref": "#/definitions/ManagementPolicy" + } + } + } + }, + "put": { + "tags": [ + "ManagementPolicies" + ], + "operationId": "ManagementPolicies_CreateOrUpdate", + "description": "Sets the managementpolicy to the specified storage account.", + "x-ms-examples": { + "StorageAccountSetManagementPolicies": { + "$ref": "./examples/StorageAccountSetManagementPolicy.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ManagementPolicyName" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagementPolicy" + }, + "description": "The ManagementPolicy set to a storage account." + } + ], + "responses": { + "200": { + "description": "OK -- Put managementpolicy successfully.", + "schema": { + "$ref": "#/definitions/ManagementPolicy" + } + } + } + }, + "delete": { + "tags": [ + "ManagementPolicies" + ], + "operationId": "ManagementPolicies_Delete", + "description": "Deletes the managementpolicy associated with the specified storage account.", + "x-ms-examples": { + "StorageAccountDeleteManagementPolicies": { + "$ref": "./examples/StorageAccountDeleteManagementPolicy.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ManagementPolicyName" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the managementpolicy successfully." + }, + "204": { + "description": "No Content -- The managementpolicy does not exist." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "description": "List all the private endpoint connections associated with the storage account.", + "x-ms-examples": { + "StorageAccountListPrivateEndpointConnections": { + "$ref": "./examples/StorageAccountListPrivateEndpointConnections.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnectionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the storage account.", + "x-ms-examples": { + "StorageAccountGetPrivateEndpointConnection": { + "$ref": "./examples/StorageAccountGetPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "OK -- Get the private endpoint connection properties successfully.", + "schema": { + "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Put", + "description": "Update the state of specified private endpoint connection associated with the storage account.", + "x-ms-examples": { + "StorageAccountPutPrivateEndpointConnection": { + "$ref": "./examples/StorageAccountPutPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "The private endpoint connection properties." + } + ], + "responses": { + "200": { + "description": "OK -- Update the private endpoint connection properties successfully.", + "schema": { + "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "description": "Deletes the specified private endpoint connection associated with the storage account.", + "x-ms-examples": { + "StorageAccountDeletePrivateEndpointConnection": { + "$ref": "./examples/StorageAccountDeletePrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the private endpoint connection successfully." + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_ListByStorageAccount", + "description": "Gets the private link resources that need to be created for a storage account.", + "x-ms-examples": { + "StorageAccountListPrivateLinkResources": { + "$ref": "./examples/StorageAccountListPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "./privatelinks.json#/definitions/PrivateLinkResourceListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/objectReplicationPolicies": { + "get": { + "tags": [ + "ObjectReplicationPolicies" + ], + "operationId": "ObjectReplicationPolicies_List", + "description": "List the object replication policies associated with the storage account.", + "x-ms-examples": { + "StorageAccountListObjectReplicationPolicies": { + "$ref": "./examples/StorageAccountListObjectReplicationPolicies.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- List object replication policies successfully.", + "schema": { + "$ref": "#/definitions/ObjectReplicationPolicies" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/objectReplicationPolicies/{objectReplicationPolicyId}": { + "get": { + "tags": [ + "ObjectReplicationPolicies" + ], + "operationId": "ObjectReplicationPolicies_Get", + "description": "Get the object replication policy of the storage account by policy ID.", + "x-ms-examples": { + "StorageAccountGetObjectReplicationPolicies": { + "$ref": "./examples/StorageAccountGetObjectReplicationPolicy.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ObjectReplicationPolicyId" + } + ], + "responses": { + "200": { + "description": "OK -- Get the object replication policy successfully.", + "schema": { + "$ref": "#/definitions/ObjectReplicationPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "ObjectReplicationPolicies" + ], + "operationId": "ObjectReplicationPolicies_CreateOrUpdate", + "description": "Create or update the object replication policy of the storage account.", + "x-ms-examples": { + "StorageAccountCreateObjectReplicationPolicyOnDestination": { + "$ref": "./examples/StorageAccountCreateObjectReplicationPolicyOnDestination.json" + }, + "StorageAccountCreateObjectReplicationPolicyOnSource": { + "$ref": "./examples/StorageAccountCreateObjectReplicationPolicyOnSource.json" + }, + "StorageAccountUpdateObjectReplicationPolicyOnDestination": { + "$ref": "./examples/StorageAccountUpdateObjectReplicationPolicyOnDestination.json" + }, + "StorageAccountUpdateObjectReplicationPolicyOnSource": { + "$ref": "./examples/StorageAccountUpdateObjectReplicationPolicyOnSource.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ObjectReplicationPolicyId" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ObjectReplicationPolicy" + }, + "description": "The object replication policy set to a storage account. A unique policy ID will be created if absent." + } + ], + "responses": { + "200": { + "description": "OK -- Put object replication policy successfully.", + "schema": { + "$ref": "#/definitions/ObjectReplicationPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ObjectReplicationPolicies" + ], + "operationId": "ObjectReplicationPolicies_Delete", + "description": "Deletes the object replication policy associated with the specified storage account.", + "x-ms-examples": { + "StorageAccountDeleteObjectReplicationPolicies": { + "$ref": "./examples/StorageAccountDeleteObjectReplicationPolicy.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ObjectReplicationPolicyId" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the object replication policy successfully." + }, + "204": { + "description": "No Content -- The object replication policy does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/revokeUserDelegationKeys": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_RevokeUserDelegationKeys", + "description": "Revoke user delegation keys.", + "x-ms-examples": { + "StorageAccountRevokeUserDelegationKeys": { + "$ref": "./examples/StorageAccountRevokeUserDelegationKeys.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.", + "maxLength": 24, + "minLength": 3 + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- revoke user delegation keys succeeded." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/encryptionScopes/{encryptionScopeName}": { + "put": { + "tags": [ + "EncryptionScopes" + ], + "operationId": "EncryptionScopes_Put", + "description": "Synchronously creates or updates an encryption scope under the specified storage account. If an encryption scope is already created and a subsequent request is issued with different properties, the encryption scope properties will be updated per the specified request.", + "x-ms-examples": { + "StorageAccountPutEncryptionScope": { + "$ref": "./examples/StorageAccountPutEncryptionScope.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/EncryptionScopeName" + }, + { + "name": "encryptionScope", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EncryptionScope" + }, + "description": "Encryption scope properties to be used for the create or update." + } + ], + "responses": { + "201": { + "description": "Created -- Create encryption scope operation completed successfully.", + "schema": { + "$ref": "#/definitions/EncryptionScope" + } + }, + "200": { + "description": "OK -- Update encryption scope operation completed successfully.", + "schema": { + "$ref": "#/definitions/EncryptionScope" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "EncryptionScopes" + ], + "operationId": "EncryptionScopes_Patch", + "description": "Update encryption scope properties as specified in the request body. Update fails if the specified encryption scope does not already exist.", + "x-ms-examples": { + "StorageAccountPatchEncryptionScope": { + "$ref": "./examples/StorageAccountPatchEncryptionScope.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/EncryptionScopeName" + }, + { + "name": "encryptionScope", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EncryptionScope" + }, + "description": "Encryption scope properties to be used for the update." + } + ], + "responses": { + "200": { + "description": "OK -- Update encryption scope operation completed successfully.", + "schema": { + "$ref": "#/definitions/EncryptionScope" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "EncryptionScopes" + ], + "operationId": "EncryptionScopes_Get", + "description": "Returns the properties for the specified encryption scope.", + "x-ms-examples": { + "StorageAccountGetEncryptionScope": { + "$ref": "./examples/StorageAccountGetEncryptionScope.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/EncryptionScopeName" + } + ], + "responses": { + "200": { + "description": "OK -- Get encryption scope operation completed successfully.", + "schema": { + "$ref": "#/definitions/EncryptionScope" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/encryptionScopes": { + "get": { + "tags": [ + "EncryptionScopes" + ], + "operationId": "EncryptionScopes_List", + "description": "Lists all the encryption scopes available under the specified storage account.", + "x-ms-examples": { + "StorageAccountEncryptionScopeList": { + "$ref": "./examples/StorageAccountEncryptionScopeList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- List encryption scopes operation completed successfully.", + "schema": { + "$ref": "#/definitions/EncryptionScopeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Storage 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 Storage operations supported by the Storage resource provider." + } + } + }, + "Operation": { + "description": "Storage REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft Storage.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed etc.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation.", + "type": "string" + } + } + }, + "origin": { + "type": "string", + "description": "The origin of operations." + }, + "properties": { + "description": "Properties of operation, include metric specifications.", + "x-ms-client-flatten": true, + "x-ms-client-name": "OperationProperties", + "$ref": "#/definitions/OperationProperties" + } + } + }, + "OperationProperties": { + "description": "Properties of operation, include metric specifications.", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "One property of operation, include metric specifications." + } + } + }, + "ServiceSpecification": { + "description": "One property of operation, include metric specifications.", + "properties": { + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + } + } + } + }, + "MetricSpecification": { + "description": "Metric specification of operation.", + "properties": { + "name": { + "type": "string", + "description": "Name of metric specification." + }, + "displayName": { + "type": "string", + "description": "Display name of metric specification." + }, + "displayDescription": { + "type": "string", + "description": "Display description of metric specification." + }, + "unit": { + "type": "string", + "description": "Unit could be Bytes or Count." + }, + "dimensions": { + "description": "Dimensions of blobs, including blob type and access tier.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + } + }, + "aggregationType": { + "type": "string", + "description": "Aggregation type could be Average." + }, + "fillGapWithZero": { + "type": "boolean", + "description": "The property to decide fill gap with zero or not." + }, + "category": { + "type": "string", + "description": "The category this metric specification belong to, could be Capacity." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "Account Resource Id." + } + } + }, + "Dimension": { + "description": "Dimension of blobs, possibly be blob type or access tier.", + "properties": { + "name": { + "type": "string", + "description": "Display name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + } + } + }, + "StorageAccountCheckNameAvailabilityParameters": { + "properties": { + "name": { + "type": "string", + "description": "The storage account name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Storage/storageAccounts" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": false + }, + "description": "The type of resource, Microsoft.Storage/storageAccounts" + } + }, + "required": [ + "name", + "type" + ], + "description": "The parameters used to check the availability of the storage account name." + }, + "SKUCapability": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The name of capability, The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc." + }, + "value": { + "readOnly": true, + "type": "string", + "description": "A string value to indicate states of given capability. Possibly 'true' or 'false'." + } + }, + "description": "The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc." + }, + "Restriction": { + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The type of restrictions. As of now only possible value for this is location." + }, + "values": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted." + }, + "reasonCode": { + "type": "string", + "enum": [ + "QuotaId", + "NotAvailableForSubscription" + ], + "x-ms-enum": { + "name": "ReasonCode", + "modelAsString": true + }, + "description": "The reason for the restriction. As of now this can be \"QuotaId\" or \"NotAvailableForSubscription\". Quota Id is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. The \"NotAvailableForSubscription\" is related to capacity at DC." + } + }, + "description": "The restriction because of which SKU cannot be used." + }, + "StorageSkuListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SkuInformation" + }, + "description": "Get the list result of storage SKUs and their properties." + } + }, + "description": "The response from the List Storage SKUs operation." + }, + "CheckNameAvailabilityResult": { + "properties": { + "nameAvailable": { + "readOnly": true, + "type": "boolean", + "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or is invalid and cannot be used." + }, + "reason": { + "readOnly": true, + "type": "string", + "description": "Gets the reason that a storage account name could not be used. The Reason element is only returned if NameAvailable is false.", + "enum": [ + "AccountNameInvalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "Reason", + "modelAsString": false + } + }, + "message": { + "readOnly": true, + "type": "string", + "description": "Gets an error message explaining the Reason value in more detail." + } + }, + "description": "The CheckNameAvailability operation response." + }, + "SkuInformation": { + "properties": { + "name": { + "$ref": "./common.json#/definitions/SkuName" + }, + "tier": { + "$ref": "./common.json#/definitions/Tier" + }, + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of the resource, usually it is 'storageAccounts'." + }, + "kind": { + "readOnly": true, + "type": "string", + "description": "Indicates the type of storage account.", + "enum": [ + "Storage", + "StorageV2", + "BlobStorage", + "FileStorage", + "BlockBlobStorage" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": true + } + }, + "locations": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.)." + }, + "capabilities": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SKUCapability" + }, + "description": "The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc." + }, + "restrictions": { + "type": "array", + "items": { + "$ref": "#/definitions/Restriction" + }, + "description": "The restrictions because of which SKU cannot be used. This is empty if there are no restrictions." + } + }, + "required": [ + "name" + ], + "description": "Storage SKU and its properties" + }, + "CustomDomain": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source." + }, + "useSubDomainName": { + "type": "boolean", + "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates." + } + }, + "required": [ + "name" + ], + "description": "The custom domain assigned to this storage account. This can be set via Update." + }, + "EncryptionService": { + "properties": { + "enabled": { + "type": "boolean", + "description": "A boolean indicating whether or not the service encrypts the data as it is stored." + }, + "lastEnabledTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate." + }, + "keyType": { + "type": "string", + "description": "Encryption key type to be used for the encryption service. 'Account' key type implies that an account-scoped encryption key will be used. 'Service' key type implies that a default service key is used.", + "enum": [ + "Service", + "Account" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true + }, + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "description": "A service that allows server-side encryption to be used." + }, + "EncryptionServices": { + "properties": { + "blob": { + "$ref": "#/definitions/EncryptionService", + "description": "The encryption function of the blob storage service." + }, + "file": { + "$ref": "#/definitions/EncryptionService", + "description": "The encryption function of the file storage service." + }, + "table": { + "$ref": "#/definitions/EncryptionService", + "description": "The encryption function of the table storage service." + }, + "queue": { + "$ref": "#/definitions/EncryptionService", + "description": "The encryption function of the queue storage service." + } + }, + "description": "A list of services that support encryption." + }, + "KeyVaultProperties": { + "description": "Properties of key vault.", + "properties": { + "keyname": { + "type": "string", + "description": "The name of KeyVault key.", + "x-ms-client-name": "KeyName" + }, + "keyversion": { + "type": "string", + "description": "The version of KeyVault key.", + "x-ms-client-name": "KeyVersion" + }, + "keyvaulturi": { + "type": "string", + "description": "The Uri of KeyVault.", + "x-ms-client-name": "KeyVaultUri" + }, + "currentVersionedKeyIdentifier": { + "type": "string", + "readOnly": true, + "description": "The object identifier of the current versioned Key Vault Key in use.", + "x-ms-client-name": "CurrentVersionedKeyIdentifier" + }, + "lastKeyRotationTimestamp": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "Timestamp of last rotation of the Key Vault Key.", + "x-ms-client-name": "LastKeyRotationTimestamp" + } + } + }, + "Encryption": { + "properties": { + "services": { + "$ref": "#/definitions/EncryptionServices", + "description": "List of services which support encryption." + }, + "keySource": { + "type": "string", + "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault", + "enum": [ + "Microsoft.Storage", + "Microsoft.Keyvault" + ], + "x-ms-enum": { + "name": "KeySource", + "modelAsString": true + }, + "default": "Microsoft.Storage" + }, + "requireInfrastructureEncryption": { + "type": "boolean", + "x-ms-client-name": "RequireInfrastructureEncryption", + "description": "A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest." + }, + "keyvaultproperties": { + "$ref": "#/definitions/KeyVaultProperties", + "x-ms-client-name": "KeyVaultProperties", + "description": "Properties provided by key vault." + } + }, + "required": [ + "keySource" + ], + "description": "The encryption settings on the storage account." + }, + "VirtualNetworkRule": { + "properties": { + "id": { + "type": "string", + "x-ms-client-name": "VirtualNetworkResourceId", + "description": "Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}." + }, + "action": { + "type": "string", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "Action", + "modelAsString": false + }, + "default": "Allow", + "description": "The action of virtual network rule." + }, + "state": { + "type": "string", + "enum": [ + "provisioning", + "deprovisioning", + "succeeded", + "failed", + "networkSourceDeleted" + ], + "x-ms-enum": { + "name": "State", + "modelAsString": false + }, + "description": "Gets the state of virtual network rule." + } + }, + "required": [ + "id" + ], + "description": "Virtual Network rule." + }, + "IPRule": { + "properties": { + "value": { + "type": "string", + "x-ms-client-name": "IPAddressOrRange", + "description": "Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed." + }, + "action": { + "type": "string", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "Action", + "modelAsString": false + }, + "default": "Allow", + "description": "The action of IP ACL rule." + } + }, + "required": [ + "value" + ], + "description": "IP rule with specific IP or IP range in CIDR format." + }, + "NetworkRuleSet": { + "properties": { + "bypass": { + "type": "string", + "enum": [ + "None", + "Logging", + "Metrics", + "AzureServices" + ], + "x-ms-enum": { + "name": "Bypass", + "modelAsString": true + }, + "x-ms-client-name": "Bypass", + "default": "AzureServices", + "description": "Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, \"Logging, Metrics\"), or None to bypass none of those traffics." + }, + "virtualNetworkRules": { + "type": "array", + "items": { + "description": "Virtual Network rule.", + "$ref": "#/definitions/VirtualNetworkRule" + }, + "description": "Sets the virtual network rules" + }, + "ipRules": { + "type": "array", + "items": { + "description": "IP rule with specific IP or IP range in CIDR format.", + "$ref": "#/definitions/IPRule" + }, + "description": "Sets the IP ACL rules" + }, + "defaultAction": { + "type": "string", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "DefaultAction", + "modelAsString": false + }, + "default": "Allow", + "description": "Specifies the default action of allow or deny when no other rules match." + } + }, + "required": [ + "defaultAction" + ], + "description": "Network rule set" + }, + "AzureFilesIdentityBasedAuthentication": { + "properties": { + "directoryServiceOptions": { + "type": "string", + "description": "Indicates the directory service used.", + "enum": [ + "None", + "AADDS", + "AD" + ], + "x-ms-enum": { + "name": "DirectoryServiceOptions", + "modelAsString": true + } + }, + "activeDirectoryProperties": { + "$ref": "#/definitions/ActiveDirectoryProperties", + "description": "Required if choose AD." + } + }, + "required": [ + "directoryServiceOptions" + ], + "description": "Settings for Azure Files identity based authentication." + }, + "ActiveDirectoryProperties": { + "properties": { + "domainName": { + "type": "string", + "description": "Specifies the primary domain that the AD DNS server is authoritative for." + }, + "netBiosDomainName": { + "type": "string", + "description": "Specifies the NetBIOS domain name." + }, + "forestName": { + "type": "string", + "description": "Specifies the Active Directory forest to get." + }, + "domainGuid": { + "type": "string", + "description": "Specifies the domain GUID." + }, + "domainSid": { + "type": "string", + "description": "Specifies the security identifier (SID)." + }, + "azureStorageSid": { + "type": "string", + "description": "Specifies the security identifier (SID) for Azure Storage." + } + }, + "required": [ + "domainName", + "netBiosDomainName", + "forestName", + "domainGuid", + "domainSid", + "azureStorageSid" + ], + "description": "Settings properties for Active Directory (AD)." + }, + "StorageAccountPropertiesCreateParameters": { + "properties": { + "customDomain": { + "$ref": "#/definitions/CustomDomain", + "description": "User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Not applicable. Azure Storage encryption is enabled for all storage accounts and cannot be disabled." + }, + "networkAcls": { + "$ref": "#/definitions/NetworkRuleSet", + "x-ms-client-name": "NetworkRuleSet", + "description": "Network rule set" + }, + "accessTier": { + "type": "string", + "description": "Required for storage accounts where kind = BlobStorage. The access tier used for billing.", + "enum": [ + "Hot", + "Cool" + ], + "x-ms-enum": { + "name": "AccessTier", + "modelAsString": false + } + }, + "azureFilesIdentityBasedAuthentication": { + "$ref": "#/definitions/AzureFilesIdentityBasedAuthentication", + "description": "Provides the identity based authentication settings for Azure Files." + }, + "supportsHttpsTrafficOnly": { + "type": "boolean", + "x-ms-client-name": "EnableHttpsTrafficOnly", + "description": "Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01." + }, + "isHnsEnabled": { + "type": "boolean", + "x-ms-client-name": "IsHnsEnabled", + "description": "Account HierarchicalNamespace enabled if sets to true." + }, + "largeFileSharesState": { + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "LargeFileSharesState", + "modelAsString": true + }, + "description": "Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled." + }, + "routingPreference": { + "$ref": "#/definitions/RoutingPreference", + "x-ms-client-name": "RoutingPreference", + "description": "Maintains information about the network routing choice opted by the user for data transfer" + }, + "allowBlobPublicAccess": { + "type": "boolean", + "x-ms-client-name": "AllowBlobPublicAccess", + "description": "Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property." + }, + "minimumTlsVersion": { + "type": "string", + "enum": [ + "TLS1_0", + "TLS1_1", + "TLS1_2" + ], + "x-ms-enum": { + "name": "MinimumTlsVersion", + "modelAsString": true + }, + "description": "Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property." + } + }, + "description": "The parameters used to create the storage account." + }, + "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" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": false + } + } + }, + "required": [ + "type" + ], + "description": "Identity for the resource." + }, + "StorageAccountCreateParameters": { + "properties": { + "sku": { + "$ref": "./common.json#/definitions/Sku", + "description": "Required. Gets or sets the SKU name." + }, + "kind": { + "type": "string", + "description": "Required. Indicates the type of storage account.", + "enum": [ + "Storage", + "StorageV2", + "BlobStorage", + "FileStorage", + "BlockBlobStorage" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": true + } + }, + "location": { + "type": "string", + "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageAccountPropertiesCreateParameters", + "description": "The parameters used to create the storage account." + } + }, + "required": [ + "sku", + "kind", + "location" + ], + "description": "The parameters used when creating a storage account." + }, + "Endpoints": { + "properties": { + "blob": { + "readOnly": true, + "type": "string", + "description": "Gets the blob endpoint." + }, + "queue": { + "readOnly": true, + "type": "string", + "description": "Gets the queue endpoint." + }, + "table": { + "readOnly": true, + "type": "string", + "description": "Gets the table endpoint." + }, + "file": { + "readOnly": true, + "type": "string", + "description": "Gets the file endpoint." + }, + "web": { + "readOnly": true, + "type": "string", + "description": "Gets the web endpoint." + }, + "dfs": { + "readOnly": true, + "type": "string", + "description": "Gets the dfs endpoint." + }, + "microsoftEndpoints": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/StorageAccountMicrosoftEndpoints", + "description": "Gets the microsoft routing storage endpoints." + }, + "internetEndpoints": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/StorageAccountInternetEndpoints", + "description": "Gets the internet routing storage endpoints" + } + }, + "description": "The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object." + }, + "StorageAccountMicrosoftEndpoints": { + "properties": { + "blob": { + "readOnly": true, + "type": "string", + "description": "Gets the blob endpoint." + }, + "queue": { + "readOnly": true, + "type": "string", + "description": "Gets the queue endpoint." + }, + "table": { + "readOnly": true, + "type": "string", + "description": "Gets the table endpoint." + }, + "file": { + "readOnly": true, + "type": "string", + "description": "Gets the file endpoint." + }, + "web": { + "readOnly": true, + "type": "string", + "description": "Gets the web endpoint." + }, + "dfs": { + "readOnly": true, + "type": "string", + "description": "Gets the dfs endpoint." + } + }, + "description": "The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint." + }, + "StorageAccountInternetEndpoints": { + "properties": { + "blob": { + "readOnly": true, + "type": "string", + "description": "Gets the blob endpoint." + }, + "file": { + "readOnly": true, + "type": "string", + "description": "Gets the file endpoint." + }, + "web": { + "readOnly": true, + "type": "string", + "description": "Gets the web endpoint." + }, + "dfs": { + "readOnly": true, + "type": "string", + "description": "Gets the dfs endpoint." + } + }, + "description": "The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint." + }, + "GeoReplicationStats": { + "properties": { + "status": { + "readOnly": true, + "type": "string", + "description": "The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable.", + "enum": [ + "Live", + "Bootstrap", + "Unavailable" + ], + "x-ms-enum": { + "name": "GeoReplicationStatus", + "modelAsString": true + } + }, + "lastSyncTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap." + }, + "canFailover": { + "readOnly": true, + "type": "boolean", + "description": "A boolean flag which indicates whether or not account failover is supported for the account." + } + }, + "description": "Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account." + }, + "RoutingPreference": { + "properties": { + "routingChoice": { + "type": "string", + "description": "Routing Choice defines the kind of network routing opted by the user.", + "enum": [ + "MicrosoftRouting", + "InternetRouting" + ], + "x-ms-enum": { + "name": "RoutingChoice", + "modelAsString": true + } + }, + "publishMicrosoftEndpoints": { + "type": "boolean", + "description": "A boolean flag which indicates whether microsoft routing storage endpoints are to be published" + }, + "publishInternetEndpoints": { + "type": "boolean", + "description": "A boolean flag which indicates whether internet routing storage endpoints are to be published" + } + }, + "description": "Routing preference defines the type of network, either microsoft or internet routing to be used to deliver the user data, the default option is microsoft routing" + }, + "BlobRestoreStatus": { + "properties": { + "status": { + "readOnly": true, + "type": "string", + "description": "The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed.", + "enum": [ + "InProgress", + "Complete", + "Failed" + ], + "x-ms-enum": { + "name": "BlobRestoreProgressStatus", + "modelAsString": true + } + }, + "failureReason": { + "readOnly": true, + "type": "string", + "description": "Failure reason when blob restore is failed." + }, + "restoreId": { + "readOnly": true, + "type": "string", + "description": "Id for tracking blob restore request." + }, + "parameters": { + "readOnly": true, + "$ref": "#/definitions/BlobRestoreParameters", + "description": "Blob restore request parameters." + } + }, + "description": "Blob restore status." + }, + "DeletedAccountProperties": { + "properties": { + "storageAccountResourceId": { + "readOnly": true, + "type": "string", + "description": "Full resource id of the original storage account." + }, + "location": { + "readOnly": true, + "type": "string", + "description": "Location of the deleted account." + }, + "restoreReference": { + "readOnly": true, + "type": "string", + "description": "Can be used to attempt recovering this deleted account via PutStorageAccount API." + }, + "creationTime": { + "readOnly": true, + "type": "string", + "description": "Creation time of the deleted account." + }, + "deletionTime": { + "readOnly": true, + "type": "string", + "description": "Deletion time of the deleted account." + } + } + }, + "StorageAccountProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the storage account at the time the operation was called.", + "enum": [ + "Creating", + "ResolvingDNS", + "Succeeded" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "primaryEndpoints": { + "$ref": "#/definitions/Endpoints", + "readOnly": true, + "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object. Note that Standard_ZRS and Premium_LRS accounts only return the blob endpoint." + }, + "primaryLocation": { + "readOnly": true, + "type": "string", + "description": "Gets the location of the primary data center for the storage account." + }, + "statusOfPrimary": { + "readOnly": true, + "type": "string", + "description": "Gets the status indicating whether the primary location of the storage account is available or unavailable.", + "enum": [ + "available", + "unavailable" + ], + "x-ms-enum": { + "name": "AccountStatus", + "modelAsString": false + } + }, + "lastGeoFailoverTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS." + }, + "secondaryLocation": { + "readOnly": true, + "type": "string", + "description": "Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS." + }, + "statusOfSecondary": { + "readOnly": true, + "type": "string", + "description": "Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the SKU name is Standard_GRS or Standard_RAGRS.", + "enum": [ + "available", + "unavailable" + ], + "x-ms-enum": { + "name": "AccountStatus", + "modelAsString": false + } + }, + "creationTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Gets the creation date and time of the storage account in UTC." + }, + "customDomain": { + "$ref": "#/definitions/CustomDomain", + "readOnly": true, + "description": "Gets the custom domain the user assigned to this storage account." + }, + "secondaryEndpoints": { + "$ref": "#/definitions/Endpoints", + "readOnly": true, + "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object from the secondary location of the storage account. Only available if the SKU name is Standard_RAGRS." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "readOnly": true, + "description": "Gets the encryption settings on the account. If unspecified, the account is unencrypted." + }, + "accessTier": { + "readOnly": true, + "type": "string", + "description": "Required for storage accounts where kind = BlobStorage. The access tier used for billing.", + "enum": [ + "Hot", + "Cool" + ], + "x-ms-enum": { + "name": "AccessTier", + "modelAsString": false + } + }, + "azureFilesIdentityBasedAuthentication": { + "$ref": "#/definitions/AzureFilesIdentityBasedAuthentication", + "description": "Provides the identity based authentication settings for Azure Files." + }, + "supportsHttpsTrafficOnly": { + "type": "boolean", + "x-ms-client-name": "EnableHttpsTrafficOnly", + "description": "Allows https traffic only to storage service if sets to true." + }, + "networkAcls": { + "$ref": "#/definitions/NetworkRuleSet", + "x-ms-client-name": "NetworkRuleSet", + "description": "Network rule set", + "readOnly": true + }, + "isHnsEnabled": { + "type": "boolean", + "x-ms-client-name": "IsHnsEnabled", + "description": "Account HierarchicalNamespace enabled if sets to true." + }, + "geoReplicationStats": { + "$ref": "#/definitions/GeoReplicationStats", + "x-ms-client-name": "GeoReplicationStats", + "description": "Geo Replication Stats", + "readOnly": true + }, + "failoverInProgress": { + "type": "boolean", + "x-ms-client-name": "FailoverInProgress", + "description": "If the failover is in progress, the value will be true, otherwise, it will be null.", + "readOnly": true + }, + "largeFileSharesState": { + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "LargeFileSharesState", + "modelAsString": true + }, + "description": "Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled." + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "List of private endpoint connection associated with the specified storage account" + }, + "routingPreference": { + "$ref": "#/definitions/RoutingPreference", + "x-ms-client-name": "RoutingPreference", + "description": "Maintains information about the network routing choice opted by the user for data transfer" + }, + "blobRestoreStatus": { + "$ref": "#/definitions/BlobRestoreStatus", + "x-ms-client-name": "BlobRestoreStatus", + "description": "Blob restore status", + "readOnly": true + }, + "allowBlobPublicAccess": { + "type": "boolean", + "x-ms-client-name": "AllowBlobPublicAccess", + "description": "Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property." + }, + "minimumTlsVersion": { + "type": "string", + "enum": [ + "TLS1_0", + "TLS1_1", + "TLS1_2" + ], + "x-ms-enum": { + "name": "MinimumTlsVersion", + "modelAsString": true + }, + "description": "Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property." + } + }, + "description": "Properties of the storage account." + }, + "DeletedAccount": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeletedAccountProperties", + "description": "Properties of the deleted account." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "Deleted storage account" + }, + "StorageAccount": { + "properties": { + "sku": { + "$ref": "./common.json#/definitions/Sku", + "readOnly": true, + "description": "Gets the SKU." + }, + "kind": { + "readOnly": true, + "type": "string", + "description": "Gets the Kind.", + "enum": [ + "Storage", + "StorageV2", + "BlobStorage", + "FileStorage", + "BlockBlobStorage" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": true + } + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageAccountProperties", + "description": "Properties of the storage account." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "description": "The storage account." + }, + "StorageAccountKey": { + "properties": { + "keyName": { + "readOnly": true, + "type": "string", + "description": "Name of the key." + }, + "value": { + "readOnly": true, + "type": "string", + "description": "Base 64-encoded value of the key." + }, + "permissions": { + "readOnly": true, + "type": "string", + "description": "Permissions for the key -- read-only or full permissions.", + "enum": [ + "Read", + "Full" + ], + "x-ms-enum": { + "name": "KeyPermission", + "modelAsString": false + } + } + }, + "description": "An access key for the storage account." + }, + "StorageAccountListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "description": "Gets the list of storage accounts and their properties." + }, + "nextLink": { + "type": "string", + "description": "Request URL that can be used to query next page of storage accounts. Returned when total number of requested storage accounts exceed maximum page size.", + "readOnly": true + } + }, + "description": "The response from the List Storage Accounts operation." + }, + "DeletedAccountListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DeletedAccount" + }, + "description": "Gets the list of deleted accounts and their properties." + }, + "nextLink": { + "type": "string", + "description": "Request URL that can be used to query next page of deleted accounts. Returned when total number of requested deleted accounts exceed maximum page size.", + "readOnly": true + } + }, + "description": "The response from the List Deleted Accounts operation." + }, + "StorageAccountListKeysResult": { + "properties": { + "keys": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccountKey" + }, + "description": "Gets the list of storage account keys and their properties for the specified storage account." + } + }, + "description": "The response from the ListKeys operation." + }, + "StorageAccountRegenerateKeyParameters": { + "properties": { + "keyName": { + "type": "string", + "description": "The name of storage keys that want to be regenerated, possible values are key1, key2, kerb1, kerb2." + } + }, + "required": [ + "keyName" + ], + "description": "The parameters used to regenerate the storage account key." + }, + "StorageAccountPropertiesUpdateParameters": { + "properties": { + "customDomain": { + "$ref": "#/definitions/CustomDomain", + "description": "Custom domain assigned to the storage account by the user. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Provides the encryption settings on the account. The default setting is unencrypted." + }, + "accessTier": { + "type": "string", + "description": "Required for storage accounts where kind = BlobStorage. The access tier used for billing.", + "enum": [ + "Hot", + "Cool" + ], + "x-ms-enum": { + "name": "AccessTier", + "modelAsString": false + } + }, + "azureFilesIdentityBasedAuthentication": { + "$ref": "#/definitions/AzureFilesIdentityBasedAuthentication", + "description": "Provides the identity based authentication settings for Azure Files." + }, + "supportsHttpsTrafficOnly": { + "type": "boolean", + "x-ms-client-name": "EnableHttpsTrafficOnly", + "description": "Allows https traffic only to storage service if sets to true." + }, + "networkAcls": { + "description": "Network rule set", + "x-ms-client-name": "NetworkRuleSet", + "$ref": "#/definitions/NetworkRuleSet" + }, + "largeFileSharesState": { + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "LargeFileSharesState", + "modelAsString": true + }, + "description": "Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled." + }, + "routingPreference": { + "$ref": "#/definitions/RoutingPreference", + "x-ms-client-name": "RoutingPreference", + "description": "Maintains information about the network routing choice opted by the user for data transfer" + }, + "allowBlobPublicAccess": { + "type": "boolean", + "x-ms-client-name": "AllowBlobPublicAccess", + "description": "Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property." + }, + "minimumTlsVersion": { + "type": "string", + "enum": [ + "TLS1_0", + "TLS1_1", + "TLS1_2" + ], + "x-ms-enum": { + "name": "MinimumTlsVersion", + "modelAsString": true + }, + "description": "Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property." + } + }, + "description": "The parameters used when updating a storage account." + }, + "StorageAccountUpdateParameters": { + "properties": { + "sku": { + "$ref": "./common.json#/definitions/Sku", + "description": "Gets or sets the SKU name. Note that the SKU name cannot be updated to Standard_ZRS, Premium_LRS or Premium_ZRS, nor can accounts of those SKU names be updated to any other value." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets a list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater in length than 128 characters and a value no greater in length than 256 characters." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageAccountPropertiesUpdateParameters", + "description": "The parameters used when updating a storage account." + }, + "kind": { + "type": "string", + "description": "Optional. Indicates the type of storage account. Currently only StorageV2 value supported by server.", + "enum": [ + "Storage", + "StorageV2", + "BlobStorage", + "FileStorage", + "BlockBlobStorage" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": true + } + } + }, + "description": "The parameters that can be provided when updating the storage account properties." + }, + "BlobRestoreParameters": { + "properties": { + "timeToRestore": { + "type": "string", + "format": "date-time", + "description": "Restore blob to the specified time." + }, + "blobRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/BlobRestoreRange" + }, + "description": "Blob ranges to restore." + } + }, + "required": [ + "timeToRestore", + "blobRanges" + ], + "description": "Blob restore parameters" + }, + "BlobRestoreRange": { + "properties": { + "startRange": { + "type": "string", + "description": "Blob start range. This is inclusive. Empty means account start." + }, + "endRange": { + "type": "string", + "description": "Blob end range. This is exclusive. Empty means account end." + } + }, + "required": [ + "startRange", + "endRange" + ], + "description": "Blob range" + }, + "UsageName": { + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "Gets a string describing the resource name." + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "Gets a localized string describing the resource name." + } + }, + "description": "The usage names that can be used; currently limited to StorageAccount." + }, + "Usage": { + "properties": { + "unit": { + "readOnly": true, + "type": "string", + "description": "Gets the unit of measurement.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "Percent", + "CountsPerSecond", + "BytesPerSecond" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": false + } + }, + "currentValue": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Gets the current count of the allocated resources in the subscription." + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Gets the maximum count of the resources that can be allocated in the subscription." + }, + "name": { + "$ref": "#/definitions/UsageName", + "readOnly": true, + "description": "Gets the name of the type of usage." + } + }, + "description": "Describes Storage Resource Usage." + }, + "UsageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "Gets or sets the list of Storage Resource Usages." + } + }, + "description": "The response from the List Usages operation." + }, + "AccountSasParameters": { + "properties": { + "signedServices": { + "type": "string", + "enum": [ + "b", + "q", + "t", + "f" + ], + "x-ms-enum": { + "name": "Services", + "modelAsString": true + }, + "x-ms-client-name": "Services", + "description": "The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f)." + }, + "signedResourceTypes": { + "type": "string", + "enum": [ + "s", + "c", + "o" + ], + "x-ms-enum": { + "name": "SignedResourceTypes", + "modelAsString": true + }, + "x-ms-client-name": "ResourceTypes", + "description": "The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files." + }, + "signedPermission": { + "type": "string", + "enum": [ + "r", + "d", + "w", + "l", + "a", + "c", + "u", + "p" + ], + "x-ms-enum": { + "name": "Permissions", + "modelAsString": true + }, + "x-ms-client-name": "Permissions", + "description": "The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p)." + }, + "signedIp": { + "type": "string", + "x-ms-client-name": "IPAddressOrRange", + "description": "An IP address or a range of IP addresses from which to accept requests." + }, + "signedProtocol": { + "type": "string", + "enum": [ + "https,http", + "https" + ], + "x-ms-enum": { + "name": "HttpProtocol", + "modelAsString": false + }, + "x-ms-client-name": "Protocols", + "description": "The protocol permitted for a request made with the account SAS." + }, + "signedStart": { + "type": "string", + "format": "date-time", + "x-ms-client-name": "SharedAccessStartTime", + "description": "The time at which the SAS becomes valid." + }, + "signedExpiry": { + "type": "string", + "format": "date-time", + "x-ms-client-name": "SharedAccessExpiryTime", + "description": "The time at which the shared access signature becomes invalid." + }, + "keyToSign": { + "type": "string", + "description": "The key to sign the account SAS token with." + } + }, + "required": [ + "signedServices", + "signedResourceTypes", + "signedPermission", + "signedExpiry" + ], + "description": "The parameters to list SAS credentials of a storage account." + }, + "ListAccountSasResponse": { + "properties": { + "accountSasToken": { + "readOnly": true, + "type": "string", + "description": "List SAS credentials of storage account." + } + }, + "description": "The List SAS credentials operation response." + }, + "ServiceSasParameters": { + "properties": { + "canonicalizedResource": { + "type": "string", + "description": "The canonical path to the signed resource." + }, + "signedResource": { + "type": "string", + "enum": [ + "b", + "c", + "f", + "s" + ], + "x-ms-enum": { + "name": "signedResource", + "modelAsString": true + }, + "x-ms-client-name": "Resource", + "description": "The signed services accessible with the service SAS. Possible values include: Blob (b), Container (c), File (f), Share (s)." + }, + "signedPermission": { + "type": "string", + "enum": [ + "r", + "d", + "w", + "l", + "a", + "c", + "u", + "p" + ], + "x-ms-enum": { + "name": "Permissions", + "modelAsString": true + }, + "x-ms-client-name": "Permissions", + "description": "The signed permissions for the service SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p)." + }, + "signedIp": { + "type": "string", + "x-ms-client-name": "IPAddressOrRange", + "description": "An IP address or a range of IP addresses from which to accept requests." + }, + "signedProtocol": { + "type": "string", + "enum": [ + "https,http", + "https" + ], + "x-ms-enum": { + "name": "HttpProtocol", + "modelAsString": false + }, + "x-ms-client-name": "Protocols", + "description": "The protocol permitted for a request made with the account SAS." + }, + "signedStart": { + "type": "string", + "format": "date-time", + "x-ms-client-name": "SharedAccessStartTime", + "description": "The time at which the SAS becomes valid." + }, + "signedExpiry": { + "type": "string", + "format": "date-time", + "x-ms-client-name": "SharedAccessExpiryTime", + "description": "The time at which the shared access signature becomes invalid." + }, + "signedIdentifier": { + "type": "string", + "maxLength": 64, + "x-ms-client-name": "Identifier", + "description": "A unique value up to 64 characters in length that correlates to an access policy specified for the container, queue, or table." + }, + "startPk": { + "type": "string", + "x-ms-client-name": "PartitionKeyStart", + "description": "The start of partition key." + }, + "endPk": { + "type": "string", + "x-ms-client-name": "PartitionKeyEnd", + "description": "The end of partition key." + }, + "startRk": { + "type": "string", + "x-ms-client-name": "RowKeyStart", + "description": "The start of row key." + }, + "endRk": { + "type": "string", + "x-ms-client-name": "RowKeyEnd", + "description": "The end of row key." + }, + "keyToSign": { + "type": "string", + "description": "The key to sign the account SAS token with." + }, + "rscc": { + "type": "string", + "x-ms-client-name": "CacheControl", + "description": "The response header override for cache control." + }, + "rscd": { + "type": "string", + "x-ms-client-name": "ContentDisposition", + "description": "The response header override for content disposition." + }, + "rsce": { + "type": "string", + "x-ms-client-name": "ContentEncoding", + "description": "The response header override for content encoding." + }, + "rscl": { + "type": "string", + "x-ms-client-name": "ContentLanguage", + "description": "The response header override for content language." + }, + "rsct": { + "type": "string", + "x-ms-client-name": "ContentType", + "description": "The response header override for content type." + } + }, + "required": [ + "canonicalizedResource" + ], + "description": "The parameters to list service SAS credentials of a specific resource." + }, + "ListServiceSasResponse": { + "properties": { + "serviceSasToken": { + "readOnly": true, + "type": "string", + "description": "List service SAS credentials of specific resource." + } + }, + "description": "The List service SAS credentials operation response." + }, + "ManagementPolicy": { + "properties": { + "properties": { + "$ref": "#/definitions/ManagementPolicyProperties", + "x-ms-client-flatten": true, + "description": "Returns the Storage Account Data Policies Rules." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "description": "The Get Storage Account ManagementPolicies operation response." + }, + "ManagementPolicyProperties": { + "properties": { + "lastModifiedTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Returns the date and time the ManagementPolicies was last modified." + }, + "policy": { + "$ref": "#/definitions/ManagementPolicySchema", + "description": "The Storage Account ManagementPolicy, in JSON format. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts." + } + }, + "required": [ + "policy" + ], + "description": "The Storage Account ManagementPolicy properties." + }, + "ManagementPolicySchema": { + "properties": { + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagementPolicyRule" + }, + "description": "The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts." + } + }, + "required": [ + "rules" + ], + "description": "The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts." + }, + "ManagementPolicyRule": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Rule is enabled if set to true." + }, + "name": { + "type": "string", + "description": "A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy." + }, + "type": { + "type": "string", + "description": "The valid value is Lifecycle", + "enum": [ + "Lifecycle" + ], + "x-ms-enum": { + "name": "RuleType", + "modelAsString": true + } + }, + "definition": { + "$ref": "#/definitions/ManagementPolicyDefinition", + "description": "An object that defines the Lifecycle rule." + } + }, + "required": [ + "name", + "type", + "definition" + ], + "description": "An object that wraps the Lifecycle rule. Each rule is uniquely defined by name." + }, + "ManagementPolicyDefinition": { + "properties": { + "actions": { + "$ref": "#/definitions/ManagementPolicyAction", + "description": "An object that defines the action set." + }, + "filters": { + "$ref": "#/definitions/ManagementPolicyFilter", + "description": "An object that defines the filter set." + } + }, + "required": [ + "actions" + ], + "description": "An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set." + }, + "ManagementPolicyFilter": { + "properties": { + "prefixMatch": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of strings for prefixes to be match." + }, + "blobTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of predefined enum values. Only blockBlob is supported." + }, + "blobIndexMatch": { + "type": "array", + "items": { + "$ref": "#/definitions/TagFilter" + }, + "description": "An array of blob index tag based filters, there can be at most 10 tag filters" + } + }, + "required": [ + "blobTypes" + ], + "description": "Filters limit rule actions to a subset of blobs within the storage account. If multiple filters are defined, a logical AND is performed on all filters. " + }, + "TagFilter": { + "properties": { + "name": { + "type": "string", + "minLength": 1, + "maxLength": 128, + "description": "This is the filter tag name, it can have 1 - 128 characters" + }, + "op": { + "type": "string", + "description": "This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported" + }, + "value": { + "type": "string", + "minLength": 0, + "maxLength": 256, + "description": "This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters" + } + }, + "required": [ + "name", + "op", + "value" + ], + "description": "Blob index tag based filtering for blob objects" + }, + "ManagementPolicyAction": { + "properties": { + "baseBlob": { + "$ref": "#/definitions/ManagementPolicyBaseBlob", + "description": "The management policy action for base blob" + }, + "snapshot": { + "$ref": "#/definitions/ManagementPolicySnapShot", + "description": "The management policy action for snapshot" + } + }, + "description": "Actions are applied to the filtered blobs when the execution condition is met." + }, + "ManagementPolicyBaseBlob": { + "properties": { + "tierToCool": { + "$ref": "#/definitions/DateAfterModification", + "description": "The function to tier blobs to cool storage. Support blobs currently at Hot tier" + }, + "tierToArchive": { + "$ref": "#/definitions/DateAfterModification", + "description": "The function to tier blobs to archive storage. Support blobs currently at Hot or Cool tier" + }, + "delete": { + "$ref": "#/definitions/DateAfterModification", + "description": "The function to delete the blob" + } + }, + "description": "Management policy action for base blob." + }, + "ManagementPolicySnapShot": { + "properties": { + "delete": { + "$ref": "#/definitions/DateAfterCreation", + "description": "The function to delete the blob snapshot" + } + }, + "description": "Management policy action for snapshot." + }, + "DateAfterModification": { + "properties": { + "daysAfterModificationGreaterThan": { + "type": "number", + "multipleOf": 1.0, + "minimum": 0, + "description": "Value indicating the age in days after last modification" + } + }, + "required": [ + "daysAfterModificationGreaterThan" + ], + "description": "Object to define the number of days after last modification." + }, + "DateAfterCreation": { + "properties": { + "daysAfterCreationGreaterThan": { + "type": "number", + "multipleOf": 1.0, + "minimum": 0, + "description": "Value indicating the age in days after creation" + } + }, + "required": [ + "daysAfterCreationGreaterThan" + ], + "description": "Object to define the number of days after creation." + }, + "EncryptionScope": { + "properties": { + "properties": { + "$ref": "#/definitions/EncryptionScopeProperties", + "x-ms-client-flatten": true, + "x-ms-client-name": "EncryptionScopeProperties", + "description": "Properties of the encryption scope." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "description": "The Encryption Scope resource." + }, + "EncryptionScopeProperties": { + "properties": { + "source": { + "type": "string", + "enum": [ + "Microsoft.Storage", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "EncryptionScopeSource", + "modelAsString": true + }, + "description": "The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault." + }, + "state": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EncryptionScopeState", + "modelAsString": true + }, + "description": "The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled." + }, + "creationTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Gets the creation date and time of the encryption scope in UTC." + }, + "lastModifiedTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Gets the last modification date and time of the encryption scope in UTC." + }, + "keyVaultProperties": { + "$ref": "#/definitions/EncryptionScopeKeyVaultProperties", + "description": "The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'." + } + }, + "description": "Properties of the encryption scope." + }, + "EncryptionScopeKeyVaultProperties": { + "properties": { + "keyUri": { + "type": "string", + "description": "The object identifier for a key vault key object. When applied, the encryption scope will use the key referenced by the identifier to enable customer-managed key support on this encryption scope." + } + }, + "description": "The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'." + }, + "EncryptionScopeListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EncryptionScope" + }, + "description": "List of encryption scopes requested.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Request URL that can be used to query next page of encryption scopes. Returned when total number of requested encryption scopes exceeds the maximum page size.", + "readOnly": true + } + }, + "description": "List of encryption scopes requested, and if paging is required, a URL to the next page of encryption scopes." + }, + "ObjectReplicationPolicies": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ObjectReplicationPolicy" + }, + "description": "The replication policy between two storage accounts." + } + }, + "description": "List storage account object replication policies." + }, + "ObjectReplicationPolicy": { + "properties": { + "properties": { + "$ref": "#/definitions/ObjectReplicationPolicyProperties", + "x-ms-client-flatten": true, + "description": "Returns the Storage Account Object Replication Policy." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "description": "The replication policy between two storage accounts. Multiple rules can be defined in one policy." + }, + "ObjectReplicationPolicyProperties": { + "properties": { + "policyId": { + "readOnly": true, + "type": "string", + "description": "A unique id for object replication policy." + }, + "enabledTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Indicates when the policy is enabled on the source account." + }, + "sourceAccount": { + "type": "string", + "description": "Required. Source account name." + }, + "destinationAccount": { + "type": "string", + "description": "Required. Destination account name." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/ObjectReplicationPolicyRule" + }, + "description": "The storage account object replication rules." + } + }, + "required": [ + "sourceAccount", + "destinationAccount" + ], + "description": "The Storage Account ObjectReplicationPolicy properties." + }, + "ObjectReplicationPolicyRule": { + "properties": { + "ruleId": { + "type": "string", + "description": "Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account." + }, + "sourceContainer": { + "type": "string", + "description": "Required. Source container name." + }, + "destinationContainer": { + "type": "string", + "description": "Required. Destination container name." + }, + "filters": { + "$ref": "#/definitions/ObjectReplicationPolicyFilter", + "description": "Optional. An object that defines the filter set." + } + }, + "required": [ + "sourceContainer", + "destinationContainer" + ], + "description": "The replication policy rule between two containers." + }, + "ObjectReplicationPolicyFilter": { + "properties": { + "prefixMatch": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. Filters the results to replicate only blobs whose names begin with the specified prefix." + }, + "minCreationTime": { + "type": "string", + "description": "Blobs created after the time will be replicated to the destination. It must be in datetime format 'yyyy-MM-ddTHH:mm:ssZ'. Example: 2020-02-19T16:05:00Z" + } + }, + "description": "Filters limit replication to a subset of blobs within the storage account. A logical OR is performed on values in the filter. If multiple filters are defined, a logical AND is performed on all filters." + }, + "ErrorResponseBody": { + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + } + }, + "description": "Error response body contract." + }, + "ErrorResponse": { + "properties": { + "error": { + "$ref": "#/definitions/ErrorResponseBody", + "description": "Azure Storage Resource Provider error response body." + } + }, + "description": "An error response from the storage resource provider." + } + }, + "parameters": { + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "StorageAccountName": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "DeletedAccountName": { + "name": "deletedAccountName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the deleted storage account.", + "maxLength": 24, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ManagementPolicyName": { + "name": "managementPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Storage Account Management Policy. It should always be 'default'", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "ManagementPolicyName", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + }, + "EncryptionScopeName": { + "name": "encryptionScopeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the encryption scope within the specified storage account. Encryption scope names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.", + "maxLength": 63, + "minLength": 3, + "x-ms-parameter-location": "method" + }, + "ObjectReplicationPolicyId": { + "name": "objectReplicationPolicyId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of object replication policy or 'default' if the policy ID is unknown.", + "minLength": 1, + "x-ms-parameter-location": "method" + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/table.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/table.json new file mode 100644 index 000000000000..be822d22757a --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/table.json @@ -0,0 +1,495 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-08-01-preview", + "title": "StorageManagementClient", + "description": "The Azure Storage Management API." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices": { + "get": { + "tags": [ + "TableServiceProperties" + ], + "operationId": "TableServices_List", + "x-ms-examples": { + "TableServicesList": { + "$ref": "./examples/TableServicesList.json" + } + }, + "description": "List all table services for the storage account.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- returned the properties of a storage account’s Table service.", + "schema": { + "$ref": "#/definitions/ListTableServices" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./file.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/{tableServiceName}": { + "put": { + "tags": [ + "TableServiceProperties" + ], + "operationId": "TableServices_SetServiceProperties", + "x-ms-examples": { + "TableServicesPut": { + "$ref": "./examples/TableServicesPut.json" + } + }, + "description": "Sets the properties of a storage account’s Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. ", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TableServiceName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TableServiceProperties" + }, + "description": "The properties of a storage account’s Table service, only properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules can be specified." + } + ], + "responses": { + "200": { + "description": "OK -- Sets The properties of a storage account’s Table service successfully.", + "schema": { + "$ref": "#/definitions/TableServiceProperties" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./file.json#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "TableServiceProperties" + ], + "operationId": "TableServices_GetServiceProperties", + "x-ms-examples": { + "TableServicesGet": { + "$ref": "./examples/TableServicesGet.json" + } + }, + "description": "Gets the properties of a storage account’s Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TableServiceName" + } + ], + "responses": { + "200": { + "description": "OK -- returned the properties of a storage account’s Table service.", + "schema": { + "$ref": "#/definitions/TableServiceProperties" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./file.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}": { + "put": { + "tags": [ + "TableService" + ], + "operationId": "Table_Create", + "x-ms-examples": { + "TableOperationPut": { + "$ref": "./examples/TableOperationPut.json" + } + }, + "description": "Creates a new table with the specified table name, under the specified account.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TableName" + } + ], + "responses": { + "200": { + "description": "OK -- Creates a table with the given table name successfully.", + "schema": { + "$ref": "#/definitions/Table" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./file.json#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "TableService" + ], + "operationId": "Table_Update", + "x-ms-examples": { + "TableOperationPatch": { + "$ref": "./examples/TableOperationPatch.json" + } + }, + "description": "Creates a new table with the specified table name, under the specified account.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TableName" + } + ], + "responses": { + "200": { + "description": "OK -- Creates a table with the given table name successfully.", + "schema": { + "$ref": "#/definitions/Table" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./file.json#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "TableService" + ], + "operationId": "Table_Get", + "x-ms-examples": { + "TableOperationGet": { + "$ref": "./examples/TableOperationGet.json" + } + }, + "description": "Gets the table with the specified table name, under the specified account if it exists.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TableName" + } + ], + "responses": { + "200": { + "description": "OK -- returned table with the specified table name successfully.", + "schema": { + "$ref": "#/definitions/Table" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./file.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "TableService" + ], + "operationId": "Table_Delete", + "x-ms-examples": { + "TableOperationDelete": { + "$ref": "./examples/TableOperationDelete.json" + } + }, + "description": "Deletes the table with the specified table name, under the specified account if it exists.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TableName" + } + ], + "responses": { + "204": { + "description": "No Content - Successfully deleted the table with the specified table name" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./file.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables": { + "get": { + "tags": [ + "TableService" + ], + "operationId": "Table_List", + "x-ms-examples": { + "TableOperationList": { + "$ref": "./examples/TableOperationList.json" + } + }, + "description": "Gets a list of all the tables under the specified storage account", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- returned a list of tables successfully.", + "schema": { + "$ref": "#/definitions/ListTableResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./file.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ListTableServices": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TableServiceProperties" + }, + "description": "List of table services returned.", + "readOnly": true + } + } + }, + "TableServiceProperties": { + "properties": { + "properties": { + "properties": { + "cors": { + "$ref": "./common.json#/definitions/CorsRules", + "description": "Specifies CORS rules for the Table service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Table service." + } + }, + "x-ms-client-flatten": true, + "x-ms-client-name": "TableServiceProperties", + "description": "The properties of a storage account’s Table service." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "description": "The properties of a storage account’s Table service." + }, + "Table": { + "properties": { + "properties": { + "$ref": "#/definitions/TableProperties", + "x-ms-client-flatten": true, + "x-ms-client-name": "TableProperties", + "description": "Table resource properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "description": "Properties of the table, including Id, resource name, resource type." + }, + "TableProperties": { + "properties": { + "tableName": { + "type": "string", + "readOnly": true, + "description": "Table name under the specified account" + } + } + }, + "ListTableResource": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Table" + }, + "description": "List of tables returned.", + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "Request URL that can be used to query next page of tables", + "readOnly": true + } + }, + "description": "Response schema. Contains list of tables returned" + } + }, + "parameters": { + "TableServiceName": { + "name": "tableServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Table Service within the specified storage account. Table Service Name must be 'default'", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "TableName": { + "name": "tableName", + "in": "path", + "required": true, + "type": "string", + "description": "A table name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of only alphanumeric characters and it cannot begin with a numeric character.", + "maxLength": 63, + "minLength": 3, + "pattern": "^[A-Za-z][A-Za-z0-9]{2,62}$", + "x-ms-parameter-location": "method" + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/storage/resource-manager/readme.azureresourceschema.md b/specification/storage/resource-manager/readme.azureresourceschema.md index 4ecf6047074d..6856d80a8a36 100644 --- a/specification/storage/resource-manager/readme.azureresourceschema.md +++ b/specification/storage/resource-manager/readme.azureresourceschema.md @@ -6,6 +6,7 @@ These settings apply only when `--azureresourceschema` is specified on the comma ``` yaml $(azureresourceschema) && $(multiapi) batch: + - tag: schema-storage-2020-08-01-preview - tag: schema-storage-2019-06-01 - tag: schema-storage-2019-04-01 - tag: schema-storage-2018-11-01 @@ -24,6 +25,21 @@ batch: Please also specify `--azureresourceschema-folder=`. +### Tag: schema-storage-2020-08-01-preview and azureresourceschema + +``` yaml $(tag) == 'schema-storage-2020-08-01-preview' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.Storage/preview/2020-08-01-preview/storage.json + - Microsoft.Storage/preview/2020-08-01-preview/blob.json + - Microsoft.Storage/preview/2020-08-01-preview/file.json + - Microsoft.Storage/preview/2020-08-01-preview/queue.json + - Microsoft.Storage/preview/2020-08-01-preview/table.json + +``` + ### Tag: schema-storage-2019-06-01 and azureresourceschema ``` yaml $(tag) == 'schema-storage-2019-06-01' && $(azureresourceschema) diff --git a/specification/storage/resource-manager/readme.go.md b/specification/storage/resource-manager/readme.go.md index acb6147d8324..6ecd43bc6a06 100644 --- a/specification/storage/resource-manager/readme.go.md +++ b/specification/storage/resource-manager/readme.go.md @@ -13,6 +13,7 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2020-08-preview - tag: package-2019-06 - tag: package-2019-04 - tag: package-2018-11 @@ -28,6 +29,15 @@ batch: - tag: package-2015-05-preview ``` +### Tag: package-2020-08-preview and go + +These settings apply only when `--tag=package-2020-08-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-08-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-08-preview/$(namespace) +``` + ### Tag: package-2019-06 and go These settings apply only when `--tag=package-2019-06 --go` is specified on the command line. diff --git a/specification/storage/resource-manager/readme.java.md b/specification/storage/resource-manager/readme.java.md index 5e4c2b9dcb42..186b449ec8b5 100644 --- a/specification/storage/resource-manager/readme.java.md +++ b/specification/storage/resource-manager/readme.java.md @@ -16,6 +16,7 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-storage ``` yaml $(java) && $(multiapi) batch: + - tag: package-2020-08-preview - tag: package-2019-06 - tag: package-2019-04 - tag: package-2018-07 @@ -25,6 +26,19 @@ batch: - tag: package-2016-01 ``` +### Tag: package-2020-08-preview and java + +These settings apply only when `--tag=package-2020-08-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2020-08-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.storage.v2019_08_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/storage/mgmt-v2019_08_01_preview +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2019-06 and java These settings apply only when `--tag=package-2019-06 --java` is specified on the command line. diff --git a/specification/storage/resource-manager/readme.md b/specification/storage/resource-manager/readme.md index b7b79eeb155a..4f58f5579193 100644 --- a/specification/storage/resource-manager/readme.md +++ b/specification/storage/resource-manager/readme.md @@ -29,6 +29,33 @@ openapi-type: arm tag: package-2019-06 ``` +### Tag: package-2020-08-preview + +These settings apply only when `--tag=package-2020-08-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2020-08-preview' +input-file: +- Microsoft.Storage/preview/2020-08-01-preview/storage.json +- Microsoft.Storage/preview/2020-08-01-preview/blob.json +- Microsoft.Storage/preview/2020-08-01-preview/file.json +- Microsoft.Storage/preview/2020-08-01-preview/queue.json +- Microsoft.Storage/preview/2020-08-01-preview/table.json + +directive: + - suppress: R3018 + reason: Existing boolean properties + approved-by: "@fearthecowboy" + + - where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/setLegalHold"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/clearLegalHold"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey"].post.operationId + suppress: R1003 + reason: APIs return array of values, is not actually a 'list' operation + approved-by: "@fearthecowboy" + +``` + ### Tag: package-2019-06 These settings apply only when `--tag=package-2019-06` is specified on the command line. @@ -304,6 +331,11 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.Storage/preview/2020-08-01-preview/storage.json + - $(this-folder)/Microsoft.Storage/preview/2020-08-01-preview/blob.json + - $(this-folder)/Microsoft.Storage/preview/2020-08-01-preview/file.json + - $(this-folder)/Microsoft.Storage/preview/2020-08-01-preview/queue.json + - $(this-folder)/Microsoft.Storage/preview/2020-08-01-preview/table.json - $(this-folder)/Microsoft.Storage/stable/2019-06-01/storage.json - $(this-folder)/Microsoft.Storage/stable/2019-06-01/blob.json - $(this-folder)/Microsoft.Storage/stable/2019-06-01/file.json diff --git a/specification/storage/resource-manager/readme.python.md b/specification/storage/resource-manager/readme.python.md index 33cad3bd0119..9c4a6ba3d79f 100644 --- a/specification/storage/resource-manager/readme.python.md +++ b/specification/storage/resource-manager/readme.python.md @@ -25,6 +25,7 @@ Generate all API versions currently shipped for this package ```yaml $(multiapi) && !$(track2) batch: + - tag: package-2020-08-preview - tag: package-2019-06 - tag: package-2019-04 - tag: package-2018-11 @@ -41,6 +42,7 @@ batch: ```yaml $(multiapi) && $(track2) clear-output-folder: true batch: + - tag: package-2020-08-preview - tag: package-2019-06 - tag: package-2019-04 - tag: package-2018-11 @@ -61,6 +63,18 @@ clear-output-folder: false perform-load: false ``` +### Tag: package-2020-08-preview and python + +These settings apply only when `--tag=package-2020-08-preview --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-08-preview' +namespace: azure.mgmt.storage.v2020_08_01_preview +output-folder: $(python-sdks-folder)/storage/azure-mgmt-storage/azure/mgmt/storage/v2020_08_01_preview +python: + namespace: azure.mgmt.storage.v2020_08_01_preview + output-folder: $(python-sdks-folder)/storage/azure-mgmt-storage/azure/mgmt/storage/v2020_08_01_preview +``` ### Tag: package-2019-06 and python These settings apply only when `--tag=package-2019-06 --python` is specified on the command line. diff --git a/specification/storage/resource-manager/readme.ruby.md b/specification/storage/resource-manager/readme.ruby.md index 4b90796625f8..35da60027442 100644 --- a/specification/storage/resource-manager/readme.ruby.md +++ b/specification/storage/resource-manager/readme.ruby.md @@ -12,6 +12,7 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: + - tag: package-2020-08-preview - tag: package-2018-02 - tag: package-2017-10 - tag: package-2017-06 @@ -21,6 +22,16 @@ batch: - tag: package-2015-05-preview ``` +### Tag: package-2020-08-preview and ruby + +These settings apply only when `--tag=package-2020-08-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-08-preview' && $(ruby) +namespace: "Azure::Storage::Mgmt::V2020_08_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_storage/lib +``` + ### Tag: package-2018-02 and ruby These settings apply only when `--tag=package-2018-02 --ruby` is specified on the command line. From 9092e1438ca9b31482c5416be31c83a8933787a5 Mon Sep 17 00:00:00 2001 From: Sebastian Herzig-Patel Date: Mon, 14 Sep 2020 03:03:32 -0700 Subject: [PATCH 052/164] [Hub Generated] Review request for Microsoft.DigitalTwins to add version stable/2020-10-31 (#10653) * Adds base for updating Microsoft.DigitalTwins from version preview/2020-03-01-preview to version 2020-10-31 * Updates readme * Updates API version in new specs and examples * Aligned descriptions with GA controller models, and regex patterns in parameters * Update nullable attribute to x-nullable * Latest updates * Add x-ms-secret = true for endpoint PUT * Latest changes * Fix reference issue * Simplify operationResults * Update required property name * Update examples * Update provisioning states * Add 200OK response to delete endpoints * Adds suppression to readme * Adds suppression to readme * Fix operation list example * Add additional provisioning state for endpoints * Remove tags from endpoint * Address internal reviewer comments * Update x-ms-secret properties to be nullable * Adds suppression to readme * Update examples with more realistic obfuscated connection strings * Adds suppression to readme * Adds suppression to readme * Adds suppression to readme * Run npm prettier on changes * Updated readmes --- .../stable/2020-10-31/digitaltwins.json | 1162 +++++++++++++++++ ...talTwinsCheckNameAvailability_example.json | 20 + .../examples/DigitalTwinsDelete_example.json | 39 + .../DigitalTwinsEndpointDelete_example.json | 40 + .../DigitalTwinsEndpointGet_example.json | 25 + .../DigitalTwinsEndpointPut_example.json | 46 + .../DigitalTwinsEndpointsGet_example.json | 40 + .../examples/DigitalTwinsGet_example.json | 24 + ...gitalTwinsListByResourceGroup_example.json | 40 + .../examples/DigitalTwinsList_example.json | 39 + .../DigitalTwinsOperationsList_example.json | 54 + .../examples/DigitalTwinsPatch_example.json | 32 + .../examples/DigitalTwinsPut_example.json | 44 + .../resource-manager/readme.go.md | 12 + .../resource-manager/readme.java.md | 14 + .../digitaltwins/resource-manager/readme.md | 40 +- .../resource-manager/readme.python.md | 33 +- .../resource-manager/readme.ruby.md | 12 +- 18 files changed, 1712 insertions(+), 4 deletions(-) create mode 100644 specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json create mode 100644 specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsCheckNameAvailability_example.json create mode 100644 specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsDelete_example.json create mode 100644 specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsEndpointDelete_example.json create mode 100644 specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsEndpointGet_example.json create mode 100644 specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsEndpointPut_example.json create mode 100644 specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsEndpointsGet_example.json create mode 100644 specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsGet_example.json create mode 100644 specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsListByResourceGroup_example.json create mode 100644 specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsList_example.json create mode 100644 specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsOperationsList_example.json create mode 100644 specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsPatch_example.json create mode 100644 specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/examples/DigitalTwinsPut_example.json diff --git a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json new file mode 100644 index 000000000000..a649d243d702 --- /dev/null +++ b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json @@ -0,0 +1,1162 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-10-31", + "title": "AzureDigitalTwinsManagementClient", + "description": "Azure Digital Twins Client for managing DigitalTwinsInstance" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}": { + "get": { + "tags": [ + "DigitalTwinsInstance" + ], + "description": "Get DigitalTwinsInstances resource.", + "operationId": "DigitalTwins_Get", + "x-ms-examples": { + "Get a DigitalTwinsInstance resource": { + "$ref": "./examples/DigitalTwinsGet_example.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains all the non-security properties of the DigitalTwinsInstance. Security-related properties are set to null.", + "schema": { + "$ref": "#/definitions/DigitalTwinsDescription" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "DigitalTwinsInstance" + ], + "description": "Create or update the metadata of a DigitalTwinsInstance. The usual pattern to modify a property is to retrieve the DigitalTwinsInstance and security metadata, and then combine them with the modified values in a new body to update the DigitalTwinsInstance.", + "operationId": "DigitalTwins_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Put a DigitalTwinsInstance resource": { + "$ref": "./examples/DigitalTwinsPut_example.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "digitalTwinsCreate", + "in": "body", + "description": "The DigitalTwinsInstance and security metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/DigitalTwinsDescription" + } + } + ], + "responses": { + "200": { + "description": "This is returned as a response when the resource already exists and was updated successfully.", + "schema": { + "$ref": "#/definitions/DigitalTwinsDescription" + } + }, + "201": { + "description": "Created - Put request accepted; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DigitalTwinsDescription" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "DigitalTwinsInstance" + ], + "description": "Update metadata of DigitalTwinsInstance.", + "operationId": "DigitalTwins_Update", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Patch a DigitalTwinsInstance resource": { + "$ref": "./examples/DigitalTwinsPatch_example.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "digitalTwinsPatchDescription", + "in": "body", + "description": "The DigitalTwinsInstance and security metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/DigitalTwinsPatchDescription" + } + } + ], + "responses": { + "200": { + "description": "This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.", + "schema": { + "$ref": "#/definitions/DigitalTwinsDescription" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "DigitalTwinsInstance" + ], + "description": "Delete a DigitalTwinsInstance.", + "operationId": "DigitalTwins_Delete", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a DigitalTwinsInstance resource": { + "$ref": "./examples/DigitalTwinsDelete_example.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "Returned if the operation was canceled or failed.", + "schema": { + "$ref": "#/definitions/DigitalTwinsDescription" + } + }, + "202": { + "description": "Accepted - Delete request accepted; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DigitalTwinsDescription" + } + }, + "204": { + "description": "Returned when the long running delete operation has finished, or the Digital Twins instance does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints": { + "get": { + "tags": [ + "Endpoints" + ], + "description": "Get DigitalTwinsInstance Endpoints.", + "operationId": "DigitalTwinsEndpoint_List", + "x-ms-examples": { + "Get a DigitalTwinsInstance endpoints": { + "$ref": "./examples/DigitalTwinsEndpointsGet_example.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains all the non-security properties of the DigitalTwinsInstance. Security-related properties are set to null.", + "schema": { + "$ref": "#/definitions/DigitalTwinsEndpointResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances/{resourceName}/endpoints/{endpointName}": { + "get": { + "tags": [ + "Endpoints" + ], + "description": "Get DigitalTwinsInstances Endpoint.", + "operationId": "DigitalTwinsEndpoint_Get", + "x-ms-examples": { + "Get a DigitalTwinsInstance endpoint": { + "$ref": "./examples/DigitalTwinsEndpointGet_example.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/endpointName" + } + ], + "responses": { + "200": { + "description": "The body contains all the non-security properties of the DigitalTwinsInstance. Security-related properties are set to null.", + "schema": { + "$ref": "#/definitions/DigitalTwinsEndpointResource" + } + }, + "default": { + "description": "Default error response", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Endpoints" + ], + "description": "Create or update DigitalTwinsInstance endpoint.", + "operationId": "DigitalTwinsEndpoint_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Put a DigitalTwinsInstance resource": { + "$ref": "./examples/DigitalTwinsEndpointPut_example.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/endpointName" + }, + { + "name": "endpointDescription", + "in": "body", + "description": "The DigitalTwinsInstance endpoint metadata and security metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/DigitalTwinsEndpointResource" + } + } + ], + "responses": { + "200": { + "description": "This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.", + "schema": { + "$ref": "#/definitions/DigitalTwinsEndpointResource" + } + }, + "201": { + "description": "Created - Put request accepted; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DigitalTwinsEndpointResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Endpoints" + ], + "description": "Delete a DigitalTwinsInstance endpoint.", + "operationId": "DigitalTwinsEndpoint_Delete", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a DigitalTwinsInstance endpoint": { + "$ref": "./examples/DigitalTwinsEndpointDelete_example.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/endpointName" + } + ], + "responses": { + "200": { + "description": "Returned if the operation was canceled or failed.", + "schema": { + "$ref": "#/definitions/DigitalTwinsEndpointResource" + } + }, + "202": { + "description": "Accepted - Delete request accepted; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DigitalTwinsEndpointResource" + } + }, + "204": { + "description": "Returned when the long running delete operation has finished, or the egress endpoint does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/digitalTwinsInstances": { + "get": { + "tags": [ + "DigitalTwinsInstance" + ], + "description": "Get all the DigitalTwinsInstances in a subscription.", + "operationId": "DigitalTwins_List", + "x-ms-examples": { + "Get DigitalTwinsInstance resources by subscription": { + "$ref": "./examples/DigitalTwinsList_example.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the DigitalTwinsInstances in the subscription.", + "schema": { + "$ref": "#/definitions/DigitalTwinsDescriptionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DigitalTwins/digitalTwinsInstances": { + "get": { + "tags": [ + "DigitalTwinsInstance" + ], + "description": "Get all the DigitalTwinsInstances in a resource group.", + "operationId": "DigitalTwins_ListByResourceGroup", + "x-ms-examples": { + "Get DigitalTwinsInstance resources by resource group": { + "$ref": "./examples/DigitalTwinsListByResourceGroup_example.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the DigitalTwinsInstances in the resource group. If more data is available, the body will contain a link to the next page of items (nextLink).", + "schema": { + "$ref": "#/definitions/DigitalTwinsDescriptionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.DigitalTwins/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available DigitalTwins service REST API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "Get available operations": { + "$ref": "./examples/DigitalTwinsOperationsList_example.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DigitalTwins/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "description": "Check if a DigitalTwinsInstance name is available.", + "operationId": "DigitalTwins_CheckNameAvailability", + "x-ms-examples": { + "Check name Availability": { + "$ref": "./examples/DigitalTwinsCheckNameAvailability_example.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/location" + }, + { + "name": "digitalTwinsInstanceCheckName", + "in": "body", + "description": "Set the name parameter in the DigitalTwinsInstanceCheckName structure to the name of the DigitalTwinsInstance to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameRequest" + } + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the DigitalTwins service name is available. If the name is not available, the body contains the reason.", + "schema": { + "$ref": "#/definitions/CheckNameResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "DigitalTwinsProperties": { + "description": "The properties of a DigitalTwinsInstance.", + "type": "object", + "properties": { + "createdTime": { + "description": "Time when DigitalTwinsInstance was created.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "lastUpdatedTime": { + "description": "Time when DigitalTwinsInstance was updated.", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "provisioningState": { + "description": "The provisioning state.", + "enum": [ + "Provisioning", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "Deleted", + "Warning", + "Suspending", + "Restoring", + "Moving" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + }, + "hostName": { + "description": "Api endpoint to work with DigitalTwinsInstance.", + "type": "string", + "x-nullable": true, + "readOnly": true + } + } + }, + "DigitalTwinsDescription": { + "description": "The description of the DigitalTwins service.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "DigitalTwins instance properties.", + "$ref": "#/definitions/DigitalTwinsProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/DigitalTwinsResource" + } + ] + }, + "DigitalTwinsPatchDescription": { + "description": "The description of the DigitalTwins service.", + "type": "object", + "properties": { + "tags": { + "description": "Instance tags", + "type": "object", + "x-nullable": true, + "additionalProperties": { + "type": "string" + } + } + } + }, + "DigitalTwinsResource": { + "description": "The common properties of a DigitalTwinsInstance.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^(?!-)[A-Za-z0-9-]{3,63}(?`. + +``` yaml $(tag) == 'package-2020-10' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.digitaltwins.v2020_10_31 + output-folder: $(azure-libraries-for-java-folder)/sdk/digitaltwins/mgmt-v2020_10_31 +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2020-03-01-preview and java These settings apply only when `--tag=package-2020-03-01-preview --java` is specified on the command line. diff --git a/specification/digitaltwins/resource-manager/readme.md b/specification/digitaltwins/resource-manager/readme.md index 16f8921d5221..456d45dee6c9 100644 --- a/specification/digitaltwins/resource-manager/readme.md +++ b/specification/digitaltwins/resource-manager/readme.md @@ -26,7 +26,16 @@ These are the global settings for the digitaltwins. ``` yaml openapi-type: arm -tag: package-2020-03-01-preview +tag: package-2020-10 +``` + +### Tag: package-2020-10 + +These settings apply only when `--tag=package-2020-10` is specified on the command line. + +``` yaml $(tag) == 'package-2020-10' +input-file: + - Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json ``` ### Tag: package-2020-03-01-preview @@ -50,6 +59,8 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python + after_scripts: + - python ./scripts/multiapi_init_gen.py azure-mgmt-digitaltwins - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js @@ -101,12 +112,13 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json - $(this-folder)/Microsoft.DigitalTwins/preview/2020-03-01-preview/digitaltwins.json ``` If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. +uncomment the `exclude-file` section below and add the file paths. ``` yaml $(tag) == 'all-api-versions' #exclude-file: @@ -123,4 +135,28 @@ directive: reason: |- Flattening properties generates SDK (using autorest) that does not support polymorphism. In this case DigitalTwinsEndpointResourceProperties is used as a base class for EventGrid, EventHub and ServiceBus. Flattening DigitalTwinsEndpointResourceProperties removes the link between DigitalTwinsEndpointResource and resources above. + - suppress: TrackedResourceListByImmediateParent + where: $.definitions + from: digitaltwins.json + reason: 'This is a proxy resource, not a tracked resource.' + - suppress: EnumInsteadOfBoolean + where: $.definitions.CheckNameResult.properties.nameAvailable + from: digitaltwins.json + reason: The value will always be a boolean. + - suppress: SECRET_PROPERTY + where: '$.definitions.ServiceBus.allOf["1"].properties.primaryConnectionString' + from: digitaltwins.json + reason: 'Secrets are obfuscated on GETs. E.g., "Endpoint=sb://mysb.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=***". This is to allow customers to identify the namespace of the resource.' + - suppress: SECRET_PROPERTY + where: '$.definitions.ServiceBus.allOf["1"].properties.secondaryConnectionString' + from: digitaltwins.json + reason: Secrets are obfuscated on read. + - suppress: SECRET_PROPERTY + where: '$.definitions.EventHub.allOf["1"].properties.connectionStringPrimaryKey' + from: digitaltwins.json + reason: Secrets are obfuscated on read. + - suppress: SECRET_PROPERTY + where: '$.definitions.EventHub.allOf["1"].properties.connectionStringSecondaryKey' + from: digitaltwins.json + reason: Secrets are obfuscated on read. ``` diff --git a/specification/digitaltwins/resource-manager/readme.python.md b/specification/digitaltwins/resource-manager/readme.python.md index 24e1b64ff0e7..b6ac8b85de37 100644 --- a/specification/digitaltwins/resource-manager/readme.python.md +++ b/specification/digitaltwins/resource-manager/readme.python.md @@ -10,7 +10,6 @@ python: payload-flattening-threshold: 2 namespace: azure.mgmt.digitaltwins package-name: azure-mgmt-digitaltwins - package-version: 2020-03-01-preview clear-output-folder: true ``` @@ -19,3 +18,35 @@ python: no-namespace-folders: true output-folder: $(python-sdks-folder)/digitaltwins/azure-mgmt-digitaltwins/azure/mgmt/digitaltwins ``` + +### Python multi-api + +Generate all API versions currently shipped for this package + +```yaml $(python) && $(multiapi) +batch: + - tag: package-2020-10 + - tag: package-2020-03-01-preview +``` + +### Tag: package-2020-10 and python + +These settings apply only when `--tag=package-2020-10 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-10' && $(python) +python: + namespace: azure.mgmt.digitaltwins.v2020_10_31 + output-folder: $(python-sdks-folder)/digitaltwins/azure-mgmt-digitaltwins/azure/mgmt/digitaltwins/v2020_10_31_preview +``` + +### Tag: package-2020-03-01-preview and python + +These settings apply only when `--tag=package-2020-03-01-preview --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-03-01-preview' && $(python) +python: + namespace: azure.mgmt.digitaltwins.v2020_03_01_preview + output-folder: $(python-sdks-folder)/digitaltwins/azure-mgmt-digitaltwins/azure/mgmt/digitaltwins/v2020_03_01_preview +``` diff --git a/specification/digitaltwins/resource-manager/readme.ruby.md b/specification/digitaltwins/resource-manager/readme.ruby.md index 31f23b70c07d..ea228f0d9175 100644 --- a/specification/digitaltwins/resource-manager/readme.ruby.md +++ b/specification/digitaltwins/resource-manager/readme.ruby.md @@ -4,10 +4,20 @@ These settings apply only when `--ruby` is specified on the command line. ```yaml package-name: azure_mgmt_digitaltwins -package-version: 2020-03-01-preview +package-version: 2020-10-31 azure-arm: true ``` +### Tag: package-2020-10 and ruby + +These settings apply only when `--tag=package-2020-10 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2020-10' && $(ruby) +namespace: Microsoft.DigitalTwins +output-folder: $(ruby-sdks-folder)/digitaltwins +``` + ### Tag: package-2020-03-01-preview and ruby These settings apply only when `--tag=package-2020-03-01-preview --ruby` is specified on the command line. From a4100a3b0e43c3782fda54237653de45572f29d4 Mon Sep 17 00:00:00 2001 From: Mollee Jain Date: Mon, 14 Sep 2020 17:03:32 -0700 Subject: [PATCH 053/164] Updating readme for MySQL and PostgreSQL to include new flexible server namespace (#10710) * Updating readme files to include multi api capability and new namespace * Removing minor addition to cli.md * Revert Csharp changes since multiapi isn't used * Updating PythonSDK namespaces * Removing unnecessary batchapiscript from Python.md * Removing unnecessary package tags Co-authored-by: George Christoglou --- .../mysql/resource-manager/readme.az.md | 14 ++++ .../mysql/resource-manager/readme.go.md | 16 ++++- .../mysql/resource-manager/readme.md | 26 +------ .../mysql/resource-manager/readme.python.md | 67 +++++++++++++++++++ .../postgresql/resource-manager/readme.az.md | 14 ++++ .../postgresql/resource-manager/readme.go.md | 16 ++++- .../postgresql/resource-manager/readme.md | 26 +------ .../resource-manager/readme.python.md | 67 +++++++++++++++++++ 8 files changed, 194 insertions(+), 52 deletions(-) create mode 100644 specification/mysql/resource-manager/readme.az.md create mode 100644 specification/mysql/resource-manager/readme.python.md create mode 100644 specification/postgresql/resource-manager/readme.az.md create mode 100644 specification/postgresql/resource-manager/readme.python.md diff --git a/specification/mysql/resource-manager/readme.az.md b/specification/mysql/resource-manager/readme.az.md new file mode 100644 index 000000000000..e4e631ded08e --- /dev/null +++ b/specification/mysql/resource-manager/readme.az.md @@ -0,0 +1,14 @@ +## AZ + +These settings apply only when `--az` is specified on the command line. + +``` yaml $(az) +az: + extensions: mysql + namespace: azure.mgmt.mysql + package-name: azure-mgmt-mysql +az-output-folder: $(azure-cli-extension-folder)/src/mysql +python-sdk-output-folder: "$(az-output-folder)/azext_mysql/vendored_sdks/mysql" +# add additinal configuration here specific for Azure CLI +# refer to the faq.md for more details +``` \ No newline at end of file diff --git a/specification/mysql/resource-manager/readme.go.md b/specification/mysql/resource-manager/readme.go.md index 1ce4bf29f208..ceb49ca28d81 100644 --- a/specification/mysql/resource-manager/readme.go.md +++ b/specification/mysql/resource-manager/readme.go.md @@ -5,7 +5,6 @@ These settings apply only when `--go` is specified on the command line. ``` yaml $(go) go: license-header: MICROSOFT_APACHE_NO_VERSION - namespace: mysql clear-output-folder: true ``` @@ -13,17 +12,30 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2020-07-01-privatepreview - tag: package-2020-01-01 - tag: package-2017-12-01-preview - tag: package-2017-12-01 ``` +### Tag: package-2020-07-01-privatepreview and go + +These settings apply only when `--tag=package-2020-07-01-privatepreview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-07-01-privatepreview' && $(go) +rpname: mysql +namespace: mysqlflexibleservers +output-folder: $(go-sdk-folder)/services/preview/$(rpname)/mgmt/2020-07-01-preview/$(namespace) +``` + ### Tag: package-2020-01-01 and go These settings apply only when `--tag=package-2020-01-01 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2020-01-01' && $(go) +namespace: mysql output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-01-01/$(namespace) ``` @@ -33,6 +45,7 @@ These settings apply only when `--tag=package-2017-12-01-preview --go` is specif Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-12-01-preview' && $(go) +namespace: mysql output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2017-12-01-preview/$(namespace) ``` @@ -42,5 +55,6 @@ These settings apply only when `--tag=package-2017-12-01 --go` is specified on t Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-12-01' && $(go) +namespace: mysql output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2017-12-01/$(namespace) ``` \ No newline at end of file diff --git a/specification/mysql/resource-manager/readme.md b/specification/mysql/resource-manager/readme.md index 72098bc5cf51..f7a9793c57bf 100644 --- a/specification/mysql/resource-manager/readme.md +++ b/specification/mysql/resource-manager/readme.md @@ -165,33 +165,9 @@ csharp: clear-output-folder: true ``` - ## Python -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.rdbms.mysql - package-name: azure-mgmt-rdbms - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/mysql -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms -``` +See configuration in [readme.python.md](./readme.python.md) ## Go diff --git a/specification/mysql/resource-manager/readme.python.md b/specification/mysql/resource-manager/readme.python.md new file mode 100644 index 000000000000..77a340fa1fa1 --- /dev/null +++ b/specification/mysql/resource-manager/readme.python.md @@ -0,0 +1,67 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml !$(track2) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + package-name: azure-mgmt-rdbms + clear-output-folder: true + no-namespace-folders: true +``` + +These settings apply only when `--track2` is specified on the command line. + +``` yaml $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-rdbms +no-namespace-folders: true +``` + +### Python multi-api + +Generate all API versions currently shipped for this package + +```yaml !$(track2) +batch: + - tag: package-2020-01-01 + - tag: package-2020-07-01-privatepreview +``` + +```yaml $(track2) +clear-output-folder: true +batch: + - tag: package-2020-01-01 + - tag: package-2020-07-01-privatepreview +``` + +### Tag: package-2020-01-01 and python + +These settings apply only when `--tag=package-2020-01-01 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-01-01' && $(python) +namespace: azure.mgmt.rdbms.mysql +output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/mysql +python: + namespace: azure.mgmt.rdbms.mysql + output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/mysql +``` + +### Tag: package-2020-07-01-privatepreview and python + +These settings apply only when `--tag=package-2020-07-01-privatepreview --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-07-01-privatepreview' && $(python) +namespace: azure.mgmt.rdbms.mysql_flexibleservers +output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/mysql_flexibleservers +python: + namespace: azure.mgmt.rdbms.mysql_flexibleservers + output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/mysql_flexibleservers +``` \ No newline at end of file diff --git a/specification/postgresql/resource-manager/readme.az.md b/specification/postgresql/resource-manager/readme.az.md new file mode 100644 index 000000000000..cec43db01174 --- /dev/null +++ b/specification/postgresql/resource-manager/readme.az.md @@ -0,0 +1,14 @@ +## AZ + +These settings apply only when `--az` is specified on the command line. + +``` yaml $(az) +az: + extensions: postgresql + namespace: azure.mgmt.postgresql + package-name: azure-mgmt-postgresql +az-output-folder: $(azure-cli-extension-folder)/src/postgresql +python-sdk-output-folder: "$(az-output-folder)/azext_postgresql/vendored_sdks/postgresql" +# add additinal configuration here specific for Azure CLI +# refer to the faq.md for more details +``` \ No newline at end of file diff --git a/specification/postgresql/resource-manager/readme.go.md b/specification/postgresql/resource-manager/readme.go.md index 7fc16ffa1a54..76ec7d9c39f1 100644 --- a/specification/postgresql/resource-manager/readme.go.md +++ b/specification/postgresql/resource-manager/readme.go.md @@ -5,7 +5,6 @@ These settings apply only when `--go` is specified on the command line. ``` yaml $(go) go: license-header: MICROSOFT_APACHE_NO_VERSION - namespace: postgresql clear-output-folder: true ``` @@ -13,17 +12,30 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2020-02-14-privatepreview - tag: package-2020-01-01 - tag: package-2017-12-01-preview - tag: package-2017-12-01 ``` +### Tag: package-2020-02-14 and go + +These settings apply only when `--tag=package-2020-02-14-privatepreview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-02-14-privatepreview' && $(go) +rpname: postgresql +namespace: postgresqlflexibleservers +output-folder: $(go-sdk-folder)/services/preview/$(rpname)/mgmt/2020-02-14-preview/$(namespace) +``` + ### Tag: package-2020-01-01 and go These settings apply only when `--tag=package-2020-01-01 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2020-01-01' && $(go) +namespace: postgresql output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-01-01/$(namespace) ``` @@ -33,6 +45,7 @@ These settings apply only when `--tag=package-2017-12-01-preview --go` is specif Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-12-01-preview' && $(go) +namespace: postgresql output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2017-12-01-preview/$(namespace) ``` @@ -42,5 +55,6 @@ These settings apply only when `--tag=package-2017-12-01 --go` is specified on t Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-12-01' && $(go) +namespace: postgresql output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2017-12-01/$(namespace) ``` \ No newline at end of file diff --git a/specification/postgresql/resource-manager/readme.md b/specification/postgresql/resource-manager/readme.md index af66caa06f89..8f4c2a2300e7 100644 --- a/specification/postgresql/resource-manager/readme.md +++ b/specification/postgresql/resource-manager/readme.md @@ -158,33 +158,9 @@ csharp: clear-output-folder: true ``` - ## Python -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.rdbms.postgresql - package-name: azure-mgmt-rdbms - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/postgresql -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms -``` +See configuration in [readme.python.md](./readme.python.md) ## Go diff --git a/specification/postgresql/resource-manager/readme.python.md b/specification/postgresql/resource-manager/readme.python.md new file mode 100644 index 000000000000..29ba59d0973c --- /dev/null +++ b/specification/postgresql/resource-manager/readme.python.md @@ -0,0 +1,67 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml !$(track2) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + package-name: azure-mgmt-rdbms + clear-output-folder: true + no-namespace-folders: true +``` + +These settings apply only when `--track2` is specified on the command line. + +``` yaml $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-rdbms +no-namespace-folders: true +``` + +### Python multi-api + +Generate all API versions currently shipped for this package + +```yaml !$(track2) +batch: + - tag: package-2020-01-01 + - tag: package-2020-02-14-privatepreview +``` + +```yaml $(track2) +clear-output-folder: true +batch: + - tag: package-2020-01-01 + - tag: package-2020-02-14-privatepreview +``` + +### Tag: package-2020-01-01 and python + +These settings apply only when `--tag=package-2020-01-01 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-01-01' && $(python) +namespace: azure.mgmt.rdbms.postgresql +output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/postgresql +python: + namespace: azure.mgmt.rdbms.postgresql + output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/postgresql +``` + +### Tag: package-2020-02-14-privatepreview and python + +These settings apply only when `--tag=package-2020-02-14-privatepreview --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-02-14-privatepreview' && $(python) +namespace: azure.mgmt.rdbms.postgresql_flexibleservers +output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/postgresql_flexibleservers +python: + namespace: azure.mgmt.rdbms.postgresql_flexibleservers + output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/postgresql_flexibleservers +``` \ No newline at end of file From 6b69d6ec4d3f62a618173a55799d1feaaf8799a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Au=C3=B0unn?= Date: Tue, 15 Sep 2020 02:03:11 +0000 Subject: [PATCH 054/164] [NetAppFiles]Anf 6195 swagger restapi to2020 06 01 bugfix (#10753) * Fix snapshot snapshotPolicyProperties * Fix linter issue, prettier * one more pretty * param in example * remove param in example * Remove whitespace * Remove valiation on readonly properties Co-authored-by: Audunn Baldvinsson --- .../2020-06-01/examples/Accounts_Get.json | 1 - .../examples/SnapshotPolicies_Create.json | 101 ++++++++---------- .../examples/SnapshotPolicies_Get.json | 34 +++--- .../examples/SnapshotPolicies_List.json | 34 +++--- .../examples/SnapshotPolicies_Update.json | 68 ++++++------ .../stable/2020-06-01/netapp.json | 32 +++--- 6 files changed, 125 insertions(+), 145 deletions(-) diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/examples/Accounts_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/examples/Accounts_Get.json index f6d3dab994ac..e234d1126a61 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/examples/Accounts_Get.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/examples/Accounts_Get.json @@ -19,7 +19,6 @@ "site": "SiteName", "activeDirectoryId": "02da3711-6c58-2d64-098a-e3af7afaf936", "username": "ad_user_name", - "password": "****************", "domain": "10.10.10.3", "dns": "10.10.10.3, 10.10.10.4", "status": "InUse", diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/examples/SnapshotPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/examples/SnapshotPolicies_Create.json index 1cda5bf08ca4..ebaa1c23a15b 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/examples/SnapshotPolicies_Create.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/examples/SnapshotPolicies_Create.json @@ -9,31 +9,26 @@ "location": "eastus", "properties": { "hourlySchedule": { - "snapshotsToKeep": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 2, + "minute": 50 }, "dailySchedule": { - "snapshotsToKeep": 10, - "hour": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 }, "weeklySchedule": { - "snapshotsToKeep": 10, - "day": "Monday", - "hour": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 }, "monthlySchedule": { - "snapshotsToKeep": 10, - "DaysOfMonth": "1,5,11", - "hour": 10, - "minute": 10, - "usedBytes": 100000 - }, - "enabled": true + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + } } } }, @@ -45,32 +40,30 @@ "name": "account1/snapshotPolicy1", "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", "properties": { + "name": "sdk-net-tests-snapshotPolicy-1", + "enabled": true, "hourlySchedule": { - "snapshotsToKeep": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 2, + "minute": 50 }, "dailySchedule": { - "snapshotsToKeep": 10, - "hour": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 }, "weeklySchedule": { - "snapshotsToKeep": 10, - "day": "Monday", - "hour": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 }, "monthlySchedule": { - "snapshotsToKeep": 10, - "DaysOfMonth": "1,5,11", - "hour": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 }, - "enabled": true + "provisioningState": "Succeeded" } } }, @@ -81,32 +74,30 @@ "name": "account1/snapshotPolicy1", "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", "properties": { + "name": "sdk-net-tests-snapshotPolicy-1", + "enabled": true, "hourlySchedule": { - "snapshotsToKeep": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 2, + "minute": 50 }, "dailySchedule": { - "snapshotsToKeep": 10, - "hour": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 }, "weeklySchedule": { - "snapshotsToKeep": 10, - "day": "Monday", - "hour": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 }, "monthlySchedule": { - "snapshotsToKeep": 10, - "DaysOfMonth": "1,5,11", - "hour": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 }, - "enabled": true + "provisioningState": "Succeeded" } } } diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/examples/SnapshotPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/examples/SnapshotPolicies_Get.json index 97d850a34092..904de0ced731 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/examples/SnapshotPolicies_Get.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/examples/SnapshotPolicies_Get.json @@ -14,32 +14,30 @@ "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", "location": "eastus", "properties": { + "name": "sdk-net-tests-snapshotPolicy-1", + "enabled": true, "hourlySchedule": { - "snapshotsToKeep": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 2, + "minute": 50 }, "dailySchedule": { - "snapshotsToKeep": 10, - "hour": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 }, "weeklySchedule": { - "snapshotsToKeep": 10, - "day": "Monday", - "hour": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 }, "monthlySchedule": { - "snapshotsToKeep": 10, - "DaysOfMonth": "1,5,11", - "hour": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 }, - "enabled": true + "provisioningState": "Succeeded" } } } diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/examples/SnapshotPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/examples/SnapshotPolicies_List.json index a5baa96f65c8..d536acf47c95 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/examples/SnapshotPolicies_List.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/examples/SnapshotPolicies_List.json @@ -15,32 +15,30 @@ "location": "eastus", "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", "properties": { + "name": "sdk-net-tests-snapshotPolicy-1", + "enabled": true, "hourlySchedule": { - "snapshotsToKeep": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 2, + "minute": 50 }, "dailySchedule": { - "snapshotsToKeep": 10, - "hour": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 }, "weeklySchedule": { - "snapshotsToKeep": 10, - "day": "Monday", - "hour": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 }, "monthlySchedule": { - "snapshotsToKeep": 10, - "DaysOfMonth": "1,5,11", - "hour": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 }, - "enabled": true + "provisioningState": "Succeeded" } } ] diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/examples/SnapshotPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/examples/SnapshotPolicies_Update.json index ad355b510d2e..7df4bc2adcb9 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/examples/SnapshotPolicies_Update.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/examples/SnapshotPolicies_Update.json @@ -8,32 +8,28 @@ "body": { "location": "eastus", "properties": { + "enabled": true, "hourlySchedule": { - "snapshotsToKeep": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 2, + "minute": 50 }, "dailySchedule": { - "snapshotsToKeep": 10, - "hour": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 }, "weeklySchedule": { - "snapshotsToKeep": 10, - "day": "Monday", - "hour": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 }, "monthlySchedule": { - "snapshotsToKeep": 10, - "DaysOfMonth": "1,5,11", - "hour": 10, - "minute": 10, - "usedBytes": 100000 - }, - "enabled": true + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + } } } }, @@ -45,32 +41,30 @@ "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", "location": "eastus", "properties": { + "name": "sdk-net-tests-snapshotPolicy-1", + "enabled": true, "hourlySchedule": { - "snapshotsToKeep": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 2, + "minute": 50 }, "dailySchedule": { - "snapshotsToKeep": 10, - "hour": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 }, "weeklySchedule": { - "snapshotsToKeep": 10, - "day": "Monday", - "hour": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 }, "monthlySchedule": { - "snapshotsToKeep": 10, - "DaysOfMonth": "1,5,11", - "hour": 10, - "minute": 10, - "usedBytes": 100000 + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 }, - "enabled": true + "provisioningState": "Succeeded" } } } diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/netapp.json index c6fce9bbcc39..70b86d93eac1 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/netapp.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/netapp.json @@ -3100,15 +3100,13 @@ "type": "number", "description": "Total throughput of pool in Mibps", "example": 164.221, - "readOnly": true, - "multipleOf": 0.001 + "readOnly": true }, "utilizedThroughputMibps": { "type": "number", "description": "Utilized throughput of pool in Mibps", "example": 164.221, - "readOnly": true, - "multipleOf": 0.001 + "readOnly": true }, "qosType": { "title": "qosType", @@ -3961,41 +3959,43 @@ "description": "Snapshot policy properties", "type": "object", "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Snapshot policy name" + }, "hourlySchedule": { "title": "hourlySchedule", "description": "Schedule for hourly snapshots", "type": "object", - "items": { - "$ref": "#/definitions/hourlySchedule" - } + "$ref": "#/definitions/hourlySchedule" }, "dailySchedule": { "title": "dailySchedule", "description": "Schedule for daily snapshots", "type": "object", - "items": { - "$ref": "#/definitions/dailySchedule" - } + "$ref": "#/definitions/dailySchedule" }, "weeklySchedule": { "title": "weeklySchedule", "description": "Schedule for weekly snapshots", "type": "object", - "items": { - "$ref": "#/definitions/weeklySchedule" - } + "$ref": "#/definitions/weeklySchedule" }, "monthlySchedule": { "title": "monthlySchedule", "description": "Schedule for monthly snapshots", "type": "object", - "items": { - "$ref": "#/definitions/monthlySchedule" - } + "$ref": "#/definitions/monthlySchedule" }, "enabled": { "type": "boolean", "description": "The property to decide policy is enabled or not" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" } } }, From e354da005a6502cb3029853bd7360c69aeda80b6 Mon Sep 17 00:00:00 2001 From: O Yves Chan Date: Mon, 14 Sep 2020 19:17:37 -0700 Subject: [PATCH 055/164] Update workbooks api to include sourceId (#10781) * fix schema * fix schema 2 * remove optional from description * remove required sourceId Co-authored-by: O Yves Chan --- .../2018-06-17-preview/examples/WorkbookAdd.json | 6 +++--- .../2018-06-17-preview/examples/WorkbookGet.json | 2 +- .../2018-06-17-preview/examples/WorkbooksList.json | 4 ++-- .../preview/2018-06-17-preview/workbooks_API.json | 10 +++++++--- 4 files changed, 13 insertions(+), 9 deletions(-) diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/examples/WorkbookAdd.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/examples/WorkbookAdd.json index d54c5d28f134..c82aee93ec99 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/examples/WorkbookAdd.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/examples/WorkbookAdd.json @@ -12,7 +12,7 @@ "kind": "shared", "properties": { "displayName": "Blah Blah Blah", - "userId": "userId", + "sourceId": "Azure Monitor", "serializedData": "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook. This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}", "category": "workbook", "version": "ME", @@ -31,7 +31,7 @@ "name": "deadb33f-8bee-4d3b-a059-9be8dac93960", "properties": { "displayName": "Blah Blah Blah", - "userId": "userId", + "sourceId": "Azure Monitor", "serializedData": "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook. This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}", "category": "workbook", "version": "ME", @@ -49,7 +49,7 @@ "name": "deadb33f-8bee-4d3b-a059-9be8dac93960", "properties": { "displayName": "Blah Blah Blah", - "userId": "userId", + "sourceId": "Azure Monitor", "serializedData": "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook. This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}", "category": "workbook", "version": "ME", diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/examples/WorkbookGet.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/examples/WorkbookGet.json index e6bd72b08cb7..1a66ad2bece5 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/examples/WorkbookGet.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/examples/WorkbookGet.json @@ -15,7 +15,7 @@ "location": "westus", "properties": { "displayName": "My New Workbook", - "userId": "userId", + "sourceId": "Azure Monitor", "serializedData": "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook. This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}", "category": "workbook", "version": "ME", diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/examples/WorkbooksList.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/examples/WorkbooksList.json index 37e97dbfe3a8..dd601dac096e 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/examples/WorkbooksList.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/examples/WorkbooksList.json @@ -18,7 +18,7 @@ "tags": [], "properties": { "displayName": "My Workbook 1", - "userId": "userId", + "sourceId": "Azure Monitor", "serializedData": "{\"verion\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook. This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}", "category": "workbook", "version": "ME", @@ -37,7 +37,7 @@ ], "properties": { "displayName": "My Workbook 2", - "userId": "userId", + "sourceId ": "Azure Monitor", "serializedData": "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook. This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}", "category": "workbook", "version": "ME", diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json index 85fd1577f11b..cdf1e0cec2c2 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json @@ -350,8 +350,7 @@ "required": [ "displayName", "category", - "serializedData", - "userId" + "serializedData" ], "properties": { "displayName": { @@ -384,7 +383,12 @@ }, "userId": { "type": "string", - "description": "Unique user id of the specific user that owns this workbook." + "description": "Unique user id of the specific user that owns this workbook.", + "readOnly": true + }, + "sourceId": { + "type": "string", + "description": "ResourceId for a source resource." } } }, From dcf5f21881cf2a6ca1f426d53612aec52f746212 Mon Sep 17 00:00:00 2001 From: Tyler James Leonhardt Date: Mon, 14 Sep 2020 20:33:29 -0700 Subject: [PATCH 056/164] add alias for auto_rev_minor_version to fix az CLI linter error (#10789) --- specification/hybridcompute/resource-manager/readme.cli.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/specification/hybridcompute/resource-manager/readme.cli.md b/specification/hybridcompute/resource-manager/readme.cli.md index 47bc1407e07e..061e2aadbb38 100644 --- a/specification/hybridcompute/resource-manager/readme.cli.md +++ b/specification/hybridcompute/resource-manager/readme.cli.md @@ -17,4 +17,8 @@ cli: operationGroup: 'machines' operation: '(reconnect|createOrUpdate|update)' removed: true + - where: + param: 'autoUpgradeMinorVersion' + alias: + - auto_upgrade_minor ``` From 4e73d15428957f48130cb1700343967d44e69938 Mon Sep 17 00:00:00 2001 From: dmitarredz <32386798+dmitarredz@users.noreply.github.com> Date: Tue, 15 Sep 2020 06:51:37 +0200 Subject: [PATCH 057/164] Add new resource to Microsoft.Sql "ServerTrustGroup". (#10705) * Add new resource to Microsoft.Sql "ServerTrustGroup". * Update sql/readme.md * Add 204 response to ServerTrustGroup DELETE operation. * Fix "prettier check" errors * Fix naming for list by instance name operation. --- .../2020-02-02-preview/ServerTrustGroups.json | 506 ++++++++++++++++++ .../examples/ServerTrustGroupCreate.json | 67 +++ .../examples/ServerTrustGroupDelete.json | 14 + .../examples/ServerTrustGroupGet.json | 31 ++ .../examples/ServerTrustGroupList.json | 52 ++ ...ServerTrustGroupListByManagedInstance.json | 52 ++ specification/sql/resource-manager/readme.md | 4 + 7 files changed, 726 insertions(+) create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/ServerTrustGroups.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerTrustGroupCreate.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerTrustGroupDelete.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerTrustGroupGet.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerTrustGroupList.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerTrustGroupListByManagedInstance.json diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/ServerTrustGroups.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/ServerTrustGroups.json new file mode 100644 index 000000000000..74af95ea31a8 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/ServerTrustGroups.json @@ -0,0 +1,506 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-02-02-preview", + "title": "SqlManagementClient", + "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/serverTrustGroups/{serverTrustGroupName}": { + "get": { + "tags": [ + "ServerTrustGroups" + ], + "description": "Gets a server trust group.", + "operationId": "ServerTrustGroups_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "locationName", + "in": "path", + "description": "The name of the region where the resource is located.", + "required": true, + "type": "string" + }, + { + "name": "serverTrustGroupName", + "in": "path", + "description": "The name of the server trust group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the the specified server trust group.", + "schema": { + "$ref": "#/definitions/ServerTrustGroup" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-examples": { + "Get server trust group": { + "$ref": "./examples/ServerTrustGroupGet.json" + } + } + }, + "put": { + "tags": [ + "ServerTrustGroups" + ], + "description": "Creates or updates a server trust group.", + "operationId": "ServerTrustGroups_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "locationName", + "in": "path", + "description": "The name of the region where the resource is located.", + "required": true, + "type": "string" + }, + { + "name": "serverTrustGroupName", + "in": "path", + "description": "The name of the server trust group.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The server trust group parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerTrustGroup" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the server trust group.", + "schema": { + "$ref": "#/definitions/ServerTrustGroup" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 ServerTrustGroupCreateRequestInvalid - The resource or resource properties in the request body is empty or invalid\n\n * 400 ServerTrustGroupCreateRequestInvalidGroupMembers - The group members property in the request body is empty or invalid\n\n * 400 ServerTrustGroupCreateRequestInvalidGroupMembersCount - The group members property has an invalid number of servers\n\n * 400 ServerTrustGroupCreateRequestInvalidServer - The given serverId field in create server trust group request body is empty or invalid\n\n * 400 ServerTrustGroupCreateRequestDuplicateServer - One or more of the provided servers are duplicates.\n\n * 400 ServerTrustGroupCreateRequestInvalidTrustScopes - The trust scope property in the request body is empty or invalid.\n\n * 400 ServerTrustGroupCreateRequestInvalidTrustScopesValue - The trust scope property in the request body has an invalid value.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation." + }, + "202": { + "description": "Accepted" + }, + "201": { + "description": "Successfully created the server trust group.", + "schema": { + "$ref": "#/definitions/ServerTrustGroup" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create server trust group": { + "$ref": "./examples/ServerTrustGroupCreate.json" + } + } + }, + "delete": { + "tags": [ + "ServerTrustGroups" + ], + "description": "Deletes a server trust group.", + "operationId": "ServerTrustGroups_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "locationName", + "in": "path", + "description": "The name of the region where the resource is located.", + "required": true, + "type": "string" + }, + { + "name": "serverTrustGroupName", + "in": "path", + "description": "The name of the server trust group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the server trust group." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 ServerTrustGroupCreateRequestInvalid - The resource or resource properties in the request body is empty or invalid\n\n * 400 ServerTrustGroupCreateRequestInvalidGroupMembers - The group members property in the request body is empty or invalid\n\n * 400 ServerTrustGroupCreateRequestInvalidGroupMembersCount - The group members property has an invalid number of servers\n\n * 400 ServerTrustGroupCreateRequestInvalidServer - The given serverId field in create server trust group request body is empty or invalid\n\n * 400 ServerTrustGroupCreateRequestDuplicateServer - One or more of the provided servers are duplicates.\n\n * 400 ServerTrustGroupCreateRequestInvalidTrustScopes - The trust scope property in the request body is empty or invalid.\n\n * 400 ServerTrustGroupCreateRequestInvalidTrustScopesValue - The trust scope property in the request body has an invalid value.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation." + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "The specified server trust group does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Drop server trust group": { + "$ref": "./examples/ServerTrustGroupDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/serverTrustGroups": { + "get": { + "tags": [ + "ServerTrustGroups" + ], + "description": "Lists a server trust group.", + "operationId": "ServerTrustGroups_ListByLocation", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "locationName", + "in": "path", + "description": "The name of the region where the resource is located.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the server trust groups.", + "schema": { + "$ref": "#/definitions/ServerTrustGroupListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List server trust groups": { + "$ref": "./examples/ServerTrustGroupList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/serverTrustGroups": { + "get": { + "tags": [ + "ServerTrustGroups" + ], + "description": "Gets a server trust groups by instance name.", + "operationId": "ServerTrustGroups_ListByInstance", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the server trust groups.", + "schema": { + "$ref": "#/definitions/ServerTrustGroupListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List server trust groups by managed instance": { + "$ref": "./examples/ServerTrustGroupListByManagedInstance.json" + } + } + } + } + }, + "definitions": { + "ServerTrustGroupProperties": { + "description": "Properties of a server trust group.", + "required": [ + "groupMembers", + "trustScopes" + ], + "type": "object", + "properties": { + "groupMembers": { + "description": "Group members information for the server trust group.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerInfo" + } + }, + "trustScopes": { + "description": "Trust scope of the server trust group.", + "type": "array", + "items": { + "enum": [ + "GlobalTransactions" + ], + "type": "string" + } + } + } + }, + "ServerInfo": { + "description": "Server info for the server trust group.", + "required": [ + "serverId" + ], + "type": "object", + "properties": { + "serverId": { + "description": "Server Id.", + "type": "string" + } + } + }, + "Resource": { + "description": "ARM resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "ProxyResource": { + "description": "ARM proxy resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "ServerTrustGroup": { + "description": "A server trust group.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ServerTrustGroupProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ServerTrustGroupListResult": { + "description": "A list of server trust groups.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerTrustGroup" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for the request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "description": "The name of the database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "WorkspaceNameParameter": { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlPoolNameParameter": { + "name": "sqlPoolName", + "in": "path", + "description": "The name of the sql pool.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlDatabaseNameParameter": { + "name": "sqlDatabaseName", + "in": "path", + "description": "The name of the sql database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerTrustGroupCreate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerTrustGroupCreate.json new file mode 100644 index 000000000000..6636d4ced22e --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerTrustGroupCreate.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default", + "locationName": "Japan East", + "serverTrustGroupName": "server-trust-group-test", + "api-version": "2020-02-02-preview", + "parameters": { + "properties": { + "groupMembers": [ + { + "serverId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/managedInstance-1" + }, + { + "serverId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/managedInstance-2" + } + ], + "trustScopes": [ + "GlobalTransactions" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan East/serverTrustGroups/server-trust-group-test", + "name": "server-trust-group-test", + "properties": { + "groupMembers": [ + { + "serverId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/managedInstance-1" + }, + { + "serverId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/managedInstance-2" + } + ], + "trustScopes": [ + "GlobalTransactions" + ] + }, + "type": "Microsoft.Sql/locations/serverTrustGroups" + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan East/serverTrustGroups/server-trust-group-test", + "name": "server-trust-group-test", + "properties": { + "groupMembers": [ + { + "serverId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/managedInstance-1" + }, + { + "serverId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/managedInstance-2" + } + ], + "trustScopes": [ + "GlobalTransactions" + ] + }, + "type": "Microsoft.Sql/locations/serverTrustGroups" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerTrustGroupDelete.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerTrustGroupDelete.json new file mode 100644 index 000000000000..4c1dd79b6eb5 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerTrustGroupDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default", + "locationName": "Japan East", + "serverTrustGroupName": "server-trust-group-test", + "api-version": "2020-02-02-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerTrustGroupGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerTrustGroupGet.json new file mode 100644 index 000000000000..c40170a9f7d0 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerTrustGroupGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default", + "locationName": "Japan East", + "serverTrustGroupName": "server-trust-group-test", + "api-version": "2020-02-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan East/serverTrustGroups/server-trust-group-test", + "name": "server-trust-group-test", + "properties": { + "groupMembers": [ + { + "serverId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/managedInstance-1" + }, + { + "serverId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/managedInstance-2" + } + ], + "trustScopes": [ + "GlobalTransactions" + ] + }, + "type": "Microsoft.Sql/locations/serverTrustGroups" + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerTrustGroupList.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerTrustGroupList.json new file mode 100644 index 000000000000..1196f696b1ff --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerTrustGroupList.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default", + "locationName": "Japan East", + "api-version": "2020-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan East/serverTrustGroups/server-trust-group-test", + "name": "server-trust-group-test", + "properties": { + "groupMembers": [ + { + "serverId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/managedInstance-1" + }, + { + "serverId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/managedInstance-2" + } + ], + "trustScopes": [ + "GlobalTransactions" + ] + }, + "type": "Microsoft.Sql/locations/serverTrustGroups" + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan East/serverTrustGroups/server-trust-group-test-2", + "name": "server-trust-group-test-2", + "properties": { + "groupMembers": [ + { + "serverId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/managedInstance-1" + }, + { + "serverId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/managedInstance-3" + } + ], + "trustScopes": [ + "GlobalTransactions" + ] + }, + "type": "Microsoft.Sql/locations/serverTrustGroups" + } + ] + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerTrustGroupListByManagedInstance.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerTrustGroupListByManagedInstance.json new file mode 100644 index 000000000000..29d799777643 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerTrustGroupListByManagedInstance.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "managedInstance-1", + "api-version": "2020-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan East/serverTrustGroups/server-trust-group-test", + "name": "server-trust-group-test", + "properties": { + "groupMembers": [ + { + "serverId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/managedInstance-1" + }, + { + "serverId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/managedInstance-2" + } + ], + "trustScopes": [ + "GlobalTransactions" + ] + }, + "type": "Microsoft.Sql/locations/serverTrustGroups" + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan East/serverTrustGroups/server-trust-group-test-2", + "name": "server-trust-group-test-2", + "properties": { + "groupMembers": [ + { + "serverId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/managedInstance-1" + }, + { + "serverId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/managedInstance-3" + } + ], + "trustScopes": [ + "GlobalTransactions" + ] + }, + "type": "Microsoft.Sql/locations/serverTrustGroups" + } + ] + } + } + } +} diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md index 18b8eaecc55b..697171636433 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -140,6 +140,7 @@ input-file: - Microsoft.Sql/preview/2020-02-02-preview/managedInstances.json - Microsoft.Sql/preview/2020-02-02-preview/importexport.json - Microsoft.Sql/preview/2020-02-02-preview/ManagedInstanceAzureADOnlyAuthentications.json +- Microsoft.Sql/preview/2020-02-02-preview/ServerTrustGroups.json # Needed when there is more than one input file @@ -245,6 +246,7 @@ input-file: - Microsoft.Sql/preview/2020-02-02-preview/ServerAzureADOnlyAuthentications.json - Microsoft.Sql/preview/2020-02-02-preview/managedInstances.json - Microsoft.Sql/preview/2020-02-02-preview/ManagedInstanceAzureADOnlyAuthentications.json +- Microsoft.Sql/preview/2020-02-02-preview/ServerTrustGroups.json # Needed when there is more than one input file override-info: @@ -338,6 +340,7 @@ input-file: - Microsoft.Sql/preview/2020-02-02-preview/managedInstances.json - Microsoft.Sql/preview/2020-02-02-preview/ServerAzureADOnlyAuthentications.json - Microsoft.Sql/preview/2020-02-02-preview/ManagedInstanceAzureADOnlyAuthentications.json +- Microsoft.Sql/preview/2020-02-02-preview/ServerTrustGroups.json # Needed when there is more than one input file override-info: @@ -503,6 +506,7 @@ input-file: - ./Microsoft.Sql/preview/2020-02-02-preview/ServerAzureADOnlyAuthentications.json - Microsoft.Sql/preview/2020-02-02-preview/importexport.json - ./Microsoft.Sql/preview/2020-02-02-preview/ManagedInstanceAzureADOnlyAuthentications.json +- ./Microsoft.Sql/preview/2020-02-02-preview/ServerTrustGroups.json # Needed when there is more than one input file override-info: From 32af5f5785cef4925b565b799a47af9f0fbd37a9 Mon Sep 17 00:00:00 2001 From: akashkeshari Date: Tue, 15 Sep 2020 10:24:09 +0530 Subject: [PATCH 058/164] Adding request body for listcredential for Microsoft.Kubernetes (#10766) * added request body for list credential api * Added another example for non aad scenario for list credential api * removed required properties in authentication object * made properties back reqd since body is optional Co-authored-by: Akash Keshari --- .../2020-01-01-preview/connectedClusters.json | 62 +++++++++++++++++++ ...ersListClusterCredentialsResultNonAad.json | 29 +++++++++ 2 files changed, 91 insertions(+) create mode 100644 specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/examples/ConnectedClustersListClusterCredentialsResultNonAad.json diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json index d5551cc9c0ae..594cbe5f46d6 100644 --- a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json @@ -246,6 +246,9 @@ "x-ms-examples": { "ListClusterUserCredentialsExample": { "$ref": "./examples/ConnectedClustersListClusterCredentialsResult.json" + }, + "ListClusterUserCredentialsNonAadExample": { + "$ref": "./examples/ConnectedClustersListClusterCredentialsResultNonAad.json" } }, "parameters": [ @@ -260,6 +263,15 @@ }, { "$ref": "#/parameters/ClusterNamePathParam" + }, + { + "in": "body", + "required": false, + "name": "ClientAuthenticationDetails", + "schema": { + "$ref": "#/definitions/AuthenticationDetails" + }, + "description": "Authentication parameters supplied by the user to fetch credentials for accessing the cluster." } ], "responses": { @@ -607,6 +619,56 @@ } } }, + "AuthenticationDetails": { + "type": "object", + "required": [ + "authenticationMethod", + "value" + ], + "properties": { + "authenticationMethod": { + "type": "string", + "description": "The mode of client authentication.", + "enum": [ + "Token", + "ClientCertificate" + ], + "x-ms-enum": { + "name": "AuthenticationMethod", + "modelAsString": true + } + }, + "value": { + "type": "object", + "properties": { + "token": { + "type": "string", + "description": "Authentication token." + }, + "clientCertificate": { + "$ref": "#/definitions/AuthenticationCertificateDetails" + } + } + } + } + }, + "AuthenticationCertificateDetails": { + "type": "object", + "required": [ + "certificateData", + "keyData" + ], + "properties": { + "certificateData": { + "type": "string", + "description": "Base64 encoded client certificate data." + }, + "keyData": { + "type": "string", + "description": "Base64 encoded key data." + } + } + }, "ConnectedClusterProvisioningState": { "type": "string", "description": "The current deployment state of connectedClusters.", diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/examples/ConnectedClustersListClusterCredentialsResultNonAad.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/examples/ConnectedClustersListClusterCredentialsResultNonAad.json new file mode 100644 index 000000000000..a201d8d63b6b --- /dev/null +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/examples/ConnectedClustersListClusterCredentialsResultNonAad.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "1bfbb5d0-917e-4346-9026-1d3b344417f5", + "resourceGroupName": "k8sc-rg", + "clusterName": "testCluster", + "api-version": "2020-01-01-preview", + "ClientAuthenticationDetails": { + "authenticationMethod": "ClientCertificate", + "value": { + "clientCertificate": { + "certificateData": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", + "keyData": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO" + } + } + } + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "YXBpVmVyc2lvbjogdjENCmNsdXN0ZXJzOg0KLSBjbHVzdGVyOg0KICAgIGNlcnRpZmljYXRlLWF1dGhvcml0eS1kYXRhOiBMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VWNGVrTkRRWEVyWjBGM1NVSkJaMGxSVTJ0dVdsWnZaekp1VmpKVmNYZEtjblZYTTFCSGVrRk9RbWRyY1docmFVYzVkekJDUVZGelJrRkVRVTRLVFZGemQwTlJXVVJXVVZGRVJYZEthbGVsSlEwbHFRVTVDWjJ0eGFHdHBSemwzTUVKQlVVVkdRVUZQUTBGbk9FRk5TVWxEUTJkTFEwRm5SVUUwV1hCNUNsUmtUMVJSU1dNdmVsaERlR3hTZWtVMF" + } + ] + } + } + } +} From fbe9266483321792bcb4b3cce511b17cf685a123 Mon Sep 17 00:00:00 2001 From: JianyeXi <59603451+jianyexi@users.noreply.github.com> Date: Tue, 15 Sep 2020 15:29:14 +0800 Subject: [PATCH 059/164] Update openapi-authoring-automated-guidelines.md (#10606) * Update openapi-authoring-automated-guidelines.md * Update openapi-authoring-automated-guidelines.md * Update openapi-authoring-automated-guidelines.md * Update openapi-authoring-automated-guidelines.md --- .../openapi-authoring-automated-guidelines.md | 29 ++++++++++++++++--- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/documentation/openapi-authoring-automated-guidelines.md b/documentation/openapi-authoring-automated-guidelines.md index 906c35a52055..32866c30d025 100644 --- a/documentation/openapi-authoring-automated-guidelines.md +++ b/documentation/openapi-authoring-automated-guidelines.md @@ -140,6 +140,7 @@ We request OpenAPI(Swagger) spec authoring be assigned to engineers who have an | [R2007](#r2007) | [LongRunningOperationsWithLongRunningExtension](#r2007) | ARM OpenAPI(swagger) specs | | [R2029](#r2029) | [PageableOperation](#r2029) | ARM and Data plane OpenAPI(swagger) specs | | [R4006](#r4006) | [DeprecatedXmsCodeGenerationSetting](#r4006) | ARM and Data plane OpenAPI(swagger) specs | +| [R4024](#r4024) | [PreviewVersionOverOneYear](#r4024) | ARM OpenAPI(swagger) specs | ### RPaaS Violations @@ -1432,7 +1433,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Applies to** : ARM OpenAPI(swagger) specs -**Output Message**: Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, systemData. Model definition '{0}' has extra properties ['{1}']. +**Output Message**: Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, systemData, extendedlocation. Model definition '{0}' has extra properties ['{1}']. **Description**: Per [ARM guidelines](https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md), top level properties of a resource should be only ones from the allowed set. @@ -1690,7 +1691,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Output Message**: Properties of a PATCH request body must not be {0}. PATCH operation: '{1}' Model Definition: '{2}' Property: '{3}' **Description**: A request parameter of the Patch Operation must not have a required/default value. -But it's allowed when all required properties are marked as discriminator, because the discriminator must be required. +But it's allowed when the only required properties is marked as discriminator, because the discriminator must be required. **CreatedAt** : N/A @@ -1994,7 +1995,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul ### R3021 PathResourceTypeNameCamelCase -**Category** : ARM Warning +**Category** : ARM Error **Applies to** : ARM and Data Plane OpenAPI(swagger) specs @@ -2948,4 +2949,24 @@ The following would be valid: } ... ``` -Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) \ No newline at end of file +Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) + +### R4024 PreviewVersionOverOneYear + +**Category** : SDK Warning + +**Applies to** : ARM OpenAPI(swagger) specs + +**Output Message** : The API version:{api-version} having been in a preview state over one year , please move to GA or retire. + +**Description** : Per [Retirement-of-Previews](https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/37683/Retirement-of-Previews), service, feature, API, and SKU in preview for over one year need to move to GA or retire. + +**CreatedAt**: Sep 8, 2020 + +**LastModifiedAt**: Sep 8, 2020 + +**How to fix the violation**: + Consider retiring or moving to GA. + +Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) + From baa81a26995e0d95eb8bd07545e2647d4ccea6eb Mon Sep 17 00:00:00 2001 From: Liran Chen <1437075+liranc@users.noreply.github.com> Date: Tue, 15 Sep 2020 10:31:45 +0300 Subject: [PATCH 060/164] Add support for filter by deviceId (#10771) Co-authored-by: Liran Chen --- .../2019-08-01/examples/IotAlerts/GetIoTAlertList.json | 3 ++- .../IotRecommendations/GetIoTRecommendationList.json | 3 ++- .../Microsoft.Security/stable/2019-08-01/iotAlerts.json | 7 +++++++ .../stable/2019-08-01/iotRecommendations.json | 7 +++++++ 4 files changed, 18 insertions(+), 2 deletions(-) diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlerts/GetIoTAlertList.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlerts/GetIoTAlertList.json index af86889cbe2f..55f00f4e099a 100644 --- a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlerts/GetIoTAlertList.json +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlerts/GetIoTAlertList.json @@ -7,6 +7,7 @@ "alertType": "IoT_PrivilegedContainer", "startTimeUtc>": "2020-05-12T06:32:25Z", "startTimeUtc<": "2020-05-14T06:32:25Z", + "compromisedEntity": "device-1", "$limit": 1 }, "responses": { @@ -37,7 +38,7 @@ } } ], - "nextLink": "https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Security/iotSecuritySolutions/mySolution/iotAlerts?api-version=2019-08-01&alertType=IoT_PrivilegedContainer&startTimeUtc>=2020-05-12T06:32:25Z&startTimeUtc<=2020-05-14T06:32:25Z&$limit=1&$skipToken=903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", + "nextLink": "https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Security/iotSecuritySolutions/mySolution/iotAlerts?api-version=2019-08-01&alertType=IoT_PrivilegedContainer&startTimeUtc>=2020-05-12T06:32:25Z&startTimeUtc<=2020-05-14T06:32:25Z&compromisedEntity=device-1&$limit=1&$skipToken=903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", "totalCount": 23 } } diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotRecommendations/GetIoTRecommendationList.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotRecommendations/GetIoTRecommendationList.json index d1e9b306b467..b7d6ce02c3a8 100644 --- a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotRecommendations/GetIoTRecommendationList.json +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotRecommendations/GetIoTRecommendationList.json @@ -5,6 +5,7 @@ "resourceGroupName": "myGroup", "solutionName": "mySolution", "recommendationType": "IoT_Baseline", + "deviceId": "device-1", "$limit": 1 }, "responses": { @@ -28,7 +29,7 @@ } } ], - "nextLink": "https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Security/iotSecuritySolutions/mySolution/iotRecommendations?api-version=2019-08-01&recommendationType=IoT_Baseline&$limit=1&$skipToken=903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", + "nextLink": "https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Security/iotSecuritySolutions/mySolution/iotRecommendations?api-version=2019-08-01&recommendationType=IoT_Baseline&deviceId=device-1&$limit=1&$skipToken=903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", "totalCount": 23 } } diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotAlerts.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotAlerts.json index b51e7a792f22..13dddab9a5fb 100644 --- a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotAlerts.json +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotAlerts.json @@ -82,6 +82,13 @@ "type": "string", "description": "Filter by alert type" }, + { + "in": "query", + "name": "compromisedEntity", + "required": false, + "type": "string", + "description": "Filter by compromised device" + }, { "in": "query", "name": "$limit", diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotRecommendations.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotRecommendations.json index c50b08a6f7c8..4b24008407f1 100644 --- a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotRecommendations.json +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotRecommendations.json @@ -66,6 +66,13 @@ "type": "string", "description": "Filter by recommendation type" }, + { + "in": "query", + "name": "deviceId", + "required": false, + "type": "string", + "description": "Filter by device id" + }, { "in": "query", "name": "$limit", From 56d853a348eac1f33085073d1eaeb314d414dd46 Mon Sep 17 00:00:00 2001 From: ajaygit158 <61898818+ajaygit158@users.noreply.github.com> Date: Tue, 15 Sep 2020 17:01:36 +0530 Subject: [PATCH 061/164] =?UTF-8?q?Corrected=20Examples=20for=20Resource?= =?UTF-8?q?=20Mover=20to=20generate=20documentation=20examp=E2=80=A6=20(#1?= =?UTF-8?q?0791)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Corrected Examples for Resource Mover to generate documentation examples correctly. * Example file name change. * Updates as per Prettier check. * Updates * Model Validation corrections. * Updates Co-authored-by: Ajay Gupta --- .../examples/MoveCollections_Commit.json | 10 ++++--- .../examples/MoveCollections_Create.json | 15 ++++++---- .../examples/MoveCollections_Discard.json | 10 ++++--- .../MoveCollections_InitiateMove.json | 10 ++++--- .../examples/MoveCollections_Prepare.json | 10 ++++--- .../MoveCollections_ResolveDependencies.json | 5 +--- ...pdate.json => MoveCollections_Update.json} | 9 ++++-- .../examples/MoveResources_Create.json | 28 ++++++++++--------- .../regionmovecollection.json | 4 +-- 9 files changed, 58 insertions(+), 43 deletions(-) rename specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/{MoveCollection_Update.json => MoveCollections_Update.json} (87%) diff --git a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_Commit.json b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_Commit.json index 03877882ade2..82d11f9f57bd 100644 --- a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_Commit.json +++ b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_Commit.json @@ -4,10 +4,12 @@ "subscriptionId": "subid", "resourceGroupName": "rg1", "api-version": "2019-10-01-preview", - "validateOnly": false, - "moveResources": [ - "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" - ] + "body": { + "validateOnly": false, + "moveResources": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" + ] + } }, "responses": { "200": { diff --git a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_Create.json b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_Create.json index 612e2ddc6c90..233256c4072c 100644 --- a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_Create.json +++ b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_Create.json @@ -4,12 +4,15 @@ "subscriptionId": "subid", "resourceGroupName": "rg1", "api-version": "2019-10-01-preview", - "identity": { - "type": "SystemAssigned" - }, - "properties": { - "sourceRegion": "eastus", - "targetRegion": "westus" + "body": { + "location": "eastus2", + "properties": { + "sourceRegion": "eastus", + "targetRegion": "westus" + }, + "identity": { + "type": "SystemAssigned" + } } }, "responses": { diff --git a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_Discard.json b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_Discard.json index 03877882ade2..82d11f9f57bd 100644 --- a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_Discard.json +++ b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_Discard.json @@ -4,10 +4,12 @@ "subscriptionId": "subid", "resourceGroupName": "rg1", "api-version": "2019-10-01-preview", - "validateOnly": false, - "moveResources": [ - "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" - ] + "body": { + "validateOnly": false, + "moveResources": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" + ] + } }, "responses": { "200": { diff --git a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_InitiateMove.json b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_InitiateMove.json index 03877882ade2..82d11f9f57bd 100644 --- a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_InitiateMove.json +++ b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_InitiateMove.json @@ -4,10 +4,12 @@ "subscriptionId": "subid", "resourceGroupName": "rg1", "api-version": "2019-10-01-preview", - "validateOnly": false, - "moveResources": [ - "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" - ] + "body": { + "validateOnly": false, + "moveResources": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" + ] + } }, "responses": { "200": { diff --git a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_Prepare.json b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_Prepare.json index 03877882ade2..82d11f9f57bd 100644 --- a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_Prepare.json +++ b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_Prepare.json @@ -4,10 +4,12 @@ "subscriptionId": "subid", "resourceGroupName": "rg1", "api-version": "2019-10-01-preview", - "validateOnly": false, - "moveResources": [ - "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" - ] + "body": { + "validateOnly": false, + "moveResources": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" + ] + } }, "responses": { "200": { diff --git a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_ResolveDependencies.json b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_ResolveDependencies.json index 85002cd1e9f3..1ed842717fa5 100644 --- a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_ResolveDependencies.json +++ b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_ResolveDependencies.json @@ -3,10 +3,7 @@ "moveCollectionName": "movecollection1", "subscriptionId": "subid", "resourceGroupName": "rg1", - "api-version": "2019-10-01-preview", - "moveResources": [ - "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" - ] + "api-version": "2019-10-01-preview" }, "responses": { "200": { diff --git a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollection_Update.json b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_Update.json similarity index 87% rename from specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollection_Update.json rename to specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_Update.json index 473c63d53b67..b47eb86216bb 100644 --- a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollection_Update.json +++ b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveCollections_Update.json @@ -5,8 +5,13 @@ "resourceGroupName": "rg1", "moveResourceName": "moveresourcename1", "api-version": "2019-10-01-preview", - "properties": { - "tags": "mc1" + "body": { + "tags": { + "key1": "mc1" + }, + "identity": { + "type": "SystemAssigned" + } } }, "responses": { diff --git a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveResources_Create.json b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveResources_Create.json index bd79b14dcc56..16ab97ed9d53 100644 --- a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveResources_Create.json +++ b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/MoveResources_Create.json @@ -5,20 +5,22 @@ "resourceGroupName": "rg1", "moveResourceName": "moveresourcename1", "api-version": "2019-10-01-preview", - "properties": { - "sourceId": "/subscriptions/subid/resourceGroups/eastus/providers/Microsoft.Compute/virtualMachines/eastusvm1", - "dependsOnOverrides": [ - { - "id": "/subscriptions/c4488a3f-a7f7-4ad4-aa72-0e1f4d9c0756/resourceGroups/eastus/providers/Microsoft.Network/networkInterfaces/eastusvm140", - "targetId": "/subscriptions/c4488a3f-a7f7-4ad4-aa72-0e1f4d9c0756/resourceGroups/westus/providers/Microsoft.Network/networkInterfaces/eastusvm140" + "body": { + "properties": { + "sourceId": "/subscriptions/subid/resourceGroups/eastus/providers/Microsoft.Compute/virtualMachines/eastusvm1", + "dependsOnOverrides": [ + { + "id": "/subscriptions/c4488a3f-a7f7-4ad4-aa72-0e1f4d9c0756/resourceGroups/eastus/providers/Microsoft.Network/networkInterfaces/eastusvm140", + "targetId": "/subscriptions/c4488a3f-a7f7-4ad4-aa72-0e1f4d9c0756/resourceGroups/westus/providers/Microsoft.Network/networkInterfaces/eastusvm140" + } + ], + "resourceSettings": { + "resourceType": "Microsoft.Compute/virtualMachines", + "targetResourceName": "westusvm1", + "targetAvailabilityZone": "2", + "targetVmSize": null, + "targetAvailabilitySetId": "/subscriptions/subid/resourceGroups/eastus/providers/Microsoft.Compute/availabilitySets/avset1" } - ], - "resourceSettings": { - "resourceType": "Microsoft.Compute/VirtualMachines", - "targetResourceName": "westusvm1", - "targetAvailabilityZone": "2", - "targetVmSize": null, - "targetAvailabilitySetId": "/subscriptions/subid/resourceGroups/eastus/providers/Microsoft.Compute/availabilitySets/avset1" } } }, diff --git a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json index c755d87cc0f4..2917019b763d 100644 --- a/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json +++ b/specification/regionmove/resource-manager/Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json @@ -121,8 +121,8 @@ } }, "x-ms-examples": { - "MoveCollection_Update": { - "$ref": "./examples/MoveCollection_Update.json" + "MoveCollections_Update": { + "$ref": "./examples/MoveCollections_Update.json" } } }, From aa25f9ef5d1a0def29dfe607d9bc475e943bb4c1 Mon Sep 17 00:00:00 2001 From: Xing Wu Date: Tue, 15 Sep 2020 11:20:53 -0700 Subject: [PATCH 062/164] Add new API version 2020-09-01 (#10737) * Add previous API version as baseline. * Add new data plane API version 2020-09-01 * Update management plane with new API 2020-09-01. * Update readme to add new API version. * Fix example errors. * Update comment based on feedback --- .../stable/2020-09-01.12.0/BatchService.json | 16718 ++++++++++++++++ .../examples/AccountListPoolNodeCounts.json | 121 + .../examples/AccountListSupportedImages.json | 76 + .../examples/ApplicationGet.json | 20 + .../examples/ApplicationList.json | 23 + .../examples/CertificateAdd.json | 18 + .../examples/CertificateCancelDelete.json | 13 + .../examples/CertificateDelete.json | 13 + .../examples/CertificateGet.json | 34 + .../examples/CertificateList.json | 36 + .../examples/FileDeleteFromNode.json | 15 + .../examples/FileDeleteFromTask.json | 15 + .../examples/FileGetFromNode.json | 21 + .../examples/FileGetFromTask.json | 21 + .../examples/FileGetPropertiesFromNode.json | 20 + .../examples/FileGetPropertiesFromTask.json | 20 + .../examples/FileListFromNode.json | 46 + .../examples/FileListFromTask.json | 41 + .../examples/JobAdd_Basic.json | 18 + .../examples/JobAdd_Complex.json | 121 + .../2020-09-01.12.0/examples/JobDelete.json | 12 + .../2020-09-01.12.0/examples/JobDisable.json | 15 + .../2020-09-01.12.0/examples/JobEnable.json | 12 + .../2020-09-01.12.0/examples/JobGet.json | 41 + .../examples/JobGetLifetimeStatistics.json | 28 + .../examples/JobGetTaskCounts.json | 29 + .../2020-09-01.12.0/examples/JobList.json | 42 + .../examples/JobListFromJobSchedule.json | 43 + ...obListPreparationAndReleaseTaskStatus.json | 40 + .../2020-09-01.12.0/examples/JobPatch.json | 22 + .../examples/JobScheduleAdd_Basic.json | 22 + .../examples/JobScheduleAdd_Complex.json | 129 + .../examples/JobScheduleDelete.json | 12 + .../examples/JobScheduleDisable.json | 12 + .../examples/JobScheduleEnable.json | 12 + .../examples/JobScheduleExists.json | 13 + .../examples/JobScheduleGet.json | 44 + .../examples/JobScheduleList.json | 74 + .../examples/JobSchedulePatch.json | 28 + .../examples/JobScheduleTerminate.json | 12 + .../examples/JobScheduleUpdate.json | 28 + .../examples/JobTerminate.json | 15 + .../2020-09-01.12.0/examples/JobUpdate.json | 22 + .../2020-09-01.12.0/examples/NodeAddUser.json | 19 + .../examples/NodeDeleteUser.json | 14 + .../examples/NodeDisableScheduling.json | 16 + .../examples/NodeEnableScheduling.json | 13 + .../examples/NodeGetRemoteDesktop.json | 15 + .../examples/NodeGetRemoteLoginSettings.json | 18 + .../examples/NodeGet_Basic.json | 52 + .../2020-09-01.12.0/examples/NodeList.json | 134 + .../2020-09-01.12.0/examples/NodeReboot.json | 16 + .../2020-09-01.12.0/examples/NodeReimage.json | 16 + .../examples/NodeUpdateUser.json | 18 + .../examples/NodeUploadBatchServiceLogs.json | 22 + .../PoolAdd_CloudServiceConfiguration.json | 37 + .../examples/PoolAdd_MountConfiguration.json | 70 + .../PoolAdd_VirtualMachineConfiguration.json | 42 + ...ualMachineConfigurationWithContainers.json | 41 + .../2020-09-01.12.0/examples/PoolDelete.json | 12 + .../examples/PoolDisableAutoScale.json | 12 + .../examples/PoolEnableAutoscale.json | 16 + .../examples/PoolEvaluateAutoscale.json | 20 + .../2020-09-01.12.0/examples/PoolExists.json | 13 + .../examples/PoolGetLifetimeStatistics.json | 37 + .../examples/PoolGet_Basic.json | 56 + .../examples/PoolListUsageMetrics.json | 30 + .../examples/PoolList_Basic.json | 54 + .../2020-09-01.12.0/examples/PoolPatch.json | 17 + .../examples/PoolRemoveNodes.json | 18 + .../2020-09-01.12.0/examples/PoolResize.json | 16 + .../examples/PoolStopResize.json | 12 + .../2020-09-01.12.0/examples/PoolUpdate.json | 20 + .../examples/TaskAddCollection_Basic.json | 43 + .../examples/TaskAddCollection_Complex.json | 78 + .../examples/TaskAdd_Basic.json | 16 + .../examples/TaskAdd_ContainerSettings.json | 26 + .../examples/TaskAdd_ExitConditions.json | 33 + .../examples/TaskAdd_RequiredSlots.json | 17 + .../2020-09-01.12.0/examples/TaskDelete.json | 13 + .../2020-09-01.12.0/examples/TaskGet.json | 44 + .../2020-09-01.12.0/examples/TaskList.json | 69 + .../examples/TaskListSubtasks.json | 50 + .../examples/TaskReactivate.json | 13 + .../examples/TaskTerminate.json | 13 + .../2020-09-01.12.0/examples/TaskUpdate.json | 20 + specification/batch/data-plane/readme.go.md | 10 + specification/batch/data-plane/readme.md | 12 +- .../stable/2020-09-01/BatchManagement.json | 5147 +++++ .../examples/ApplicationCreate.json | 32 + .../examples/ApplicationDelete.json | 13 + .../2020-09-01/examples/ApplicationGet.json | 26 + .../2020-09-01/examples/ApplicationList.json | 37 + .../examples/ApplicationPackageActivate.json | 31 + .../examples/ApplicationPackageCreate.json | 28 + .../examples/ApplicationPackageDelete.json | 14 + .../examples/ApplicationPackageGet.json | 28 + .../examples/ApplicationPackageList.json | 37 + .../examples/ApplicationUpdate.json | 34 + .../examples/BatchAccountCreate_BYOS.json | 53 + .../examples/BatchAccountCreate_Default.json | 44 + ...hAccountCreate_SystemAssignedIdentity.json | 49 + .../examples/BatchAccountDelete.json | 13 + .../2020-09-01/examples/BatchAccountGet.json | 35 + .../examples/BatchAccountGetKeys.json | 17 + .../2020-09-01/examples/BatchAccountList.json | 37 + .../BatchAccountListByResourceGroup.json | 38 + .../examples/BatchAccountRegenerateKey.json | 20 + ...atchAccountSynchronizeAutoStorageKeys.json | 11 + .../examples/BatchAccountUpdate.json | 42 + .../examples/CertificateCancelDeletion.json | 32 + .../examples/CertificateCreate_Full.json | 39 + .../examples/CertificateCreate_Minimal.json | 36 + .../CertificateCreate_MinimalCer.json | 36 + .../examples/CertificateDelete.json | 19 + .../2020-09-01/examples/CertificateGet.json | 30 + .../CertificateGetWithDeletionError.json | 43 + .../2020-09-01/examples/CertificateList.json | 32 + .../examples/CertificateListWithFilter.json | 38 + .../examples/CertificateUpdate.json | 36 + ...onCheckNameAvailability_AlreadyExists.json | 20 + ...cationCheckNameAvailability_Available.json | 18 + .../examples/LocationGetQuotas.json | 14 + .../examples/PoolCreate_FullExample.json | 285 + ...eate_MinimalCloudServiceConfiguration.json | 72 + ...te_MinimalVirtualMachineConfiguration.json | 77 + .../PoolCreate_NoPublicIPAddresses.json | 77 + .../examples/PoolCreate_PublicIPs.json | 83 + .../PoolCreate_SharedImageGallery.json | 65 + ...oolCreate_VirtualMachineConfiguration.json | 189 + .../2020-09-01/examples/PoolDelete.json | 19 + .../examples/PoolDisableAutoScale.json | 56 + .../stable/2020-09-01/examples/PoolGet.json | 155 + .../stable/2020-09-01/examples/PoolList.json | 161 + .../examples/PoolListWithFilter.json | 44 + .../2020-09-01/examples/PoolStopResize.json | 62 + .../examples/PoolUpdate_EnableAutoScale.json | 69 + .../examples/PoolUpdate_OtherProperties.json | 115 + .../examples/PoolUpdate_RemoveStartTask.json | 65 + .../examples/PoolUpdate_ResizePool.json | 74 + .../examples/PrivateBatchAccountCreate.json | 53 + .../examples/PrivateBatchAccountGet.json | 48 + .../PrivateEndpointConnectionGet.json | 27 + .../PrivateEndpointConnectionUpdate.json | 47 + .../PrivateEndpointConnectionsList.json | 31 + .../examples/PrivateLinkResourceGet.json | 27 + .../examples/PrivateLinkResourcesList.json | 31 + .../readme.azureresourceschema.md | 12 + .../batch/resource-manager/readme.go.md | 21 +- .../batch/resource-manager/readme.md | 10 +- 150 files changed, 27601 insertions(+), 3 deletions(-) create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/BatchService.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/AccountListPoolNodeCounts.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/AccountListSupportedImages.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/ApplicationGet.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/ApplicationList.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/CertificateAdd.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/CertificateCancelDelete.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/CertificateDelete.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/CertificateGet.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/CertificateList.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileDeleteFromNode.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileDeleteFromTask.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileGetFromNode.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileGetFromTask.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileGetPropertiesFromNode.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileGetPropertiesFromTask.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileListFromNode.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileListFromTask.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobAdd_Basic.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobAdd_Complex.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobDelete.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobDisable.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobEnable.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobGet.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobGetLifetimeStatistics.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobGetTaskCounts.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobList.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobListFromJobSchedule.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobListPreparationAndReleaseTaskStatus.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobPatch.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleAdd_Basic.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleAdd_Complex.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleDelete.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleDisable.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleEnable.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleExists.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleGet.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleList.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobSchedulePatch.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleTerminate.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleUpdate.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobTerminate.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobUpdate.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeAddUser.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeDeleteUser.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeDisableScheduling.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeEnableScheduling.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeGetRemoteDesktop.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeGetRemoteLoginSettings.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeGet_Basic.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeList.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeReboot.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeReimage.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeUpdateUser.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeUploadBatchServiceLogs.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolAdd_CloudServiceConfiguration.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolAdd_MountConfiguration.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolAdd_VirtualMachineConfiguration.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolAdd_VirtualMachineConfigurationWithContainers.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolDelete.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolDisableAutoScale.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolEnableAutoscale.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolEvaluateAutoscale.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolExists.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolGetLifetimeStatistics.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolGet_Basic.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolListUsageMetrics.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolList_Basic.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolPatch.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolRemoveNodes.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolResize.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolStopResize.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolUpdate.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAddCollection_Basic.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAddCollection_Complex.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAdd_Basic.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAdd_ContainerSettings.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAdd_ExitConditions.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAdd_RequiredSlots.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskDelete.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskGet.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskList.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskListSubtasks.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskReactivate.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskTerminate.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskUpdate.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/BatchManagement.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationCreate.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationDelete.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationGet.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationList.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationPackageActivate.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationPackageCreate.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationPackageDelete.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationPackageGet.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationPackageList.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationUpdate.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountCreate_BYOS.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountCreate_Default.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountCreate_SystemAssignedIdentity.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountDelete.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountGet.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountGetKeys.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountList.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountListByResourceGroup.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountRegenerateKey.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountSynchronizeAutoStorageKeys.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountUpdate.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateCancelDeletion.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateCreate_Full.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateCreate_Minimal.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateCreate_MinimalCer.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateDelete.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateGet.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateGetWithDeletionError.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateList.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateListWithFilter.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateUpdate.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/LocationCheckNameAvailability_AlreadyExists.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/LocationCheckNameAvailability_Available.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/LocationGetQuotas.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_FullExample.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_MinimalCloudServiceConfiguration.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_MinimalVirtualMachineConfiguration.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_NoPublicIPAddresses.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_PublicIPs.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_SharedImageGallery.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_VirtualMachineConfiguration.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolDelete.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolDisableAutoScale.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolGet.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolList.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolListWithFilter.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolStopResize.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolUpdate_EnableAutoScale.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolUpdate_OtherProperties.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolUpdate_RemoveStartTask.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolUpdate_ResizePool.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateBatchAccountCreate.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateBatchAccountGet.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateEndpointConnectionGet.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateEndpointConnectionUpdate.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateEndpointConnectionsList.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateLinkResourceGet.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateLinkResourcesList.json diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/BatchService.json new file mode 100644 index 000000000000..2e43550bd55e --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/BatchService.json @@ -0,0 +1,16718 @@ +{ + "swagger": "2.0", + "info": { + "title": "BatchService", + "version": "2020-09-01.12.0", + "description": "A client for issuing REST requests to the Azure Batch service.", + "x-ms-code-generation-settings": { + "name": "BatchServiceClient" + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{batchUrl}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/batchUrl" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + }, + { + "api_key": [] + } + ], + "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" + } + }, + "api_key": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + }, + "paths": { + "/applications": { + "get": { + "tags": [ + "Applications" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Application_List", + "x-ms-examples": { + "List applications": { + "$ref": "./examples/ApplicationList.json" + } + }, + "summary": "Lists all of the applications available in the specified Account.", + "description": "This operation returns only Applications and versions that are available for use on Compute Nodes; that is, that can be used in an Package reference. For administrator information about applications and versions that are not yet available to Compute Nodes, use the Azure portal or the Azure Resource Manager API.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 applications can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of applications.", + "schema": { + "$ref": "#/definitions/ApplicationListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/applications/{applicationId}": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "Application_Get", + "x-ms-examples": { + "Get applications": { + "$ref": "./examples/ApplicationGet.json" + } + }, + "summary": "Gets information about the specified Application.", + "description": "This operation returns only Applications and versions that are available for use on Compute Nodes; that is, that can be used in an Package reference. For administrator information about Applications and versions that are not yet available to Compute Nodes, use the Azure portal or the Azure Resource Manager API.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Application." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the application.", + "schema": { + "$ref": "#/definitions/ApplicationSummary" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/poolusagemetrics": { + "get": { + "tags": [ + "Pools" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Pool_ListUsageMetrics", + "x-ms-examples": { + "Pool list usage metrics": { + "$ref": "./examples/PoolListUsageMetrics.json" + } + }, + "summary": "Lists the usage metrics, aggregated by Pool across individual time intervals, for the specified Account.", + "description": "If you do not specify a $filter clause including a poolId, the response includes all Pools that existed in the Account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "starttime", + "x-ms-client-name": "startTime", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "The earliest time from which to include metrics. This must be at least two and a half hours before the current time. If not specified this defaults to the start time of the last aggregation interval currently available.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "endtime", + "x-ms-client-name": "endTime", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "The latest time from which to include metrics. This must be at least two hours before the current time. If not specified this defaults to the end time of the last aggregation interval currently available.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 results will be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of Pool usage details.", + "schema": { + "$ref": "#/definitions/PoolListUsageMetricsResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/supportedimages": { + "get": { + "tags": [ + "Accounts" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Account_ListSupportedImages", + "x-ms-examples": { + "Account list node agent skus": { + "$ref": "./examples/AccountListSupportedImages.json" + } + }, + "summary": "Lists all Virtual Machine Images supported by the Azure Batch service.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-support-images.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 results will be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of supported Virtual Machine Images.", + "schema": { + "$ref": "#/definitions/AccountListSupportedImagesResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/nodecounts": { + "get": { + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "tags": [ + "Accounts" + ], + "operationId": "Account_ListPoolNodeCounts", + "description": "Gets the number of Compute Nodes in each state, grouped by Pool. Note that the numbers returned may not always be up to date. If you need exact node counts, use a list query.", + "x-ms-examples": { + "NodeCountsPayload": { + "$ref": "./examples/AccountListPoolNodeCounts.json" + } + }, + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 10, + "minimum": 1, + "maximum": 10, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + } + }, + "description": "The response contains the number of Compute Nodes in each Compute Node state, grouped by Pool.", + "schema": { + "$ref": "#/definitions/PoolNodeCountsListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/lifetimepoolstats": { + "get": { + "tags": [ + "Pools" + ], + "operationId": "Pool_GetAllLifetimeStatistics", + "x-ms-examples": { + "Pool get lifetime statistics": { + "$ref": "./examples/PoolGetLifetimeStatistics.json" + } + }, + "summary": "Gets lifetime summary statistics for all of the Pools in the specified Account.", + "description": "Statistics are aggregated across all Pools that have ever existed in the Account, from Account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the Pool statistics for the lifetime of the Batch Account.", + "schema": { + "$ref": "#/definitions/PoolStatistics" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/lifetimejobstats": { + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Job_GetAllLifetimeStatistics", + "x-ms-examples": { + "Job get lifetime statistics": { + "$ref": "./examples/JobGetLifetimeStatistics.json" + } + }, + "summary": "Gets lifetime summary statistics for all of the Jobs in the specified Account.", + "description": "Statistics are aggregated across all Jobs that have ever existed in the Account, from Account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the Job statistics for the lifetime of the Batch Account.", + "schema": { + "$ref": "#/definitions/JobStatistics" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/certificates": { + "post": { + "tags": [ + "Certificates" + ], + "operationId": "Certificate_Add", + "x-ms-examples": { + "Certificate add": { + "$ref": "./examples/CertificateAdd.json" + } + }, + "summary": "Adds a Certificate to the specified Account.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "certificate", + "in": "body", + "description": "The Certificate to be added.", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateAddParameter" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Certificates" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Certificate_List", + "x-ms-examples": { + "Certificate list": { + "$ref": "./examples/CertificateList.json" + } + }, + "summary": "Lists all of the Certificates that have been added to the specified Account.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 Certificates can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of Certificates.", + "schema": { + "$ref": "#/definitions/CertificateListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})/canceldelete": { + "post": { + "tags": [ + "Certificates" + ], + "operationId": "Certificate_CancelDeletion", + "x-ms-examples": { + "Certificate cancel delete": { + "$ref": "./examples/CertificateCancelDelete.json" + } + }, + "summary": "Cancels a failed deletion of a Certificate from the specified Account.", + "description": "If you try to delete a Certificate that is being used by a Pool or Compute Node, the status of the Certificate changes to deleteFailed. If you decide that you want to continue using the Certificate, you can use this operation to set the status of the Certificate back to active. If you intend to delete the Certificate, you do not need to run this operation after the deletion failed. You must make sure that the Certificate is not being used by any resources, and then you can try again to delete the Certificate.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "thumbprintAlgorithm", + "in": "path", + "required": true, + "type": "string", + "description": "The algorithm used to derive the thumbprint parameter. This must be sha1." + }, + { + "name": "thumbprint", + "in": "path", + "required": true, + "type": "string", + "description": "The thumbprint of the Certificate being deleted." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})": { + "delete": { + "tags": [ + "Certificates" + ], + "operationId": "Certificate_Delete", + "x-ms-examples": { + "Certificate delete": { + "$ref": "./examples/CertificateDelete.json" + } + }, + "summary": "Deletes a Certificate from the specified Account.", + "description": "You cannot delete a Certificate if a resource (Pool or Compute Node) is using it. Before you can delete a Certificate, you must therefore make sure that the Certificate is not associated with any existing Pools, the Certificate is not installed on any Nodes (even if you remove a Certificate from a Pool, it is not removed from existing Compute Nodes in that Pool until they restart), and no running Tasks depend on the Certificate. If you try to delete a Certificate that is in use, the deletion fails. The Certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the Certificate.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "thumbprintAlgorithm", + "in": "path", + "required": true, + "type": "string", + "description": "The algorithm used to derive the thumbprint parameter. This must be sha1." + }, + { + "name": "thumbprint", + "in": "path", + "required": true, + "type": "string", + "description": "The thumbprint of the Certificate to be deleted." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Certificates" + ], + "operationId": "Certificate_Get", + "x-ms-examples": { + "Certificate get": { + "$ref": "./examples/CertificateGet.json" + } + }, + "description": "Gets information about the specified Certificate.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "thumbprintAlgorithm", + "in": "path", + "required": true, + "type": "string", + "description": "The algorithm used to derive the thumbprint parameter. This must be sha1." + }, + { + "name": "thumbprint", + "in": "path", + "required": true, + "type": "string", + "description": "The thumbprint of the Certificate to get." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the Certificate.", + "schema": { + "$ref": "#/definitions/Certificate" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}/files/{filePath}": { + "delete": { + "tags": [ + "Files" + ], + "operationId": "File_DeleteFromTask", + "x-ms-examples": { + "File delete from task": { + "$ref": "./examples/FileDeleteFromTask.json" + } + }, + "summary": "Deletes the specified Task file from the Compute Node where the Task ran.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job that contains the Task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Task whose file you want to delete." + }, + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the Task file or directory that you want to delete." + }, + { + "name": "recursive", + "in": "query", + "required": false, + "type": "boolean", + "description": "Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Files" + ], + "operationId": "File_GetFromTask", + "x-ms-examples": { + "Get File From Task": { + "$ref": "./examples/FileGetFromTask.json" + } + }, + "description": "Returns the content of the specified Task file.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job that contains the Task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Task whose file you want to retrieve." + }, + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the Task file that you want to get the content of." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-range", + "in": "header", + "required": false, + "type": "string", + "description": "The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json", + "application/octet-stream" + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-creation-time": { + "description": "The file creation time.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-batch-file-isdirectory": { + "description": "Whether the object represents a directory.", + "type": "boolean" + }, + "ocp-batch-file-url": { + "description": "The URL of the file.", + "type": "string" + }, + "ocp-batch-file-mode": { + "description": "The file mode attribute in octal format.", + "type": "string" + }, + "Content-Type": { + "description": "The content type of the file.", + "type": "string" + }, + "Content-Length": { + "description": "The length of the file.", + "type": "integer", + "format": "int64" + } + }, + "description": "A response containing the file content.", + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "head": { + "tags": [ + "Files" + ], + "operationId": "File_GetPropertiesFromTask", + "x-ms-examples": { + "File get properties from task": { + "$ref": "./examples/FileGetPropertiesFromTask.json" + } + }, + "description": "Gets the properties of the specified Task file.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job that contains the Task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Task whose file you want to get the properties of." + }, + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the Task file that you want to get the properties of." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-creation-time": { + "description": "The file creation time.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-batch-file-isdirectory": { + "description": "Whether the object represents a directory.", + "type": "boolean" + }, + "ocp-batch-file-url": { + "description": "The URL of the file.", + "type": "string" + }, + "ocp-batch-file-mode": { + "description": "The file mode attribute in octal format.", + "type": "string" + }, + "Content-Type": { + "description": "The content type of the file.", + "type": "string" + }, + "Content-Length": { + "description": "The length of the file.", + "type": "integer", + "format": "int64" + } + }, + "description": "A response containing the file properties." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/files/{filePath}": { + "delete": { + "tags": [ + "Files" + ], + "operationId": "File_DeleteFromComputeNode", + "x-ms-examples": { + "File delete from node": { + "$ref": "./examples/FileDeleteFromNode.json" + } + }, + "summary": "Deletes the specified file from the Compute Node.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node from which you want to delete the file." + }, + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the file or directory that you want to delete." + }, + { + "name": "recursive", + "in": "query", + "required": false, + "type": "boolean", + "description": "Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Files" + ], + "operationId": "File_GetFromComputeNode", + "x-ms-examples": { + "Get File From Compute Node": { + "$ref": "./examples/FileGetFromNode.json" + } + }, + "description": "Returns the content of the specified Compute Node file.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node that contains the file." + }, + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the Compute Node file that you want to get the content of." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-range", + "in": "header", + "required": false, + "type": "string", + "description": "The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json", + "application/octet-stream" + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-creation-time": { + "description": "The file creation time.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-batch-file-isdirectory": { + "description": "Whether the object represents a directory.", + "type": "boolean" + }, + "ocp-batch-file-url": { + "description": "The URL of the file.", + "type": "string" + }, + "ocp-batch-file-mode": { + "description": "The file mode attribute in octal format.", + "type": "string" + }, + "Content-Type": { + "description": "The content type of the file.", + "type": "string" + }, + "Content-Length": { + "description": "The length of the file.", + "type": "integer", + "format": "int64" + } + }, + "description": "The file content.", + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "head": { + "tags": [ + "Files" + ], + "operationId": "File_GetPropertiesFromComputeNode", + "x-ms-examples": { + "File get properties from node": { + "$ref": "./examples/FileGetPropertiesFromNode.json" + } + }, + "description": "Gets the properties of the specified Compute Node file.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node that contains the file." + }, + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the Compute Node file that you want to get the properties of." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-creation-time": { + "description": "The file creation time.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-batch-file-isdirectory": { + "description": "Whether the object represents a directory.", + "type": "boolean" + }, + "ocp-batch-file-url": { + "description": "The URL of the file.", + "type": "string" + }, + "ocp-batch-file-mode": { + "description": "The file mode attribute in octal format.", + "type": "string" + }, + "Content-Type": { + "description": "The content type of the file.", + "type": "string" + }, + "Content-Length": { + "description": "The length of the file.", + "type": "integer", + "format": "int64" + } + }, + "description": "A response containing the file properties." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}/files": { + "get": { + "tags": [ + "Files" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "File_ListFromTask", + "x-ms-examples": { + "File list from task": { + "$ref": "./examples/FileListFromTask.json" + } + }, + "summary": "Lists the files in a Task's directory on its Compute Node.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job that contains the Task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Task whose files you want to list." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "recursive", + "in": "query", + "required": false, + "type": "boolean", + "description": "Whether to list children of the Task directory. This parameter can be used in combination with the filter parameter to list specific type of files." + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 files can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of files.", + "schema": { + "$ref": "#/definitions/NodeFileListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/files": { + "get": { + "tags": [ + "Files" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "File_ListFromComputeNode", + "x-ms-examples": { + "File list from node": { + "$ref": "./examples/FileListFromNode.json" + } + }, + "summary": "Lists all of the files in Task directories on the specified Compute Node.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node whose files you want to list." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "recursive", + "in": "query", + "required": false, + "type": "boolean", + "description": "Whether to list children of a directory." + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 files can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of files.", + "schema": { + "$ref": "#/definitions/NodeFileListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobschedules/{jobScheduleId}": { + "head": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Exists", + "x-ms-examples": { + "Check Job Schedule Exists": { + "$ref": "./examples/JobScheduleExists.json" + } + }, + "summary": "Checks the specified Job Schedule exists.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job Schedule which you want to check." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing headers related to the Job Schedule, if it exists." + }, + "404": { + "description": "The Job Schedule does not exist." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "delete": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Delete", + "x-ms-examples": { + "JobSchedule delete": { + "$ref": "./examples/JobScheduleDelete.json" + } + }, + "summary": "Deletes a Job Schedule from the specified Account.", + "description": "When you delete a Job Schedule, this also deletes all Jobs and Tasks under that schedule. When Tasks are deleted, all the files in their working directories on the Compute Nodes are also deleted (the retention period is ignored). The Job Schedule statistics are no longer accessible once the Job Schedule is deleted, though they are still counted towards Account lifetime statistics.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job Schedule to delete." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Get", + "x-ms-examples": { + "JobSchedule get": { + "$ref": "./examples/JobScheduleGet.json" + } + }, + "description": "Gets information about the specified Job Schedule.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job Schedule to get." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the Job Schedule.", + "schema": { + "$ref": "#/definitions/CloudJobSchedule" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "patch": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Patch", + "x-ms-examples": { + "JobSchedule patch": { + "$ref": "./examples/JobSchedulePatch.json" + } + }, + "summary": "Updates the properties of the specified Job Schedule.", + "description": "This replaces only the Job Schedule properties specified in the request. For example, if the schedule property is not specified with this request, then the Batch service will keep the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job Schedule to update." + }, + { + "name": "jobSchedulePatchParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobSchedulePatchParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "put": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Update", + "x-ms-examples": { + "JobSchedule update": { + "$ref": "./examples/JobScheduleUpdate.json" + } + }, + "summary": "Updates the properties of the specified Job Schedule.", + "description": "This fully replaces all the updatable properties of the Job Schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job Schedule to update." + }, + { + "name": "jobScheduleUpdateParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobScheduleUpdateParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobschedules/{jobScheduleId}/disable": { + "post": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Disable", + "x-ms-examples": { + "JobSchedule disable": { + "$ref": "./examples/JobScheduleDisable.json" + } + }, + "summary": "Disables a Job Schedule.", + "description": "No new Jobs will be created until the Job Schedule is enabled again.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job Schedule to disable." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobschedules/{jobScheduleId}/enable": { + "post": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Enable", + "x-ms-examples": { + "JobSchedule enable": { + "$ref": "./examples/JobScheduleEnable.json" + } + }, + "summary": "Enables a Job Schedule.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job Schedule to enable." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobschedules/{jobScheduleId}/terminate": { + "post": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Terminate", + "x-ms-examples": { + "JobSchedule terminate": { + "$ref": "./examples/JobScheduleTerminate.json" + } + }, + "summary": "Terminates a Job Schedule.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job Schedule to terminates." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobschedules": { + "post": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Add", + "x-ms-examples": { + "Add a basic JobSchedule": { + "$ref": "./examples/JobScheduleAdd_Basic.json" + }, + "Add a complex JobScheduleAdd": { + "$ref": "./examples/JobScheduleAdd_Complex.json" + } + }, + "summary": "Adds a Job Schedule to the specified Account.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "cloudJobSchedule", + "in": "body", + "description": "The Job Schedule to be added.", + "required": true, + "schema": { + "$ref": "#/definitions/JobScheduleAddParameter" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "JobSchedules" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "JobSchedule_List", + "x-ms-examples": { + "JobSchedule list": { + "$ref": "./examples/JobScheduleList.json" + } + }, + "summary": "Lists all of the Job Schedules in the specified Account.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-schedules.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 Job Schedules can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of Job Schedules.", + "schema": { + "$ref": "#/definitions/CloudJobScheduleListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}": { + "delete": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Delete", + "x-ms-examples": { + "Delete Job": { + "$ref": "./examples/JobDelete.json" + } + }, + "summary": "Deletes a Job.", + "description": "Deleting a Job also deletes all Tasks that are part of that Job, and all Job statistics. This also overrides the retention period for Task data; that is, if the Job contains Tasks which are still retained on Compute Nodes, the Batch services deletes those Tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the Job to the deleting state. All update operations on a Job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the Job is being deleted.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job to delete." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Get", + "x-ms-examples": { + "Job get": { + "$ref": "./examples/JobGet.json" + } + }, + "summary": "Gets information about the specified Job.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the Job.", + "schema": { + "$ref": "#/definitions/CloudJob" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "patch": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Patch", + "x-ms-examples": { + "Job patch": { + "$ref": "./examples/JobPatch.json" + } + }, + "summary": "Updates the properties of the specified Job.", + "description": "This replaces only the Job properties specified in the request. For example, if the Job has constraints, and a request does not specify the constraints element, then the Job keeps the existing constraints.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job whose properties you want to update." + }, + { + "name": "jobPatchParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobPatchParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "put": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Update", + "x-ms-examples": { + "Job update": { + "$ref": "./examples/JobUpdate.json" + } + }, + "summary": "Updates the properties of the specified Job.", + "description": "This fully replaces all the updatable properties of the Job. For example, if the Job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job whose properties you want to update." + }, + { + "name": "jobUpdateParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobUpdateParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/disable": { + "post": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Disable", + "x-ms-examples": { + "Job disable": { + "$ref": "./examples/JobDisable.json" + } + }, + "summary": "Disables the specified Job, preventing new Tasks from running.", + "description": "The Batch Service immediately moves the Job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running Tasks of the Job. The Job remains in the disabling state until the disable operation is completed and all Tasks have been dealt with according to the disableTasks option; the Job then moves to the disabled state. No new Tasks are started under the Job until it moves back to active state. If you try to disable a Job that is in any state other than active, disabling, or disabled, the request fails with status code 409.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job to disable." + }, + { + "name": "jobDisableParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobDisableParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/enable": { + "post": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Enable", + "x-ms-examples": { + "Job enable": { + "$ref": "./examples/JobEnable.json" + } + }, + "summary": "Enables the specified Job, allowing new Tasks to run.", + "description": "When you call this API, the Batch service sets a disabled Job to the enabling state. After the this operation is completed, the Job moves to the active state, and scheduling of new Tasks under the Job resumes. The Batch service does not allow a Task to remain in the active state for more than 180 days. Therefore, if you enable a Job containing active Tasks which were added more than 180 days ago, those Tasks will not run.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job to enable." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/terminate": { + "post": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Terminate", + "x-ms-examples": { + "Job terminate": { + "$ref": "./examples/JobTerminate.json" + } + }, + "summary": "Terminates the specified Job, marking it as completed.", + "description": "When a Terminate Job request is received, the Batch service sets the Job to the terminating state. The Batch service then terminates any running Tasks associated with the Job and runs any required Job release Tasks. Then the Job moves into the completed state. If there are any Tasks in the Job in the active state, they will remain in the active state. Once a Job is terminated, new Tasks cannot be added and any remaining active Tasks will not be scheduled.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job to terminate." + }, + { + "name": "jobTerminateParameter", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/JobTerminateParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs": { + "post": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Add", + "x-ms-examples": { + "Add a basic job": { + "$ref": "./examples/JobAdd_Basic.json" + }, + "Add a complex job": { + "$ref": "./examples/JobAdd_Complex.json" + } + }, + "summary": "Adds a Job to the specified Account.", + "description": "The Batch service supports two ways to control the work done as part of a Job. In the first approach, the user specifies a Job Manager Task. The Batch service launches this Task when it is ready to start the Job. The Job Manager Task controls all other Tasks that run under this Job, by using the Task APIs. In the second approach, the user directly controls the execution of Tasks under an active Job, by using the Task APIs. Also note: when naming Jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "job", + "in": "body", + "description": "The Job to be added.", + "required": true, + "schema": { + "$ref": "#/definitions/JobAddParameter" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Jobs" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Job_List", + "x-ms-examples": { + "Job list": { + "$ref": "./examples/JobList.json" + } + }, + "summary": "Lists all of the Jobs in the specified Account.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 Jobs can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of Jobs.", + "schema": { + "$ref": "#/definitions/CloudJobListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobschedules/{jobScheduleId}/jobs": { + "get": { + "tags": [ + "Jobs" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "x-ms-examples": { + "List Job Under Job Schedule": { + "$ref": "./examples/JobListFromJobSchedule.json" + } + }, + "operationId": "Job_ListFromJobSchedule", + "summary": "Lists the Jobs that have been created under the specified Job Schedule.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job Schedule from which you want to get a list of Jobs." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 Jobs can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of Jobs.", + "schema": { + "$ref": "#/definitions/CloudJobListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/jobpreparationandreleasetaskstatus": { + "get": { + "tags": [ + "Jobs" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Job_ListPreparationAndReleaseTaskStatus", + "x-ms-examples": { + "Job list preparation and release task status": { + "$ref": "./examples/JobListPreparationAndReleaseTaskStatus.json" + } + }, + "summary": "Lists the execution status of the Job Preparation and Job Release Task for the specified Job across the Compute Nodes where the Job has run.", + "description": "This API returns the Job Preparation and Job Release Task status on all Compute Nodes that have run the Job Preparation or Job Release Task. This includes Compute Nodes which have since been removed from the Pool. If this API is invoked on a Job which has no Job Preparation or Job Release Task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 Tasks can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing a list of Job Preparation and Job Release Task statuses.", + "schema": { + "$ref": "#/definitions/CloudJobListPreparationAndReleaseTaskStatusResult" + } + }, + "default": { + "description": "The error from the Batch service. If this API is invoked on a Job which has no Job Preparation or Job Release Task, the Batch service returns HTTP status code 409.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/taskcounts": { + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Job_GetTaskCounts", + "x-ms-examples": { + "Job get task counts": { + "$ref": "./examples/JobGetTaskCounts.json" + } + }, + "summary": "Gets the Task counts for the specified Job.", + "description": "Task counts provide a count of the Tasks by active, running or completed Task state, and a count of Tasks which succeeded or failed. Tasks in the preparing state are counted as running. Note that the numbers returned may not always be up to date. If you need exact task counts, use a list query.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + } + }, + "description": "A response containing the Task counts for the specified Job.", + "schema": { + "$ref": "#/definitions/TaskCountsResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools": { + "post": { + "tags": [ + "Pools" + ], + "operationId": "Pool_Add", + "x-ms-examples": { + "Add a CloudServiceConfiguration pool": { + "$ref": "./examples/PoolAdd_CloudServiceConfiguration.json" + }, + "Add a VirtualMachineConfiguration pool": { + "$ref": "./examples/PoolAdd_VirtualMachineConfiguration.json" + }, + "Add a VirtualMachineConfiguration pool with containers": { + "$ref": "./examples/PoolAdd_VirtualMachineConfigurationWithContainers.json" + }, + "Add a pool with mount drive specified": { + "$ref": "./examples/PoolAdd_MountConfiguration.json" + } + }, + "summary": "Adds a Pool to the specified Account.", + "description": "When naming Pools, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "pool", + "in": "body", + "description": "The Pool to be added.", + "required": true, + "schema": { + "$ref": "#/definitions/PoolAddParameter" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Pools" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Pool_List", + "x-ms-examples": { + "Pool list": { + "$ref": "./examples/PoolList_Basic.json" + } + }, + "summary": "Lists all of the Pools in the specified Account.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-pools.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 Pools can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of Pools.", + "schema": { + "$ref": "#/definitions/CloudPoolListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}": { + "delete": { + "tags": [ + "Pools" + ], + "operationId": "Pool_Delete", + "x-ms-examples": { + "Pool delete": { + "$ref": "./examples/PoolDelete.json" + } + }, + "summary": "Deletes a Pool from the specified Account.", + "description": "When you request that a Pool be deleted, the following actions occur: the Pool state is set to deleting; any ongoing resize operation on the Pool are stopped; the Batch service starts resizing the Pool to zero Compute Nodes; any Tasks running on existing Compute Nodes are terminated and requeued (as if a resize Pool operation had been requested with the default requeue option); finally, the Pool is removed from the system. Because running Tasks are requeued, the user can rerun these Tasks by updating their Job to target a different Pool. The Tasks can then run on the new Pool. If you want to override the requeue behavior, then you should call resize Pool explicitly to shrink the Pool to zero size before deleting the Pool. If you call an Update, Patch or Delete API on a Pool in the deleting state, it will fail with HTTP status code 409 with error code PoolBeingDeleted.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool to delete." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "head": { + "tags": [ + "Pools" + ], + "operationId": "Pool_Exists", + "x-ms-examples": { + "Check Pool Exists": { + "$ref": "./examples/PoolExists.json" + } + }, + "description": "Gets basic properties of a Pool.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool to get." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing headers related to the Pool, if it exists." + }, + "404": { + "description": "The Pool does not exist." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Pools" + ], + "operationId": "Pool_Get", + "x-ms-examples": { + "Pool get": { + "$ref": "./examples/PoolGet_Basic.json" + } + }, + "description": "Gets information about the specified Pool.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool to get." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the Pool.", + "schema": { + "$ref": "#/definitions/CloudPool" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "patch": { + "tags": [ + "Pools" + ], + "operationId": "Pool_Patch", + "x-ms-examples": { + "Patch the Pool": { + "$ref": "./examples/PoolPatch.json" + } + }, + "summary": "Updates the properties of the specified Pool.", + "description": "This only replaces the Pool properties specified in the request. For example, if the Pool has a StartTask associated with it, and a request does not specify a StartTask element, then the Pool keeps the existing StartTask.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool to update." + }, + { + "name": "poolPatchParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PoolPatchParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/disableautoscale": { + "post": { + "tags": [ + "Pools" + ], + "operationId": "Pool_DisableAutoScale", + "x-ms-examples": { + "Disable pool autoscale": { + "$ref": "./examples/PoolDisableAutoScale.json" + } + }, + "summary": "Disables automatic scaling for a Pool.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool on which to disable automatic scaling." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/enableautoscale": { + "post": { + "tags": [ + "Pools" + ], + "operationId": "Pool_EnableAutoScale", + "x-ms-examples": { + "Pool enable autoscale": { + "$ref": "./examples/PoolEnableAutoscale.json" + } + }, + "summary": "Enables automatic scaling for a Pool.", + "description": "You cannot enable automatic scaling on a Pool if a resize operation is in progress on the Pool. If automatic scaling of the Pool is currently disabled, you must specify a valid autoscale formula as part of the request. If automatic scaling of the Pool is already enabled, you may specify a new autoscale formula and/or a new evaluation interval. You cannot call this API for the same Pool more than once every 30 seconds.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool on which to enable automatic scaling." + }, + { + "name": "poolEnableAutoScaleParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PoolEnableAutoScaleParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/evaluateautoscale": { + "post": { + "tags": [ + "Pools" + ], + "operationId": "Pool_EvaluateAutoScale", + "x-ms-examples": { + "Pool evaluate autoscale": { + "$ref": "./examples/PoolEvaluateAutoscale.json" + } + }, + "summary": "Gets the result of evaluating an automatic scaling formula on the Pool.", + "description": "This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the Pool. The Pool must have auto scaling enabled in order to evaluate a formula.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool on which to evaluate the automatic scaling formula." + }, + { + "name": "poolEvaluateAutoScaleParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PoolEvaluateAutoScaleParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "A response containing the results of the autoscale evaluation.", + "schema": { + "$ref": "#/definitions/AutoScaleRun" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/resize": { + "post": { + "tags": [ + "Pools" + ], + "operationId": "Pool_Resize", + "x-ms-examples": { + "Pool resize": { + "$ref": "./examples/PoolResize.json" + } + }, + "summary": "Changes the number of Compute Nodes that are assigned to a Pool.", + "description": "You can only resize a Pool when its allocation state is steady. If the Pool is already resizing, the request fails with status code 409. When you resize a Pool, the Pool's allocation state changes from steady to resizing. You cannot resize Pools which are configured for automatic scaling. If you try to do this, the Batch service returns an error 409. If you resize a Pool downwards, the Batch service chooses which Compute Nodes to remove. To remove specific Compute Nodes, use the Pool remove Compute Nodes API instead.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool to resize." + }, + { + "name": "poolResizeParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PoolResizeParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/stopresize": { + "post": { + "tags": [ + "Pools" + ], + "operationId": "Pool_StopResize", + "x-ms-examples": { + "Pool stop resize": { + "$ref": "./examples/PoolStopResize.json" + } + }, + "summary": "Stops an ongoing resize operation on the Pool.", + "description": "This does not restore the Pool to its previous state before the resize operation: it only stops any further changes being made, and the Pool maintains its current state. After stopping, the Pool stabilizes at the number of Compute Nodes it was at when the stop operation was done. During the stop operation, the Pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize Pool request; this API can also be used to halt the initial sizing of the Pool when it is created.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool whose resizing you want to stop." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service. If you call this API on a Pool which is not in the resizing state, the request fails with HTTP status code 409.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/updateproperties": { + "post": { + "tags": [ + "Pools" + ], + "operationId": "Pool_UpdateProperties", + "x-ms-examples": { + "Pool update": { + "$ref": "./examples/PoolUpdate.json" + } + }, + "summary": "Updates the properties of the specified Pool.", + "description": "This fully replaces all the updatable properties of the Pool. For example, if the Pool has a StartTask associated with it and if StartTask is not specified with this request, then the Batch service will remove the existing StartTask.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool to update." + }, + { + "name": "poolUpdatePropertiesParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PoolUpdatePropertiesParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/removenodes": { + "post": { + "tags": [ + "ComputeNodes" + ], + "operationId": "Pool_RemoveNodes", + "x-ms-examples": { + "Pool remove nodes": { + "$ref": "./examples/PoolRemoveNodes.json" + } + }, + "summary": "Removes Compute Nodes from the specified Pool.", + "description": "This operation can only run when the allocation state of the Pool is steady. When this operation runs, the allocation state changes from steady to resizing.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool from which you want to remove Compute Nodes." + }, + { + "name": "nodeRemoveParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NodeRemoveParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/tasks": { + "post": { + "tags": [ + "Tasks" + ], + "operationId": "Task_Add", + "x-ms-examples": { + "Add a basic task": { + "$ref": "./examples/TaskAdd_Basic.json" + }, + "Add a task with exit conditions": { + "$ref": "./examples/TaskAdd_ExitConditions.json" + }, + "Add a task with container settings": { + "$ref": "./examples/TaskAdd_ContainerSettings.json" + }, + "Add a task with extra slot requirement": { + "$ref": "./examples/TaskAdd_RequiredSlots.json" + } + }, + "summary": "Adds a Task to the specified Job.", + "description": "The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job to which the Task is to be added." + }, + { + "name": "task", + "in": "body", + "description": "The Task to be added.", + "required": true, + "schema": { + "$ref": "#/definitions/TaskAddParameter" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Tasks" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Task_List", + "x-ms-examples": { + "Task list": { + "$ref": "./examples/TaskList.json" + } + }, + "summary": "Lists all of the Tasks that are associated with the specified Job.", + "description": "For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 Tasks can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of Tasks.", + "schema": { + "$ref": "#/definitions/CloudTaskListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/addtaskcollection": { + "post": { + "tags": [ + "Tasks" + ], + "operationId": "Task_AddCollection", + "x-ms-examples": { + "Add a basic collection of tasks": { + "$ref": "./examples/TaskAddCollection_Basic.json" + }, + "Add a complex collection of tasks": { + "$ref": "./examples/TaskAddCollection_Complex.json" + } + }, + "summary": "Adds a collection of Tasks to the specified Job.", + "description": "Note that each Task must have a unique ID. The Batch service may not return the results for each Task in the same order the Tasks were submitted in this request. If the server times out or the connection is closed during the request, the request may have been partially or fully processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same Task IDs during a retry so that if the prior operation succeeded, the retry will not create extra Tasks unexpectedly. If the response contains any Tasks which failed to add, a client can retry the request. In a retry, it is most efficient to resubmit only Tasks that failed to add, and to omit Tasks that were successfully added on the first attempt. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job to which the Task collection is to be added." + }, + { + "name": "taskCollection", + "in": "body", + "description": "The Tasks to be added.", + "required": true, + "schema": { + "$ref": "#/definitions/TaskAddCollectionParameter" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/TaskAddCollectionResult" + }, + "description": "A response containing the results of the add Task collection operation." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}": { + "delete": { + "tags": [ + "Tasks" + ], + "operationId": "Task_Delete", + "x-ms-examples": { + "Task delete": { + "$ref": "./examples/TaskDelete.json" + } + }, + "summary": "Deletes a Task from the specified Job.", + "description": "When a Task is deleted, all of the files in its directory on the Compute Node where it ran are also deleted (regardless of the retention time). For multi-instance Tasks, the delete Task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job from which to delete the Task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Task to delete." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Tasks" + ], + "operationId": "Task_Get", + "x-ms-examples": { + "Task get": { + "$ref": "./examples/TaskGet.json" + } + }, + "summary": "Gets information about the specified Task.", + "description": "For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job that contains the Task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Task to get information about." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "A response containing the Task.", + "schema": { + "$ref": "#/definitions/CloudTask" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "put": { + "tags": [ + "Tasks" + ], + "operationId": "Task_Update", + "x-ms-examples": { + "Task update": { + "$ref": "./examples/TaskUpdate.json" + } + }, + "description": "Updates the properties of the specified Task.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job containing the Task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Task to update." + }, + { + "name": "taskUpdateParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TaskUpdateParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}/subtasksinfo": { + "get": { + "tags": [ + "Tasks" + ], + "operationId": "Task_ListSubtasks", + "x-ms-examples": { + "Task list subtasks": { + "$ref": "./examples/TaskListSubtasks.json" + } + }, + "summary": "Lists all of the subtasks that are associated with the specified multi-instance Task.", + "description": "If the Task is not a multi-instance Task then this returns an empty collection.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Task." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of subtasks.", + "schema": { + "$ref": "#/definitions/CloudTaskListSubtasksResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}/terminate": { + "post": { + "tags": [ + "Tasks" + ], + "operationId": "Task_Terminate", + "x-ms-examples": { + "Task terminate": { + "$ref": "./examples/TaskTerminate.json" + } + }, + "summary": "Terminates the specified Task.", + "description": "When the Task has been terminated, it moves to the completed state. For multi-instance Tasks, the terminate Task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job containing the Task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Task to terminate." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}/reactivate": { + "post": { + "tags": [ + "Tasks" + ], + "operationId": "Task_Reactivate", + "x-ms-examples": { + "Task reactivate": { + "$ref": "./examples/TaskReactivate.json" + } + }, + "summary": "Reactivates a Task, allowing it to run again even if its retry count has been exhausted.", + "description": "Reactivation makes a Task eligible to be retried again up to its maximum retry count. The Task's state is changed to active. As the Task is no longer in the completed state, any previous exit code or failure information is no longer available after reactivation. Each time a Task is reactivated, its retry count is reset to 0. Reactivation will fail for Tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, it will fail if the Job has completed (or is terminating or deleting).", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Job containing the Task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Task to reactivate." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/users": { + "post": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_AddUser", + "x-ms-examples": { + "Node add user": { + "$ref": "./examples/NodeAddUser.json" + } + }, + "summary": "Adds a user Account to the specified Compute Node.", + "description": "You can add a user Account to a Compute Node only when it is in the idle or running state.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the machine on which you want to create a user Account." + }, + { + "name": "user", + "in": "body", + "description": "The user Account to be created.", + "required": true, + "schema": { + "$ref": "#/definitions/ComputeNodeUser" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/users/{userName}": { + "delete": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_DeleteUser", + "x-ms-examples": { + "Node delete user": { + "$ref": "./examples/NodeDeleteUser.json" + } + }, + "summary": "Deletes a user Account from the specified Compute Node.", + "description": "You can delete a user Account to a Compute Node only when it is in the idle or running state.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the machine on which you want to delete a user Account." + }, + { + "name": "userName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the user Account to delete." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "put": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_UpdateUser", + "x-ms-examples": { + "Node update user": { + "$ref": "./examples/NodeUpdateUser.json" + } + }, + "summary": "Updates the password and expiration time of a user Account on the specified Compute Node.", + "description": "This operation replaces of all the updatable properties of the Account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user Account on a Compute Node only when it is in the idle or running state.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the machine on which you want to update a user Account." + }, + { + "name": "userName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the user Account to update." + }, + { + "name": "nodeUpdateUserParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NodeUpdateUserParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}": { + "get": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_Get", + "x-ms-examples": { + "Node get": { + "$ref": "./examples/NodeGet_Basic.json" + } + }, + "summary": "Gets information about the specified Compute Node.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node that you want to get information about." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the Compute Node.", + "schema": { + "$ref": "#/definitions/ComputeNode" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/reboot": { + "post": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_Reboot", + "x-ms-examples": { + "Node reboot": { + "$ref": "./examples/NodeReboot.json" + } + }, + "summary": "Restarts the specified Compute Node.", + "description": "You can restart a Compute Node only if it is in an idle or running state.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node that you want to restart." + }, + { + "name": "nodeRebootParameter", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/NodeRebootParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/reimage": { + "post": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_Reimage", + "x-ms-examples": { + "Node reimage": { + "$ref": "./examples/NodeReimage.json" + } + }, + "summary": "Reinstalls the operating system on the specified Compute Node.", + "description": "You can reinstall the operating system on a Compute Node only if it is in an idle or running state. This API can be invoked only on Pools created with the cloud service configuration property.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node that you want to restart." + }, + { + "name": "nodeReimageParameter", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/NodeReimageParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/disablescheduling": { + "post": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_DisableScheduling", + "x-ms-examples": { + "Node disable scheduling": { + "$ref": "./examples/NodeDisableScheduling.json" + } + }, + "summary": "Disables Task scheduling on the specified Compute Node.", + "description": "You can disable Task scheduling on a Compute Node only if its current scheduling state is enabled.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node on which you want to disable Task scheduling." + }, + { + "name": "nodeDisableSchedulingParameter", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/NodeDisableSchedulingParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/enablescheduling": { + "post": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_EnableScheduling", + "x-ms-examples": { + "Node enable scheduling": { + "$ref": "./examples/NodeEnableScheduling.json" + } + }, + "summary": "Enables Task scheduling on the specified Compute Node.", + "description": "You can enable Task scheduling on a Compute Node only if its current scheduling state is disabled", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node on which you want to enable Task scheduling." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/remoteloginsettings": { + "get": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_GetRemoteLoginSettings", + "x-ms-examples": { + "Node get remote login settings": { + "$ref": "./examples/NodeGetRemoteLoginSettings.json" + } + }, + "summary": "Gets the settings required for remote login to a Compute Node.", + "description": "Before you can remotely login to a Compute Node using the remote login settings, you must create a user Account on the Compute Node. This API can be invoked only on Pools created with the virtual machine configuration property. For Pools created with a cloud service configuration, see the GetRemoteDesktop API.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node for which to obtain the remote login settings." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the login settings.", + "schema": { + "$ref": "#/definitions/ComputeNodeGetRemoteLoginSettingsResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/rdp": { + "get": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_GetRemoteDesktop", + "x-ms-examples": { + "Get RDP file of the compute node": { + "$ref": "./examples/NodeGetRemoteDesktop.json" + } + }, + "summary": "Gets the Remote Desktop Protocol file for the specified Compute Node.", + "description": "Before you can access a Compute Node by using the RDP file, you must create a user Account on the Compute Node. This API can only be invoked on Pools created with a cloud service configuration. For Pools created with a virtual machine configuration, see the GetRemoteLoginSettings API.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node for which you want to get the Remote Desktop Protocol file." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json", + "application/octet-stream" + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the RDP information.", + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs": { + "post": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_UploadBatchServiceLogs", + "summary": "Upload Azure Batch service log files from the specified Compute Node to Azure Blob Storage.", + "description": "This is for gathering Azure Batch service log files in an automated fashion from Compute Nodes if you are experiencing an error and wish to escalate to Azure support. The Azure Batch service log files should be shared with Azure support to aid in debugging issues with the Batch service.", + "x-ms-examples": { + "Upload BatchService Logs": { + "$ref": "./examples/NodeUploadBatchServiceLogs.json" + } + }, + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool that contains the Compute Node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Compute Node from which you want to upload the Azure Batch service log files." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "uploadBatchServiceLogsConfiguration", + "in": "body", + "description": "The Azure Batch service log files upload configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/UploadBatchServiceLogsConfiguration" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + } + }, + "description": "The request to the Batch service was successful.", + "schema": { + "$ref": "#/definitions/UploadBatchServiceLogsResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes": { + "get": { + "tags": [ + "ComputeNodes" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "ComputeNode_List", + "x-ms-examples": { + "Node list": { + "$ref": "./examples/NodeList.json" + } + }, + "summary": "Lists the Compute Nodes in the specified Pool.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Pool from which you want to list Compute Nodes." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 Compute Nodes can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of Compute Nodes.", + "schema": { + "$ref": "#/definitions/ComputeNodeListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + } + }, + "definitions": { + "PoolUsageMetrics": { + "properties": { + "poolId": { + "type": "string", + "title": "The ID of the Pool whose metrics are aggregated in this entry." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the aggregation interval covered by this entry." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The end time of the aggregation interval covered by this entry." + }, + "vmSize": { + "type": "string", + "title": "The size of virtual machines in the Pool. All VMs in a Pool are the same size.", + "description": "For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)." + }, + "totalCoreHours": { + "type": "number", + "format": "double", + "title": "The total core hours used in the Pool during this aggregation interval." + } + }, + "required": [ + "poolId", + "startTime", + "endTime", + "vmSize", + "totalCoreHours" + ], + "title": "Usage metrics for a Pool across an aggregation interval." + }, + "PoolListUsageMetricsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PoolUsageMetrics" + }, + "title": "The Pool usage metrics data." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of a listing the usage metrics for an Account." + }, + "ImageInformation": { + "properties": { + "nodeAgentSKUId": { + "type": "string", + "title": "The ID of the Compute Node agent SKU which the Image supports." + }, + "imageReference": { + "$ref": "#/definitions/ImageReference", + "title": "The reference to the Azure Virtual Machine's Marketplace Image." + }, + "osType": { + "type": "string", + "title": "The type of operating system (e.g. Windows or Linux) of the Image.", + "enum": [ + "linux", + "windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": false, + "values": [ + { + "value": "linux", + "description": "The Linux operating system." + }, + { + "value": "windows", + "description": "The Windows operating system." + } + ] + } + }, + "capabilities": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The capabilities or features which the Image supports.", + "description": "Not every capability of the Image is listed. Capabilities in this list are considered of special interest and are generally related to integration with other features in the Azure Batch service." + }, + "batchSupportEndOfLife": { + "type": "string", + "format": "date-time", + "title": "The time when the Azure Batch service will stop accepting create Pool requests for the Image." + }, + "verificationType": { + "type": "string", + "title": "Whether the Azure Batch service actively verifies that the Image is compatible with the associated Compute Node agent SKU.", + "enum": [ + "verified", + "unverified" + ], + "x-ms-enum": { + "name": "VerificationType", + "modelAsString": false, + "values": [ + { + "value": "verified", + "description": "The Image is guaranteed to be compatible with the associated Compute Node agent SKU and all Batch features have been confirmed to work as expected." + }, + { + "value": "unverified", + "description": "The associated Compute Node agent SKU should have binary compatibility with the Image, but specific functionality has not been verified." + } + ] + } + } + }, + "required": [ + "imageReference", + "verificationType", + "osType", + "nodeAgentSKUId" + ], + "title": "A reference to the Azure Virtual Machines Marketplace Image and additional information about the Image." + }, + "AuthenticationTokenSettings": { + "properties": { + "access": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false, + "enum": [ + "job" + ], + "x-ms-enum": { + "name": "AccessScope", + "modelAsString": false, + "values": [ + { + "value": "job", + "description": "Grants access to perform all operations on the Job containing the Task." + } + ] + } + }, + "title": "The Batch resources to which the token grants access.", + "description": "The authentication token grants access to a limited set of Batch service operations. Currently the only supported value for the access property is 'job', which grants access to all operations related to the Job which contains the Task." + } + }, + "title": "The settings for an authentication token that the Task can use to perform Batch service operations." + }, + "AccountListSupportedImagesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageInformation" + }, + "title": "The list of supported Virtual Machine Images." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the supported Virtual Machine Images." + }, + "UsageStatistics": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "dedicatedCoreTime": { + "type": "string", + "format": "duration", + "title": "The aggregated wall-clock time of the dedicated Compute Node cores being part of the Pool." + } + }, + "required": [ + "startTime", + "lastUpdateTime", + "dedicatedCoreTime" + ], + "title": "Statistics related to Pool usage information." + }, + "ResourceStatistics": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "avgCPUPercentage": { + "type": "number", + "format": "double", + "title": "The average CPU usage across all Compute Nodes in the Pool (percentage per node)." + }, + "avgMemoryGiB": { + "type": "number", + "format": "double", + "title": "The average memory usage in GiB across all Compute Nodes in the Pool." + }, + "peakMemoryGiB": { + "type": "number", + "format": "double", + "title": "The peak memory usage in GiB across all Compute Nodes in the Pool." + }, + "avgDiskGiB": { + "type": "number", + "format": "double", + "title": "The average used disk space in GiB across all Compute Nodes in the Pool." + }, + "peakDiskGiB": { + "type": "number", + "format": "double", + "title": "The peak used disk space in GiB across all Compute Nodes in the Pool." + }, + "diskReadIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk read operations across all Compute Nodes in the Pool." + }, + "diskWriteIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk write operations across all Compute Nodes in the Pool." + }, + "diskReadGiB": { + "type": "number", + "format": "double", + "title": "The total amount of data in GiB of disk reads across all Compute Nodes in the Pool." + }, + "diskWriteGiB": { + "type": "number", + "format": "double", + "title": "The total amount of data in GiB of disk writes across all Compute Nodes in the Pool." + }, + "networkReadGiB": { + "type": "number", + "format": "double", + "title": "The total amount of data in GiB of network reads across all Compute Nodes in the Pool." + }, + "networkWriteGiB": { + "type": "number", + "format": "double", + "title": "The total amount of data in GiB of network writes across all Compute Nodes in the Pool." + } + }, + "required": [ + "startTime", + "lastUpdateTime", + "avgCPUPercentage", + "avgMemoryGiB", + "peakMemoryGiB", + "avgDiskGiB", + "peakDiskGiB", + "diskReadIOps", + "diskWriteIOps", + "diskReadGiB", + "diskWriteGiB", + "networkReadGiB", + "networkWriteGiB" + ], + "title": "Statistics related to resource consumption by Compute Nodes in a Pool." + }, + "PoolStatistics": { + "properties": { + "url": { + "type": "string", + "title": "The URL for the statistics." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "usageStats": { + "$ref": "#/definitions/UsageStatistics", + "title": "Statistics related to Pool usage, such as the amount of core-time used." + }, + "resourceStats": { + "$ref": "#/definitions/ResourceStatistics", + "title": "Statistics related to resource consumption by Compute Nodes in the Pool." + } + }, + "required": [ + "url", + "startTime", + "lastUpdateTime" + ], + "title": "Contains utilization and resource usage statistics for the lifetime of a Pool." + }, + "JobStatistics": { + "properties": { + "url": { + "type": "string", + "title": "The URL of the statistics." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "userCPUTime": { + "type": "string", + "format": "duration", + "title": "The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job." + }, + "kernelCPUTime": { + "type": "string", + "format": "duration", + "title": "The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job." + }, + "wallClockTime": { + "type": "string", + "format": "duration", + "title": "The total wall clock time of all Tasks in the Job.", + "description": " The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If a Task was retried, this includes the wall clock time of all the Task retries." + }, + "readIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk read operations made by all Tasks in the Job." + }, + "writeIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk write operations made by all Tasks in the Job." + }, + "readIOGiB": { + "type": "number", + "format": "double", + "title": "The total amount of data in GiB read from disk by all Tasks in the Job." + }, + "writeIOGiB": { + "type": "number", + "format": "double", + "title": "The total amount of data in GiB written to disk by all Tasks in the Job." + }, + "numSucceededTasks": { + "type": "integer", + "format": "int64", + "title": "The total number of Tasks successfully completed in the Job during the given time range.", + "description": "A Task completes successfully if it returns exit code 0." + }, + "numFailedTasks": { + "type": "integer", + "format": "int64", + "title": "The total number of Tasks in the Job that failed during the given time range.", + "description": "A Task fails if it exhausts its maximum retry count without returning exit code 0." + }, + "numTaskRetries": { + "type": "integer", + "format": "int64", + "title": "The total number of retries on all the Tasks in the Job during the given time range." + }, + "waitTime": { + "type": "string", + "format": "duration", + "title": "The total wait time of all Tasks in the Job.", + "description": "The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.) This value is only reported in the Account lifetime statistics; it is not included in the Job statistics." + } + }, + "required": [ + "url", + "startTime", + "lastUpdateTime", + "userCPUTime", + "kernelCPUTime", + "wallClockTime", + "readIOps", + "writeIOps", + "readIOGiB", + "writeIOGiB", + "numSucceededTasks", + "numFailedTasks", + "numTaskRetries", + "waitTime" + ], + "title": "Resource usage statistics for a Job." + }, + "NameValuePair": { + "properties": { + "name": { + "type": "string", + "title": "The name in the name-value pair." + }, + "value": { + "type": "string", + "title": "The value in the name-value pair." + } + }, + "title": "Represents a name-value pair." + }, + "DeleteCertificateError": { + "properties": { + "code": { + "type": "string", + "title": "An identifier for the Certificate deletion error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "title": "A message describing the Certificate deletion error, intended to be suitable for display in a user interface." + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "title": "A list of additional error details related to the Certificate deletion error.", + "description": "This list includes details such as the active Pools and Compute Nodes referencing this Certificate. However, if a large number of resources reference the Certificate, the list contains only about the first hundred." + } + }, + "title": "An error encountered by the Batch service when deleting a Certificate." + }, + "Certificate": { + "properties": { + "thumbprint": { + "type": "string", + "title": "The X.509 thumbprint of the Certificate. This is a sequence of up to 40 hex digits." + }, + "thumbprintAlgorithm": { + "type": "string", + "title": "The algorithm used to derive the thumbprint." + }, + "url": { + "type": "string", + "title": "The URL of the Certificate." + }, + "state": { + "title": "The current state of the Certificate.", + "$ref": "#/definitions/CertificateState" + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Certificate entered its current state." + }, + "previousState": { + "title": "The previous state of the Certificate.", + "description": "This property is not set if the Certificate is in its initial active state.", + "$ref": "#/definitions/CertificateState" + }, + "previousStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Certificate entered its previous state.", + "description": "This property is not set if the Certificate is in its initial Active state." + }, + "publicData": { + "type": "string", + "title": "The public part of the Certificate as a base-64 encoded .cer file." + }, + "deleteCertificateError": { + "$ref": "#/definitions/DeleteCertificateError", + "title": "The error that occurred on the last attempt to delete this Certificate.", + "description": "This property is set only if the Certificate is in the DeleteFailed state." + } + }, + "description": "A Certificate that can be installed on Compute Nodes and can be used to authenticate operations on the machine." + }, + "ApplicationPackageReference": { + "properties": { + "applicationId": { + "type": "string", + "title": "The ID of the application to deploy." + }, + "version": { + "type": "string", + "title": "The version of the application to deploy. If omitted, the default version is deployed.", + "description": "If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error." + } + }, + "required": [ + "applicationId" + ], + "title": "A reference to an Package to be deployed to Compute Nodes." + }, + "ApplicationSummary": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the application within the Account." + }, + "displayName": { + "type": "string", + "title": "The display name for the application." + }, + "versions": { + "type": "array", + "title": "The list of available versions of the application.", + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "displayName", + "versions" + ], + "title": "Contains information about an application in an Azure Batch Account." + }, + "CertificateAddParameter": { + "properties": { + "thumbprint": { + "type": "string", + "title": "The X.509 thumbprint of the Certificate. This is a sequence of up to 40 hex digits (it may include spaces but these are removed)." + }, + "thumbprintAlgorithm": { + "type": "string", + "title": "The algorithm used to derive the thumbprint. This must be sha1." + }, + "data": { + "type": "string", + "title": "The base64-encoded contents of the Certificate. The maximum size is 10KB." + }, + "certificateFormat": { + "type": "string", + "title": "The format of the Certificate data.", + "enum": [ + "pfx", + "cer" + ], + "x-ms-enum": { + "name": "CertificateFormat", + "modelAsString": false, + "values": [ + { + "value": "pfx", + "description": "The Certificate is a PFX (PKCS#12) formatted Certificate or Certificate chain." + }, + { + "value": "cer", + "description": "The Certificate is a base64-encoded X.509 Certificate." + } + ] + } + }, + "password": { + "type": "string", + "title": "The password to access the Certificate's private key.", + "description": "This must be omitted if the Certificate format is cer." + } + }, + "required": [ + "thumbprint", + "thumbprintAlgorithm", + "data" + ], + "title": "A Certificate that can be installed on Compute Nodes and can be used to authenticate operations on the machine." + }, + "CertificateListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Certificate" + }, + "title": "The list of Certificates." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the Certificates in the Account." + }, + "FileProperties": { + "properties": { + "creationTime": { + "type": "string", + "format": "date-time", + "title": "The file creation time.", + "description": "The creation time is not returned for files on Linux Compute Nodes." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "title": "The time at which the file was last modified." + }, + "contentLength": { + "type": "integer", + "format": "int64", + "title": "The length of the file." + }, + "contentType": { + "type": "string", + "title": "The content type of the file." + }, + "fileMode": { + "type": "string", + "title": "The file mode attribute in octal format.", + "description": "The file mode is returned only for files on Linux Compute Nodes." + } + }, + "required": [ + "lastModified", + "contentLength" + ], + "title": "The properties of a file on a Compute Node." + }, + "NodeFile": { + "properties": { + "name": { + "type": "string", + "title": "The file path." + }, + "url": { + "type": "string", + "title": "The URL of the file." + }, + "isDirectory": { + "type": "boolean", + "title": "Whether the object represents a directory." + }, + "properties": { + "$ref": "#/definitions/FileProperties", + "title": "The file properties." + } + }, + "title": "Information about a file or directory on a Compute Node." + }, + "NodeFileListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeFile" + }, + "title": "The list of files." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the files on a Compute Node, or the files associated with a Task on a Compute Node." + }, + "Schedule": { + "properties": { + "doNotRunUntil": { + "type": "string", + "format": "date-time", + "title": "The earliest time at which any Job may be created under this Job Schedule.", + "description": "If you do not specify a doNotRunUntil time, the schedule becomes ready to create Jobs immediately." + }, + "doNotRunAfter": { + "type": "string", + "format": "date-time", + "title": "A time after which no Job will be created under this Job Schedule. The schedule will move to the completed state as soon as this deadline is past and there is no active Job under this Job Schedule.", + "description": "If you do not specify a doNotRunAfter time, and you are creating a recurring Job Schedule, the Job Schedule will remain active until you explicitly terminate it." + }, + "startWindow": { + "type": "string", + "format": "duration", + "title": "The time interval, starting from the time at which the schedule indicates a Job should be created, within which a Job must be created.", + "description": "If a Job is not created within the startWindow interval, then the 'opportunity' is lost; no Job will be created until the next recurrence of the schedule. If the schedule is recurring, and the startWindow is longer than the recurrence interval, then this is equivalent to an infinite startWindow, because the Job that is 'due' in one recurrenceInterval is not carried forward into the next recurrence interval. The default is infinite. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "recurrenceInterval": { + "type": "string", + "format": "duration", + "title": "The time interval between the start times of two successive Jobs under the Job Schedule. A Job Schedule can have at most one active Job under it at any given time.", + "description": "Because a Job Schedule can have at most one active Job under it at any given time, if it is time to create a new Job under a Job Schedule, but the previous Job is still running, the Batch service will not create the new Job until the previous Job finishes. If the previous Job does not finish within the startWindow period of the new recurrenceInterval, then no new Job will be scheduled for that interval. For recurring Jobs, you should normally specify a jobManagerTask in the jobSpecification. If you do not use jobManagerTask, you will need an external process to monitor when Jobs are created, add Tasks to the Jobs and terminate the Jobs ready for the next recurrence. The default is that the schedule does not recur: one Job is created, within the startWindow after the doNotRunUntil time, and the schedule is complete as soon as that Job finishes. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + } + }, + "title": "The schedule according to which Jobs will be created" + }, + "JobConstraints": { + "properties": { + "maxWallClockTime": { + "type": "string", + "format": "duration", + "title": "The maximum elapsed time that the Job may run, measured from the time the Job is created.", + "description": "If the Job does not complete within the time limit, the Batch service terminates it and any Tasks that are still running. In this case, the termination reason will be MaxWallClockTimeExpiry. If this property is not specified, there is no time limit on how long the Job may run." + }, + "maxTaskRetryCount": { + "type": "integer", + "format": "int32", + "title": "The maximum number of times each Task may be retried. The Batch service retries a Task if its exit code is nonzero.", + "description": "Note that this value specifically controls the number of retries. The Batch service will try each Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries a Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry Tasks. If the maximum retry count is -1, the Batch service retries Tasks without limit. The default value is 0 (no retries)." + } + }, + "title": "The execution constraints for a Job." + }, + "JobNetworkConfiguration": { + "properties": { + "subnetId": { + "type": "string", + "title": "The ARM resource identifier of the virtual network subnet which Compute Nodes running Tasks from the Job will join for the duration of the Task. This will only work with a VirtualMachineConfiguration Pool.", + "description": "The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes which will run Tasks from the Job. This can be up to the number of Compute Nodes in the Pool. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet so that Azure Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication from the Azure Batch service. For Pools created with a Virtual Machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Port 443 is also required to be open for outbound connections for communications to Azure Storage. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration", + "externalDocs": { + "url": "https://azure.microsoft.com/en-us/documentation/articles/role-based-access-built-in-roles/#classic-virtual-machine-contributor", + "description": "Setting up RBAC for Azure Batch VNETs" + } + } + }, + "required": [ + "subnetId" + ], + "title": "The network configuration for the Job." + }, + "TaskContainerSettings": { + "properties": { + "containerRunOptions": { + "type": "string", + "title": "Additional options to the container create command.", + "description": "These additional options are supplied as arguments to the \"docker create\" command, in addition to those controlled by the Batch Service." + }, + "imageName": { + "type": "string", + "title": "The Image to use to create the container in which the Task will run.", + "description": "This is the full Image reference, as would be specified to \"docker pull\". If no tag is provided as part of the Image name, the tag \":latest\" is used as a default." + }, + "registry": { + "$ref": "#/definitions/ContainerRegistry", + "title": "The private registry which contains the container Image.", + "description": "This setting can be omitted if was already provided at Pool creation." + }, + "workingDirectory": { + "type": "string", + "title": "The location of the container Task working directory.", + "description": "The default is 'taskWorkingDirectory'.", + "enum": [ + "taskWorkingDirectory", + "containerImageDefault" + ], + "x-ms-enum": { + "name": "ContainerWorkingDirectory", + "modelAsString": false, + "values": [ + { + "value": "taskWorkingDirectory", + "description": "Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch." + }, + { + "value": "containerImageDefault", + "description": "Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch." + } + ] + } + } + }, + "required": [ + "imageName" + ], + "title": "The container settings for a Task." + }, + "ResourceFile": { + "properties": { + "autoStorageContainerName": { + "type": "string", + "title": "The storage container name in the auto storage Account.", + "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified." + }, + "storageContainerUrl": { + "type": "string", + "title": "The URL of the blob container within Azure Blob Storage.", + "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading blobs from the container. There are two ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, or set the ACL for the container to allow public access." + }, + "httpUrl": { + "type": "string", + "title": "The URL of the file to download.", + "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access." + }, + "blobPrefix": { + "type": "string", + "title": "The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded.", + "description": "The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded." + }, + "filePath": { + "type": "string", + "title": "The location on the Compute Node to which to download the file(s), relative to the Task's working directory.", + "description": "If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the Task's working directory (for example by using '..')." + }, + "fileMode": { + "type": "string", + "title": "The file permission mode attribute in octal format.", + "description": "This property applies only to files being downloaded to Linux Compute Nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows Compute Node. If this property is not specified for a Linux Compute Node, then a default value of 0770 is applied to the file." + } + }, + "title": "A single file or multiple files to be downloaded to a Compute Node." + }, + "EnvironmentSetting": { + "properties": { + "name": { + "type": "string", + "title": "The name of the environment variable." + }, + "value": { + "type": "string", + "title": "The value of the environment variable." + } + }, + "required": [ + "name" + ], + "title": "An environment variable to be set on a Task process." + }, + "ExitConditions": { + "properties": { + "exitCodes": { + "type": "array", + "items": { + "$ref": "#/definitions/ExitCodeMapping" + }, + "title": "A list of individual Task exit codes and how the Batch service should respond to them." + }, + "exitCodeRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/ExitCodeRangeMapping" + }, + "title": "A list of Task exit code ranges and how the Batch service should respond to them." + }, + "preProcessingError": { + "$ref": "#/definitions/ExitOptions", + "title": "How the Batch service should respond if the Task fails to start due to an error." + }, + "fileUploadError": { + "$ref": "#/definitions/ExitOptions", + "title": "How the Batch service should respond if a file upload error occurs.", + "description": "If the Task exited with an exit code that was specified via exitCodes or exitCodeRanges, and then encountered a file upload error, then the action specified by the exit code takes precedence." + }, + "default": { + "$ref": "#/definitions/ExitOptions", + "title": "How the Batch service should respond if the Task fails with an exit condition not covered by any of the other properties.", + "description": "This value is used if the Task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection." + } + }, + "title": "Specifies how the Batch service should respond when the Task completes." + }, + "ExitCodeMapping": { + "properties": { + "code": { + "type": "integer", + "format": "int32", + "title": "A process exit code." + }, + "exitOptions": { + "$ref": "#/definitions/ExitOptions", + "title": "How the Batch service should respond if the Task exits with this exit code." + } + }, + "title": "How the Batch service should respond if a Task exits with a particular exit code.", + "required": [ + "code", + "exitOptions" + ] + }, + "ExitCodeRangeMapping": { + "properties": { + "start": { + "type": "integer", + "format": "int32", + "title": "The first exit code in the range." + }, + "end": { + "type": "integer", + "format": "int32", + "title": "The last exit code in the range." + }, + "exitOptions": { + "$ref": "#/definitions/ExitOptions", + "title": "How the Batch service should respond if the Task exits with an exit code in the range start to end (inclusive)." + } + }, + "title": "A range of exit codes and how the Batch service should respond to exit codes within that range.", + "required": [ + "start", + "end", + "exitOptions" + ] + }, + "ExitOptions": { + "properties": { + "jobAction": { + "type": "string", + "title": "An action to take on the Job containing the Task, if the Task completes with the given exit condition and the Job's onTaskFailed property is 'performExitOptionsJobAction'.", + "description": "The default is none for exit code 0 and terminate for all other exit conditions. If the Job's onTaskFailed property is noaction, then specifying this property returns an error and the add Task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", + "enum": [ + "none", + "disable", + "terminate" + ], + "x-ms-enum": { + "name": "JobAction", + "modelAsString": false, + "values": [ + { + "value": "none", + "description": "Take no action." + }, + { + "value": "disable", + "description": "Disable the Job. This is equivalent to calling the disable Job API, with a disableTasks value of requeue." + }, + { + "value": "terminate", + "description": "Terminate the Job. The terminateReason in the Job's executionInfo is set to \"TaskFailed\"." + } + ] + } + }, + "dependencyAction": { + "type": "string", + "title": "An action that the Batch service performs on Tasks that depend on this Task.", + "description": "Possible values are 'satisfy' (allowing dependent tasks to progress) and 'block' (dependent tasks continue to wait). Batch does not yet support cancellation of dependent tasks.", + "enum": [ + "satisfy", + "block" + ], + "x-ms-enum": { + "name": "DependencyAction", + "modelAsString": false, + "values": [ + { + "value": "satisfy", + "description": "Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled to run." + }, + { + "value": "block", + "description": "Blocks tasks waiting on this task, preventing them from being scheduled." + } + ] + } + } + }, + "title": "Specifies how the Batch service responds to a particular exit condition." + }, + "AutoUserSpecification": { + "properties": { + "scope": { + "type": "string", + "title": "The scope for the auto user", + "description": "The default value is pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by StartTasks.", + "enum": [ + "task", + "pool" + ], + "x-ms-enum": { + "name": "AutoUserScope", + "modelAsString": false, + "values": [ + { + "value": "task", + "description": "Specifies that the service should create a new user for the Task." + }, + { + "value": "pool", + "description": "Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool." + } + ] + } + }, + "elevationLevel": { + "title": "The elevation level of the auto user.", + "description": "The default value is nonAdmin.", + "$ref": "#/definitions/ElevationLevel" + } + }, + "title": "Specifies the parameters for the auto user that runs a Task on the Batch service." + }, + "UserIdentity": { + "properties": { + "username": { + "type": "string", + "x-ms-client-name": "userName", + "title": "The name of the user identity under which the Task is run.", + "description": "The userName and autoUser properties are mutually exclusive; you must specify one but not both." + }, + "autoUser": { + "$ref": "#/definitions/AutoUserSpecification", + "title": "The auto user under which the Task is run.", + "description": "The userName and autoUser properties are mutually exclusive; you must specify one but not both." + } + }, + "title": "The definition of the user identity under which the Task is run.", + "description": "Specify either the userName or autoUser property, but not both." + }, + "LinuxUserConfiguration": { + "properties": { + "uid": { + "type": "integer", + "format": "int32", + "title": "The user ID of the user Account.", + "description": "The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid." + }, + "gid": { + "type": "integer", + "format": "int32", + "title": "The group ID for the user Account.", + "description": "The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid." + }, + "sshPrivateKey": { + "type": "string", + "title": "The SSH private key for the user Account.", + "description": "The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between Compute Nodes in a Linux Pool when the Pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between Compute Nodes (no modification of the user's .ssh directory is done)." + } + }, + "title": "Properties used to create a user Account on a Linux Compute Node." + }, + "WindowsUserConfiguration": { + "properties": { + "loginMode": { + "type": "string", + "title": "The login mode for the user", + "description": "The default value for VirtualMachineConfiguration Pools is 'batch' and for CloudServiceConfiguration Pools is 'interactive'.", + "enum": [ + "batch", + "interactive" + ], + "x-ms-enum": { + "name": "LoginMode", + "modelAsString": false, + "values": [ + { + "value": "batch", + "description": "The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes." + }, + { + "value": "interactive", + "description": "The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled on Windows VirtualMachineConfiguration Pools. If this option is used with an elevated user identity in a Windows VirtualMachineConfiguration Pool, the user session will not be elevated unless the application executed by the Task command line is configured to always require administrative privilege or to always require maximum privilege." + } + ] + } + } + }, + "title": "Properties used to create a user Account on a Windows Compute Node." + }, + "UserAccount": { + "properties": { + "name": { + "type": "string", + "title": "The name of the user Account." + }, + "password": { + "type": "string", + "title": "The password for the user Account." + }, + "elevationLevel": { + "title": "The elevation level of the user Account.", + "description": "The default value is nonAdmin.", + "$ref": "#/definitions/ElevationLevel" + }, + "linuxUserConfiguration": { + "title": "The Linux-specific user configuration for the user Account.", + "description": "This property is ignored if specified on a Windows Pool. If not specified, the user is created with the default options.", + "$ref": "#/definitions/LinuxUserConfiguration" + }, + "windowsUserConfiguration": { + "title": "The Windows-specific user configuration for the user Account.", + "description": "This property can only be specified if the user is on a Windows Pool. If not specified and on a Windows Pool, the user is created with the default options.", + "$ref": "#/definitions/WindowsUserConfiguration" + } + }, + "required": [ + "name", + "password" + ], + "title": "Properties used to create a user used to execute Tasks on an Azure Batch Compute Node." + }, + "TaskConstraints": { + "properties": { + "maxWallClockTime": { + "type": "string", + "format": "duration", + "title": "The maximum elapsed time that the Task may run, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it.", + "description": "If this is not specified, there is no time limit on how long the Task may run." + }, + "retentionTime": { + "type": "string", + "format": "duration", + "title": "The minimum time to retain the Task directory on the Compute Node where it ran, from the time it completes execution. After this time, the Batch service may delete the Task directory and all its contents.", + "description": "The default is 7 days, i.e. the Task directory will be retained for 7 days unless the Compute Node is removed or the Job is deleted." + }, + "maxTaskRetryCount": { + "type": "integer", + "format": "int32", + "title": "The maximum number of times the Task may be retried. The Batch service retries a Task if its exit code is nonzero.", + "description": "Note that this value specifically controls the number of retries for the Task executable due to a nonzero exit code. The Batch service will try the Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the Task after the first attempt. If the maximum retry count is -1, the Batch service retries the Task without limit." + } + }, + "title": "Execution constraints to apply to a Task." + }, + "JobManagerTask": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the Job Manager Task within the Job.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters." + }, + "displayName": { + "type": "string", + "title": "The display name of the Job Manager Task.", + "description": "It need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "commandLine": { + "type": "string", + "title": "The command line of the Job Manager Task.", + "description": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the Job Manager Task runs.", + "description": "If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files." + }, + "resourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download to the Compute Node before running the command line.", + "description": "Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers." + }, + "outputFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFile" + }, + "title": "A list of files that the Batch service will upload from the Compute Node after running the command line.", + "description": "For multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed." + }, + "environmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of environment variable settings for the Job Manager Task." + }, + "constraints": { + "$ref": "#/definitions/TaskConstraints", + "title": "Constraints that apply to the Job Manager Task." + }, + "requiredSlots": { + "type": "integer", + "format": "int32", + "title": "The number of scheduling slots that the Task requires to run.", + "description": "The default is 1. A Task can only be scheduled to run on a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this must be 1." + }, + "killJobOnCompletion": { + "type": "boolean", + "title": "Whether completion of the Job Manager Task signifies completion of the entire Job.", + "description": "If true, when the Job Manager Task completes, the Batch service marks the Job as complete. If any Tasks are still running at this time (other than Job Release), those Tasks are terminated. If false, the completion of the Job Manager Task does not affect the Job status. In this case, you should either use the onAllTasksComplete attribute to terminate the Job, or have a client or user terminate the Job explicitly. An example of this is if the Job Manager creates a set of Tasks but then takes no further role in their execution. The default value is true. If you are using the onAllTasksComplete and onTaskFailure attributes to control Job lifetime, and using the Job Manager Task only to create the Tasks for the Job (not to monitor progress), then it is important to set killJobOnCompletion to false." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the Job Manager Task runs.", + "description": "If omitted, the Task runs as a non-administrative user unique to the Task." + }, + "runExclusive": { + "type": "boolean", + "title": "Whether the Job Manager Task requires exclusive use of the Compute Node where it runs.", + "description": "If true, no other Tasks will run on the same Node for as long as the Job Manager is running. If false, other Tasks can run simultaneously with the Job Manager on a Compute Node. The Job Manager Task counts normally against the Compute Node's concurrent Task limit, so this is only relevant if the Compute Node allows multiple concurrent Tasks. The default value is true." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "A list of Application Packages that the Batch service will deploy to the Compute Node before running the command line.", + "description": "Application Packages are downloaded and deployed to a shared directory, not the Task working directory. Therefore, if a referenced Application Package is already on the Compute Node, and is up to date, then it is not re-downloaded; the existing copy on the Compute Node is used. If a referenced Application Package cannot be installed, for example because the package has been deleted or because download failed, the Task fails." + }, + "authenticationTokenSettings": { + "title": "The settings for an authentication token that the Task can use to perform Batch service operations.", + "description": "If this property is set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job.", + "$ref": "#/definitions/AuthenticationTokenSettings" + }, + "allowLowPriorityNode": { + "type": "boolean", + "title": "Whether the Job Manager Task may run on a low-priority Compute Node.", + "description": "The default value is true." + } + }, + "required": [ + "id", + "commandLine" + ], + "title": "Specifies details of a Job Manager Task.", + "description": "The Job Manager Task is automatically started when the Job is created. The Batch service tries to schedule the Job Manager Task before any other Tasks in the Job. When shrinking a Pool, the Batch service tries to preserve Nodes where Job Manager Tasks are running for as long as possible (that is, Compute Nodes running 'normal' Tasks are removed before Compute Nodes running Job Manager Tasks). When a Job Manager Task fails and needs to be restarted, the system tries to schedule it at the highest priority. If there are no idle Compute Nodes available, the system may terminate one of the running Tasks in the Pool and return it to the queue in order to make room for the Job Manager Task to restart. Note that a Job Manager Task in one Job does not have priority over Tasks in other Jobs. Across Jobs, only Job level priorities are observed. For example, if a Job Manager in a priority 0 Job needs to be restarted, it will not displace Tasks of a priority 1 Job. Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing." + }, + "JobPreparationTask": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the Job Preparation Task within the Job.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other Task in the Job can have the same ID as the Job Preparation Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict)." + }, + "commandLine": { + "type": "string", + "title": "The command line of the Job Preparation Task.", + "description": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the Job Preparation Task runs.", + "description": "When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files." + }, + "resourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download to the Compute Node before running the command line.", + "description": "Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers." + }, + "environmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of environment variable settings for the Job Preparation Task." + }, + "constraints": { + "$ref": "#/definitions/TaskConstraints", + "title": "Constraints that apply to the Job Preparation Task." + }, + "waitForSuccess": { + "type": "boolean", + "title": "Whether the Batch service should wait for the Job Preparation Task to complete successfully before scheduling any other Tasks of the Job on the Compute Node. A Job Preparation Task has completed successfully if it exits with exit code 0.", + "description": "If true and the Job Preparation Task fails on a Node, the Batch service retries the Job Preparation Task up to its maximum retry count (as specified in the constraints element). If the Task has still not completed successfully after all retries, then the Batch service will not schedule Tasks of the Job to the Node. The Node remains active and eligible to run Tasks of other Jobs. If false, the Batch service will not wait for the Job Preparation Task to complete. In this case, other Tasks of the Job can start executing on the Compute Node while the Job Preparation Task is still running; and even if the Job Preparation Task fails, new Tasks will continue to be scheduled on the Compute Node. The default value is true." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the Job Preparation Task runs.", + "description": "If omitted, the Task runs as a non-administrative user unique to the Task on Windows Compute Nodes, or a non-administrative user unique to the Pool on Linux Compute Nodes." + }, + "rerunOnNodeRebootAfterSuccess": { + "type": "boolean", + "title": "Whether the Batch service should rerun the Job Preparation Task after a Compute Node reboots.", + "description": "The Job Preparation Task is always rerun if a Compute Node is reimaged, or if the Job Preparation Task did not complete (e.g. because the reboot occurred while the Task was running). Therefore, you should always write a Job Preparation Task to be idempotent and to behave correctly if run multiple times. The default value is true." + } + }, + "required": [ + "commandLine" + ], + "title": "A Job Preparation Task to run before any Tasks of the Job on any given Compute Node.", + "description": "You can use Job Preparation to prepare a Node to run Tasks for the Job. Activities commonly performed in Job Preparation include: Downloading common resource files used by all the Tasks in the Job. The Job Preparation Task can download these common resource files to the shared location on the Node. (AZ_BATCH_NODE_ROOT_DIR\\shared), or starting a local service on the Node so that all Tasks of that Job can communicate with it. If the Job Preparation Task fails (that is, exhausts its retry count before exiting with exit code 0), Batch will not run Tasks of this Job on the Node. The Compute Node remains ineligible to run Tasks of this Job until it is reimaged. The Compute Node remains active and can be used for other Jobs. The Job Preparation Task can run multiple times on the same Node. Therefore, you should write the Job Preparation Task to handle re-execution. If the Node is rebooted, the Job Preparation Task is run again on the Compute Node before scheduling any other Task of the Job, if rerunOnNodeRebootAfterSuccess is true or if the Job Preparation Task did not previously complete. If the Node is reimaged, the Job Preparation Task is run again before scheduling any Task of the Job. Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing." + }, + "JobReleaseTask": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the Job Release Task within the Job.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobrelease'. No other Task in the Job can have the same ID as the Job Release Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict)." + }, + "commandLine": { + "type": "string", + "title": "The command line of the Job Release Task.", + "description": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the Job Release Task runs.", + "description": "When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files." + }, + "resourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.", + "description": "Files listed under this element are located in the Task's working directory." + }, + "environmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of environment variable settings for the Job Release Task." + }, + "maxWallClockTime": { + "type": "string", + "format": "duration", + "title": "The maximum elapsed time that the Job Release Task may run on a given Compute Node, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. The default value is 15 minutes. You may not specify a timeout longer than 15 minutes. If you do, the Batch service rejects it with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "retentionTime": { + "type": "string", + "format": "duration", + "title": "The minimum time to retain the Task directory for the Job Release Task on the Compute Node. After this time, the Batch service may delete the Task directory and all its contents.", + "description": "The default is 7 days, i.e. the Task directory will be retained for 7 days unless the Compute Node is removed or the Job is deleted." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the Job Release Task runs.", + "description": "If omitted, the Task runs as a non-administrative user unique to the Task." + } + }, + "required": [ + "commandLine" + ], + "title": "A Job Release Task to run on Job completion on any Compute Node where the Job has run.", + "description": "The Job Release Task runs when the Job ends, because of one of the following: The user calls the Terminate Job API, or the Delete Job API while the Job is still active, the Job's maximum wall clock time constraint is reached, and the Job is still active, or the Job's Job Manager Task completed, and the Job is configured to terminate when the Job Manager completes. The Job Release Task runs on each Node where Tasks of the Job have run and the Job Preparation Task ran and completed. If you reimage a Node after it has run the Job Preparation Task, and the Job ends without any further Tasks of the Job running on that Node (and hence the Job Preparation Task does not re-run), then the Job Release Task does not run on that Compute Node. If a Node reboots while the Job Release Task is still running, the Job Release Task runs again when the Compute Node starts up. The Job is not marked as complete until all Job Release Tasks have completed. The Job Release Task runs in the background. It does not occupy a scheduling slot; that is, it does not count towards the taskSlotsPerNode limit specified on the Pool." + }, + "TaskSchedulingPolicy": { + "properties": { + "nodeFillType": { + "type": "string", + "title": "How Tasks are distributed across Compute Nodes in a Pool.", + "description": "If not specified, the default is spread.", + "enum": [ + "spread", + "pack" + ], + "x-ms-enum": { + "name": "ComputeNodeFillType", + "modelAsString": false, + "values": [ + { + "value": "spread", + "description": "Tasks should be assigned evenly across all Compute Nodes in the Pool." + }, + { + "value": "pack", + "description": "As many Tasks as possible (taskSlotsPerNode) should be assigned to each Compute Node in the Pool before any Tasks are assigned to the next Compute Node in the Pool." + } + ] + } + } + }, + "required": [ + "nodeFillType" + ], + "title": "Specifies how Tasks should be distributed across Compute Nodes." + }, + "StartTask": { + "properties": { + "commandLine": { + "type": "string", + "title": "The command line of the StartTask.", + "description": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the StartTask runs.", + "description": "When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files." + }, + "resourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.", + "description": "Files listed under this element are located in the Task's working directory." + }, + "environmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of environment variable settings for the StartTask." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the StartTask runs.", + "description": "If omitted, the Task runs as a non-administrative user unique to the Task." + }, + "maxTaskRetryCount": { + "type": "integer", + "format": "int32", + "title": "The maximum number of times the Task may be retried.", + "description": "The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the Task. If the maximum retry count is -1, the Batch service retries the Task without limit." + }, + "waitForSuccess": { + "type": "boolean", + "title": "Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node.", + "description": "If true and the StartTask fails on a Node, the Batch service retries the StartTask up to its maximum retry count (maxTaskRetryCount). If the Task has still not completed successfully after all retries, then the Batch service marks the Node unusable, and will not schedule Tasks to it. This condition can be detected via the Compute Node state and failure info details. If false, the Batch service will not wait for the StartTask to complete. In this case, other Tasks can start executing on the Compute Node while the StartTask is still running; and even if the StartTask fails, new Tasks will continue to be scheduled on the Compute Node. The default is true." + } + }, + "required": [ + "commandLine" + ], + "title": "A Task which is run when a Node joins a Pool in the Azure Batch service, or when the Compute Node is rebooted or reimaged.", + "description": "Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing. In some cases the StartTask may be re-run even though the Compute Node was not rebooted. Special care should be taken to avoid StartTasks which create breakaway process or install/launch services from the StartTask working directory, as this will block Batch from being able to re-run the StartTask." + }, + "CertificateReference": { + "properties": { + "thumbprint": { + "type": "string", + "title": "The thumbprint of the Certificate." + }, + "thumbprintAlgorithm": { + "type": "string", + "title": "The algorithm with which the thumbprint is associated. This must be sha1." + }, + "storeLocation": { + "type": "string", + "title": "The location of the Certificate store on the Compute Node into which to install the Certificate.", + "description": "The default value is currentuser. This property is applicable only for Pools configured with Windows Compute Nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows Image reference). For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory.", + "enum": [ + "currentuser", + "localmachine" + ], + "x-ms-enum": { + "name": "CertificateStoreLocation", + "modelAsString": false, + "values": [ + { + "value": "currentuser", + "description": "Certificates should be installed to the CurrentUser Certificate store.", + "name": "currentUser" + }, + { + "value": "localmachine", + "description": "Certificates should be installed to the LocalMachine Certificate store.", + "name": "localMachine" + } + ] + } + }, + "storeName": { + "type": "string", + "title": "The name of the Certificate store on the Compute Node into which to install the Certificate.", + "description": "This property is applicable only for Pools configured with Windows Compute Nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows Image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My." + }, + "visibility": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false, + "enum": [ + "starttask", + "task", + "remoteuser" + ], + "x-ms-enum": { + "name": "CertificateVisibility", + "modelAsString": false, + "values": [ + { + "value": "starttask", + "description": "The Certificate should be visible to the user account under which the StartTask is run. Note that if AutoUser Scope is Pool for both the StartTask and a Task, this certificate will be visible to the Task as well.", + "name": "startTask" + }, + { + "value": "task", + "description": "The Certificate should be visible to the user accounts under which Job Tasks are run." + }, + { + "value": "remoteuser", + "description": "The Certificate should be visible to the user accounts under which users remotely access the Compute Node.", + "name": "remoteUser" + } + ] + } + }, + "title": "Which user Accounts on the Compute Node should have access to the private data of the Certificate.", + "description": "You can specify more than one visibility in this collection. The default is all Accounts." + } + }, + "required": [ + "thumbprint", + "thumbprintAlgorithm" + ], + "title": "A reference to a Certificate to be installed on Compute Nodes in a Pool." + }, + "MetadataItem": { + "properties": { + "name": { + "type": "string", + "title": "The name of the metadata item." + }, + "value": { + "type": "string", + "title": "The value of the metadata item." + } + }, + "required": [ + "name", + "value" + ], + "title": "A name-value pair associated with a Batch service resource.", + "description": "The Batch service does not assign any meaning to this metadata; it is solely for the use of user code." + }, + "PoolSpecification": { + "properties": { + "displayName": { + "type": "string", + "title": "The display name for the Pool.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "vmSize": { + "type": "string", + "title": "The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size.", + "description": "For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)." + }, + "cloudServiceConfiguration": { + "$ref": "#/definitions/CloudServiceConfiguration", + "title": "The cloud service configuration for the Pool.", + "description": "This property must be specified if the Pool needs to be created with Azure PaaS VMs. This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. If neither is specified then the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). This property cannot be specified if the Batch Account was created with its poolAllocationMode property set to 'UserSubscription'." + }, + "virtualMachineConfiguration": { + "$ref": "#/definitions/VirtualMachineConfiguration", + "title": "The virtual machine configuration for the Pool.", + "description": "This property must be specified if the Pool needs to be created with Azure IaaS VMs. This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified. If neither is specified then the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "taskSlotsPerNode": { + "type": "integer", + "format": "int32", + "title": "The number of task slots that can be used to run concurrent tasks on a single compute node in the pool.", + "description": "The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256." + }, + "taskSchedulingPolicy": { + "$ref": "#/definitions/TaskSchedulingPolicy", + "title": "How Tasks are distributed across Compute Nodes in a Pool.", + "description": "If not specified, the default is spread." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for allocation of Compute Nodes to the Pool.", + "description": "This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of dedicated Compute Nodes in the Pool.", + "description": "This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of low-priority Compute Nodes in the Pool.", + "description": "This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both." + }, + "enableAutoScale": { + "type": "boolean", + "title": "Whether the Pool size should automatically adjust over time.", + "description": "If false, at least one of targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula element is required. The Pool automatically resizes according to the formula. The default value is false." + }, + "autoScaleFormula": { + "type": "string", + "title": "The formula for the desired number of Compute Nodes in the Pool.", + "description": "This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information." + }, + "autoScaleEvaluationInterval": { + "type": "string", + "format": "duration", + "title": "The time interval at which to automatically adjust the Pool size according to the autoscale formula.", + "description": "The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "enableInterNodeCommunication": { + "type": "boolean", + "title": "Whether the Pool permits direct communication between Compute Nodes.", + "description": "Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false." + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "title": "The network configuration for the Pool." + }, + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted." + }, + "certificateReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateReference" + }, + "title": "A list of Certificates to be installed on each Compute Node in the Pool.", + "description": "For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "The list of Packages to be installed on each Compute Node in the Pool.", + "description": "Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool." + }, + "applicationLicenses": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The list of application licenses the Batch service will make available on each Compute Node in the Pool.", + "description": "The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, Pool creation will fail. The permitted licenses available on the Pool are 'maya', 'vray', '3dsmax', 'arnold'. An additional charge applies for each application license added to the Pool." + }, + "userAccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/UserAccount" + }, + "title": "The list of user Accounts to be created on each Compute Node in the Pool." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the Pool as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + }, + "mountConfiguration": { + "type": "array", + "items": { + "$ref": "#/definitions/MountConfiguration" + }, + "title": "A list of file systems to mount on each node in the pool.", + "description": "This supports Azure Files, NFS, CIFS/SMB, and Blobfuse." + } + }, + "required": [ + "vmSize" + ], + "title": "Specification for creating a new Pool." + }, + "AutoPoolSpecification": { + "properties": { + "autoPoolIdPrefix": { + "type": "string", + "title": "A prefix to be added to the unique identifier when a Pool is automatically created.", + "description": "The Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long." + }, + "poolLifetimeOption": { + "type": "string", + "title": "The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools.", + "enum": [ + "jobschedule", + "job" + ], + "x-ms-enum": { + "name": "PoolLifetimeOption", + "modelAsString": false, + "values": [ + { + "value": "jobschedule", + "description": "The Pool exists for the lifetime of the Job Schedule. The Batch Service creates the Pool when it creates the first Job on the schedule. You may apply this option only to Job Schedules, not to Jobs.", + "name": "jobSchedule" + }, + { + "value": "job", + "description": "The Pool exists for the lifetime of the Job to which it is dedicated. The Batch service creates the Pool when it creates the Job. If the 'job' option is applied to a Job Schedule, the Batch service creates a new auto Pool for every Job created on the schedule." + } + ] + } + }, + "keepAlive": { + "type": "boolean", + "title": "Whether to keep an auto Pool alive after its lifetime expires.", + "description": "If false, the Batch service deletes the Pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option." + }, + "pool": { + "$ref": "#/definitions/PoolSpecification", + "title": "The Pool specification for the auto Pool." + } + }, + "required": [ + "poolLifetimeOption" + ], + "title": "Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted." + }, + "PoolInformation": { + "properties": { + "poolId": { + "type": "string", + "title": "The ID of an existing Pool. All the Tasks of the Job will run on the specified Pool.", + "description": "You must ensure that the Pool referenced by this property exists. If the Pool does not exist at the time the Batch service tries to schedule a Job, no Tasks for the Job will run until you create a Pool with that id. Note that the Batch service will not reject the Job request; it will simply not run Tasks until the Pool exists. You must specify either the Pool ID or the auto Pool specification, but not both." + }, + "autoPoolSpecification": { + "$ref": "#/definitions/AutoPoolSpecification", + "title": "Characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted.", + "description": "If auto Pool creation fails, the Batch service moves the Job to a completed state, and the Pool creation error is set in the Job's scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of the auto Pool. Any user actions that affect the lifetime of the auto Pool while the Job is active will result in unexpected behavior. You must specify either the Pool ID or the auto Pool specification, but not both." + } + }, + "title": "Specifies how a Job should be assigned to a Pool." + }, + "JobSpecification": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority of Jobs created under this schedule.", + "description": "Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. This priority is used as the default for all Jobs under the Job Schedule. You can update a Job's priority after it has been created using by using the update Job API." + }, + "displayName": { + "type": "string", + "title": "The display name for Jobs created under this schedule.", + "description": "The name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "usesTaskDependencies": { + "type": "boolean", + "title": "Whether Tasks in the Job can define dependencies on each other. The default is false." + }, + "onAllTasksComplete": { + "title": "The action the Batch service should take when all Tasks in a Job created under this schedule are in the completed state.", + "description": "Note that if a Job contains no Tasks, then all Tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic Job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the Job properties to set onAllTasksComplete to terminatejob once you have finished adding Tasks. The default is noaction.", + "$ref": "#/definitions/OnAllTasksComplete" + }, + "onTaskFailure": { + "title": "The action the Batch service should take when any Task fails in a Job created under this schedule. A Task is considered to have failed if it have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error.", + "description": "The default is noaction.", + "$ref": "#/definitions/OnTaskFailure" + }, + "networkConfiguration": { + "$ref": "#/definitions/JobNetworkConfiguration", + "title": "The network configuration for the Job." + }, + "constraints": { + "$ref": "#/definitions/JobConstraints", + "title": "The execution constraints for Jobs created under this schedule." + }, + "jobManagerTask": { + "$ref": "#/definitions/JobManagerTask", + "title": "The details of a Job Manager Task to be launched when a Job is started under this schedule.", + "description": "If the Job does not specify a Job Manager Task, the user must explicitly add Tasks to the Job using the Task API. If the Job does specify a Job Manager Task, the Batch service creates the Job Manager Task when the Job is created, and will try to schedule the Job Manager Task before scheduling other Tasks in the Job." + }, + "jobPreparationTask": { + "$ref": "#/definitions/JobPreparationTask", + "title": "The Job Preparation Task for Jobs created under this schedule.", + "description": "If a Job has a Job Preparation Task, the Batch service will run the Job Preparation Task on a Node before starting any Tasks of that Job on that Compute Node." + }, + "jobReleaseTask": { + "$ref": "#/definitions/JobReleaseTask", + "title": "The Job Release Task for Jobs created under this schedule.", + "description": "The primary purpose of the Job Release Task is to undo changes to Nodes made by the Job Preparation Task. Example activities include deleting local files, or shutting down services that were started as part of Job preparation. A Job Release Task cannot be specified without also specifying a Job Preparation Task for the Job. The Batch service runs the Job Release Task on the Compute Nodes that have run the Job Preparation Task." + }, + "commonEnvironmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of common environment variable settings. These environment variables are set for all Tasks in Jobs created under this schedule (including the Job Manager, Job Preparation and Job Release Tasks).", + "description": "Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value." + }, + "poolInfo": { + "$ref": "#/definitions/PoolInformation", + "title": "The Pool on which the Batch service runs the Tasks of Jobs created under this schedule." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with each Job created under this schedule as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + } + }, + "required": [ + "poolInfo" + ], + "title": "Specifies details of the Jobs to be created on a schedule." + }, + "RecentJob": { + "properties": { + "id": { + "type": "string", + "title": "The ID of the Job." + }, + "url": { + "type": "string", + "title": "The URL of the Job." + } + }, + "title": "Information about the most recent Job to run under the Job Schedule." + }, + "JobScheduleExecutionInformation": { + "properties": { + "nextRunTime": { + "type": "string", + "format": "date-time", + "title": "The next time at which a Job will be created under this schedule.", + "description": "This property is meaningful only if the schedule is in the active state when the time comes around. For example, if the schedule is disabled, no Job will be created at nextRunTime unless the Job is enabled before then." + }, + "recentJob": { + "$ref": "#/definitions/RecentJob", + "title": "Information about the most recent Job under the Job Schedule.", + "description": "This property is present only if the at least one Job has run under the schedule." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the schedule ended.", + "description": "This property is set only if the Job Schedule is in the completed state." + } + }, + "title": "Contains information about Jobs that have been and will be run under a Job Schedule." + }, + "JobScheduleStatistics": { + "properties": { + "url": { + "type": "string", + "title": "The URL of the statistics." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "userCPUTime": { + "type": "string", + "format": "duration", + "title": "The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in all Jobs created under the schedule." + }, + "kernelCPUTime": { + "type": "string", + "format": "duration", + "title": "The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in all Jobs created under the schedule." + }, + "wallClockTime": { + "type": "string", + "format": "duration", + "title": "The total wall clock time of all the Tasks in all the Jobs created under the schedule.", + "description": "The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If a Task was retried, this includes the wall clock time of all the Task retries." + }, + "readIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk read operations made by all Tasks in all Jobs created under the schedule." + }, + "writeIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk write operations made by all Tasks in all Jobs created under the schedule." + }, + "readIOGiB": { + "type": "number", + "format": "double", + "title": "The total gibibytes read from disk by all Tasks in all Jobs created under the schedule." + }, + "writeIOGiB": { + "type": "number", + "format": "double", + "title": "The total gibibytes written to disk by all Tasks in all Jobs created under the schedule." + }, + "numSucceededTasks": { + "type": "integer", + "format": "int64", + "title": "The total number of Tasks successfully completed during the given time range in Jobs created under the schedule. A Task completes successfully if it returns exit code 0." + }, + "numFailedTasks": { + "type": "integer", + "format": "int64", + "title": "The total number of Tasks that failed during the given time range in Jobs created under the schedule. A Task fails if it exhausts its maximum retry count without returning exit code 0." + }, + "numTaskRetries": { + "type": "integer", + "format": "int64", + "title": "The total number of retries during the given time range on all Tasks in all Jobs created under the schedule." + }, + "waitTime": { + "type": "string", + "format": "duration", + "title": "The total wait time of all Tasks in all Jobs created under the schedule. The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.)", + "description": "This value is only reported in the Account lifetime statistics; it is not included in the Job statistics." + } + }, + "required": [ + "url", + "startTime", + "lastUpdateTime", + "userCPUTime", + "kernelCPUTime", + "wallClockTime", + "readIOps", + "writeIOps", + "readIOGiB", + "writeIOGiB", + "numSucceededTasks", + "numFailedTasks", + "numTaskRetries", + "waitTime" + ], + "title": "Resource usage statistics for a Job Schedule." + }, + "CloudJobSchedule": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the schedule within the Account." + }, + "displayName": { + "type": "string", + "title": "The display name for the schedule." + }, + "url": { + "type": "string", + "title": "The URL of the Job Schedule." + }, + "eTag": { + "type": "string", + "title": "The ETag of the Job Schedule.", + "description": "This is an opaque string. You can use it to detect whether the Job Schedule has changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your changes should take effect only if nobody else has modified the schedule in the meantime." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "title": "The last modified time of the Job Schedule.", + "description": "This is the last time at which the schedule level data, such as the Job specification or recurrence information, changed. It does not factor in job-level changes such as new Jobs being created or Jobs changing state." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "title": "The creation time of the Job Schedule." + }, + "state": { + "title": "The current state of the Job Schedule.", + "$ref": "#/definitions/JobScheduleState" + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Job Schedule entered the current state." + }, + "previousState": { + "title": "The previous state of the Job Schedule.", + "description": "This property is not present if the Job Schedule is in its initial active state.", + "$ref": "#/definitions/JobScheduleState" + }, + "previousStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Job Schedule entered its previous state.", + "description": "This property is not present if the Job Schedule is in its initial active state." + }, + "schedule": { + "$ref": "#/definitions/Schedule", + "title": "The schedule according to which Jobs will be created." + }, + "jobSpecification": { + "$ref": "#/definitions/JobSpecification", + "title": "The details of the Jobs to be created on this schedule." + }, + "executionInfo": { + "$ref": "#/definitions/JobScheduleExecutionInformation", + "title": "Information about Jobs that have been and will be run under this schedule." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the schedule as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + }, + "stats": { + "$ref": "#/definitions/JobScheduleStatistics", + "title": "The lifetime resource usage statistics for the Job Schedule. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes." + } + }, + "title": "A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a specification used to create each Job." + }, + "JobScheduleAddParameter": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the schedule within the Account.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case)." + }, + "displayName": { + "type": "string", + "title": "The display name for the schedule.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "schedule": { + "$ref": "#/definitions/Schedule", + "title": "The schedule according to which Jobs will be created." + }, + "jobSpecification": { + "$ref": "#/definitions/JobSpecification", + "title": "The details of the Jobs to be created on this schedule." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the schedule as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + } + }, + "required": [ + "id", + "schedule", + "jobSpecification" + ], + "title": "A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a specification used to create each Job." + }, + "CloudJobScheduleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudJobSchedule" + }, + "title": "The list of Job Schedules." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the Job Schedules in an Account." + }, + "JobSchedulingError": { + "properties": { + "category": { + "title": "The category of the Job scheduling error.", + "$ref": "#/definitions/ErrorCategory" + }, + "code": { + "type": "string", + "title": "An identifier for the Job scheduling error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "title": "A message describing the Job scheduling error, intended to be suitable for display in a user interface." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "title": "A list of additional error details related to the scheduling error." + } + }, + "required": [ + "category" + ], + "title": "An error encountered by the Batch service when scheduling a Job." + }, + "JobExecutionInformation": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the Job.", + "description": "This is the time at which the Job was created." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The completion time of the Job.", + "description": "This property is set only if the Job is in the completed state." + }, + "poolId": { + "type": "string", + "title": "The ID of the Pool to which this Job is assigned.", + "description": "This element contains the actual Pool where the Job is assigned. When you get Job details from the service, they also contain a poolInfo element, which contains the Pool configuration data from when the Job was added or updated. That poolInfo element may also contain a poolId element. If it does, the two IDs are the same. If it does not, it means the Job ran on an auto Pool, and this property contains the ID of that auto Pool." + }, + "schedulingError": { + "$ref": "#/definitions/JobSchedulingError", + "title": "Details of any error encountered by the service in starting the Job.", + "description": "This property is not set if there was no error starting the Job." + }, + "terminateReason": { + "type": "string", + "title": "A string describing the reason the Job ended.", + "description": "This property is set only if the Job is in the completed state. If the Batch service terminates the Job, it sets the reason as follows: JMComplete - the Job Manager Task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the Job reached its maxWallClockTime constraint. TerminateJobSchedule - the Job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the Job's onAllTasksComplete attribute is set to terminatejob, and all Tasks in the Job are complete. TaskFailed - the Job's onTaskFailure attribute is set to performExitOptionsJobAction, and a Task in the Job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined reason specified in a call to the 'Terminate a Job' operation." + } + }, + "required": [ + "startTime" + ], + "title": "Contains information about the execution of a Job in the Azure Batch service." + }, + "CloudJob": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the Job within the Account.", + "description": "The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case)." + }, + "displayName": { + "type": "string", + "title": "The display name for the Job." + }, + "usesTaskDependencies": { + "type": "boolean", + "title": "Whether Tasks in the Job can define dependencies on each other. The default is false." + }, + "url": { + "type": "string", + "title": "The URL of the Job." + }, + "eTag": { + "type": "string", + "title": "The ETag of the Job.", + "description": "This is an opaque string. You can use it to detect whether the Job has changed between requests. In particular, you can be pass the ETag when updating a Job to specify that your changes should take effect only if nobody else has modified the Job in the meantime." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "title": "The last modified time of the Job.", + "description": "This is the last time at which the Job level data, such as the Job state or priority, changed. It does not factor in task-level changes such as adding new Tasks or Tasks changing state." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "title": "The creation time of the Job." + }, + "state": { + "title": "The current state of the Job.", + "$ref": "#/definitions/JobState" + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Job entered its current state." + }, + "previousState": { + "title": "The previous state of the Job.", + "description": "This property is not set if the Job is in its initial Active state.", + "$ref": "#/definitions/JobState" + }, + "previousStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Job entered its previous state.", + "description": "This property is not set if the Job is in its initial Active state." + }, + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority of the Job.", + "description": "Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0." + }, + "constraints": { + "$ref": "#/definitions/JobConstraints", + "title": "The execution constraints for the Job." + }, + "jobManagerTask": { + "$ref": "#/definitions/JobManagerTask", + "title": "Details of a Job Manager Task to be launched when the Job is started." + }, + "jobPreparationTask": { + "$ref": "#/definitions/JobPreparationTask", + "title": "The Job Preparation Task.", + "description": "The Job Preparation Task is a special Task run on each Compute Node before any other Task of the Job." + }, + "jobReleaseTask": { + "$ref": "#/definitions/JobReleaseTask", + "title": "The Job Release Task.", + "description": "The Job Release Task is a special Task run at the end of the Job on each Compute Node that has run any other Task of the Job." + }, + "commonEnvironmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "The list of common environment variable settings. These environment variables are set for all Tasks in the Job (including the Job Manager, Job Preparation and Job Release Tasks).", + "description": "Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value." + }, + "poolInfo": { + "$ref": "#/definitions/PoolInformation", + "title": "The Pool settings associated with the Job." + }, + "onAllTasksComplete": { + "title": "The action the Batch service should take when all Tasks in the Job are in the completed state.", + "description": "The default is noaction.", + "$ref": "#/definitions/OnAllTasksComplete" + }, + "onTaskFailure": { + "title": "The action the Batch service should take when any Task in the Job fails.", + "description": "A Task is considered to have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction.", + "$ref": "#/definitions/OnTaskFailure" + }, + "networkConfiguration": { + "$ref": "#/definitions/JobNetworkConfiguration", + "title": "The network configuration for the Job." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the Job as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + }, + "executionInfo": { + "$ref": "#/definitions/JobExecutionInformation", + "title": "The execution information for the Job." + }, + "stats": { + "$ref": "#/definitions/JobStatistics", + "title": "Resource usage statistics for the entire lifetime of the Job.", + "description": "This property is populated only if the CloudJob was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes." + } + }, + "title": "An Azure Batch Job." + }, + "JobAddParameter": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the Job within the Account.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case)." + }, + "displayName": { + "type": "string", + "title": "The display name for the Job.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority of the Job.", + "description": "Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0." + }, + "constraints": { + "$ref": "#/definitions/JobConstraints", + "description": "The execution constraints for the Job." + }, + "jobManagerTask": { + "$ref": "#/definitions/JobManagerTask", + "title": "Details of a Job Manager Task to be launched when the Job is started.", + "description": "If the Job does not specify a Job Manager Task, the user must explicitly add Tasks to the Job. If the Job does specify a Job Manager Task, the Batch service creates the Job Manager Task when the Job is created, and will try to schedule the Job Manager Task before scheduling other Tasks in the Job. The Job Manager Task's typical purpose is to control and/or monitor Job execution, for example by deciding what additional Tasks to run, determining when the work is complete, etc. (However, a Job Manager Task is not restricted to these activities - it is a fully-fledged Task in the system and perform whatever actions are required for the Job.) For example, a Job Manager Task might download a file specified as a parameter, analyze the contents of that file and submit additional Tasks based on those contents." + }, + "jobPreparationTask": { + "$ref": "#/definitions/JobPreparationTask", + "title": "The Job Preparation Task.", + "description": "If a Job has a Job Preparation Task, the Batch service will run the Job Preparation Task on a Node before starting any Tasks of that Job on that Compute Node." + }, + "jobReleaseTask": { + "$ref": "#/definitions/JobReleaseTask", + "title": "The Job Release Task.", + "description": "A Job Release Task cannot be specified without also specifying a Job Preparation Task for the Job. The Batch service runs the Job Release Task on the Nodes that have run the Job Preparation Task. The primary purpose of the Job Release Task is to undo changes to Compute Nodes made by the Job Preparation Task. Example activities include deleting local files, or shutting down services that were started as part of Job preparation." + }, + "commonEnvironmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "The list of common environment variable settings. These environment variables are set for all Tasks in the Job (including the Job Manager, Job Preparation and Job Release Tasks).", + "description": "Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value." + }, + "poolInfo": { + "$ref": "#/definitions/PoolInformation", + "title": "The Pool on which the Batch service runs the Job's Tasks." + }, + "onAllTasksComplete": { + "title": "The action the Batch service should take when all Tasks in the Job are in the completed state.", + "description": "Note that if a Job contains no Tasks, then all Tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic Job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the Job properties to set onAllTasksComplete to terminatejob once you have finished adding Tasks. The default is noaction.", + "$ref": "#/definitions/OnAllTasksComplete" + }, + "onTaskFailure": { + "title": "The action the Batch service should take when any Task in the Job fails.", + "description": "A Task is considered to have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction.", + "$ref": "#/definitions/OnTaskFailure" + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the Job as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + }, + "usesTaskDependencies": { + "type": "boolean", + "title": "Whether Tasks in the Job can define dependencies on each other. The default is false." + }, + "networkConfiguration": { + "$ref": "#/definitions/JobNetworkConfiguration", + "title": "The network configuration for the Job." + } + }, + "required": [ + "id", + "poolInfo" + ], + "title": "An Azure Batch Job to add." + }, + "CloudJobListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudJob" + }, + "title": "The list of Jobs." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the Jobs in an Account." + }, + "TaskContainerExecutionInformation": { + "properties": { + "containerId": { + "type": "string", + "title": "The ID of the container." + }, + "state": { + "type": "string", + "title": "The state of the container.", + "description": "This is the state of the container according to the Docker service. It is equivalent to the status field returned by \"docker inspect\"." + }, + "error": { + "type": "string", + "title": "Detailed error information about the container.", + "description": "This is the detailed error string from the Docker service, if available. It is equivalent to the error field returned by \"docker inspect\"." + } + }, + "title": "Contains information about the container which a Task is executing." + }, + "TaskFailureInformation": { + "properties": { + "category": { + "title": "The category of the Task error.", + "$ref": "#/definitions/ErrorCategory" + }, + "code": { + "type": "string", + "title": "An identifier for the Task error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "title": "A message describing the Task error, intended to be suitable for display in a user interface." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "title": "A list of additional details related to the error." + } + }, + "required": [ + "category" + ], + "title": "Information about a Task failure." + }, + "JobPreparationTaskExecutionInformation": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Task started running.", + "description": "If the Task has been restarted or retried, this is the most recent time at which the Task started running." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Job Preparation Task completed.", + "description": "This property is set only if the Task is in the Completed state." + }, + "state": { + "type": "string", + "title": "The current state of the Job Preparation Task on the Compute Node.", + "enum": [ + "running", + "completed" + ], + "x-ms-enum": { + "name": "JobPreparationTaskState", + "modelAsString": false, + "values": [ + { + "value": "running", + "description": "The Task is currently running (including retrying)." + }, + { + "value": "completed", + "description": "The Task has exited with exit code 0, or the Task has exhausted its retry limit, or the Batch service was unable to start the Task due to Task preparation errors (such as resource file download failures)." + } + ] + } + }, + "taskRootDirectory": { + "type": "string", + "title": "The root directory of the Job Preparation Task on the Compute Node. You can use this path to retrieve files created by the Task, such as log files." + }, + "taskRootDirectoryUrl": { + "type": "string", + "title": "The URL to the root directory of the Job Preparation Task on the Compute Node." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "title": "The exit code of the program specified on the Task command line.", + "description": "This parameter is returned only if the Task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the Compute Node operating system, such as when a process is forcibly terminated." + }, + "containerInfo": { + "$ref": "#/definitions/TaskContainerExecutionInformation", + "title": "Information about the container under which the Task is executing.", + "description": "This property is set only if the Task runs in a container context." + }, + "failureInfo": { + "$ref": "#/definitions/TaskFailureInformation", + "title": "Information describing the Task failure, if any.", + "description": "This property is set only if the Task is in the completed state and encountered a failure." + }, + "retryCount": { + "type": "integer", + "format": "int32", + "title": "The number of times the Task has been retried by the Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints.", + "description": "Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints." + }, + "lastRetryTime": { + "type": "string", + "format": "date-time", + "title": "The most recent time at which a retry of the Job Preparation Task started running.", + "description": "This property is set only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not." + }, + "result": { + "$ref": "#/definitions/TaskExecutionResult", + "title": "The result of the Task execution.", + "description": "If the value is 'failed', then the details of the failure can be found in the failureInfo property." + } + }, + "required": [ + "startTime", + "retryCount", + "state" + ], + "title": "Contains information about the execution of a Job Preparation Task on a Compute Node." + }, + "JobReleaseTaskExecutionInformation": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Task started running.", + "description": "If the Task has been restarted or retried, this is the most recent time at which the Task started running." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Job Release Task completed.", + "description": "This property is set only if the Task is in the Completed state." + }, + "state": { + "type": "string", + "title": "The current state of the Job Release Task on the Compute Node.", + "enum": [ + "running", + "completed" + ], + "x-ms-enum": { + "name": "JobReleaseTaskState", + "modelAsString": false, + "values": [ + { + "value": "running", + "description": "The Task is currently running (including retrying)." + }, + { + "value": "completed", + "description": "The Task has exited with exit code 0, or the Task has exhausted its retry limit, or the Batch service was unable to start the Task due to Task preparation errors (such as resource file download failures)." + } + ] + } + }, + "taskRootDirectory": { + "type": "string", + "title": "The root directory of the Job Release Task on the Compute Node. You can use this path to retrieve files created by the Task, such as log files." + }, + "taskRootDirectoryUrl": { + "type": "string", + "title": "The URL to the root directory of the Job Release Task on the Compute Node." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "title": "The exit code of the program specified on the Task command line.", + "description": "This parameter is returned only if the Task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the Compute Node operating system, such as when a process is forcibly terminated." + }, + "containerInfo": { + "$ref": "#/definitions/TaskContainerExecutionInformation", + "title": "Information about the container under which the Task is executing.", + "description": "This property is set only if the Task runs in a container context." + }, + "failureInfo": { + "$ref": "#/definitions/TaskFailureInformation", + "title": "Information describing the Task failure, if any.", + "description": "This property is set only if the Task is in the completed state and encountered a failure." + }, + "result": { + "$ref": "#/definitions/TaskExecutionResult", + "title": "The result of the Task execution.", + "description": "If the value is 'failed', then the details of the failure can be found in the failureInfo property." + } + }, + "required": [ + "startTime", + "state" + ], + "title": "Contains information about the execution of a Job Release Task on a Compute Node." + }, + "JobPreparationAndReleaseTaskExecutionInformation": { + "properties": { + "poolId": { + "type": "string", + "title": "The ID of the Pool containing the Compute Node to which this entry refers." + }, + "nodeId": { + "type": "string", + "title": "The ID of the Compute Node to which this entry refers." + }, + "nodeUrl": { + "type": "string", + "title": "The URL of the Compute Node to which this entry refers." + }, + "jobPreparationTaskExecutionInfo": { + "$ref": "#/definitions/JobPreparationTaskExecutionInformation", + "title": "Information about the execution status of the Job Preparation Task on this Compute Node." + }, + "jobReleaseTaskExecutionInfo": { + "$ref": "#/definitions/JobReleaseTaskExecutionInformation", + "title": "Information about the execution status of the Job Release Task on this Compute Node.", + "description": "This property is set only if the Job Release Task has run on the Compute Node." + } + }, + "title": "The status of the Job Preparation and Job Release Tasks on a Compute Node." + }, + "CloudJobListPreparationAndReleaseTaskStatusResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobPreparationAndReleaseTaskExecutionInformation" + }, + "title": "A list of Job Preparation and Job Release Task execution information." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the status of the Job Preparation and Job Release Tasks for a Job." + }, + "TaskCountsResult": { + "properties": { + "taskCounts": { + "$ref": "#/definitions/TaskCounts", + "title": "The number of Tasks per state." + }, + "taskSlotCounts": { + "$ref": "#/definitions/TaskSlotCounts", + "title": "The number of TaskSlots required by Tasks per state." + } + }, + "required": [ + "taskCounts", + "taskSlotCounts" + ], + "title": "The Task and TaskSlot counts for a Job." + }, + "TaskCounts": { + "properties": { + "active": { + "type": "integer", + "format": "int32", + "title": "The number of Tasks in the active state." + }, + "running": { + "type": "integer", + "format": "int32", + "title": "The number of Tasks in the running or preparing state." + }, + "completed": { + "type": "integer", + "format": "int32", + "title": "The number of Tasks in the completed state." + }, + "succeeded": { + "type": "integer", + "format": "int32", + "title": "The number of Tasks which succeeded. A Task succeeds if its result (found in the executionInfo property) is 'success'." + }, + "failed": { + "type": "integer", + "format": "int32", + "title": "The number of Tasks which failed. A Task fails if its result (found in the executionInfo property) is 'failure'." + } + }, + "required": [ + "active", + "running", + "completed", + "succeeded", + "failed" + ], + "title": "The Task counts for a Job." + }, + "TaskSlotCounts": { + "properties": { + "active": { + "type": "integer", + "format": "int32", + "title": "The number of TaskSlots for active Tasks." + }, + "running": { + "type": "integer", + "format": "int32", + "title": "The number of TaskSlots for running Tasks." + }, + "completed": { + "type": "integer", + "format": "int32", + "title": "The number of TaskSlots for completed Tasks." + }, + "succeeded": { + "type": "integer", + "format": "int32", + "title": "The number of TaskSlots for succeeded Tasks." + }, + "failed": { + "type": "integer", + "format": "int32", + "title": "The number of TaskSlots for failed Tasks." + } + }, + "required": [ + "active", + "running", + "completed", + "succeeded", + "failed" + ], + "title": "The TaskSlot counts for a Job." + }, + "AutoScaleRunError": { + "properties": { + "code": { + "type": "string", + "title": "An identifier for the autoscale error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "title": "A message describing the autoscale error, intended to be suitable for display in a user interface." + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "title": "A list of additional error details related to the autoscale error." + } + }, + "title": "An error that occurred when executing or evaluating a Pool autoscale formula." + }, + "AutoScaleRun": { + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "title": "The time at which the autoscale formula was last evaluated." + }, + "results": { + "type": "string", + "title": "The final values of all variables used in the evaluation of the autoscale formula.", + "description": "Each variable value is returned in the form $variable=value, and variables are separated by semicolons." + }, + "error": { + "$ref": "#/definitions/AutoScaleRunError", + "title": "Details of the error encountered evaluating the autoscale formula on the Pool, if the evaluation was unsuccessful." + } + }, + "required": [ + "timestamp" + ], + "title": "The results and errors from an execution of a Pool autoscale formula." + }, + "ResizeError": { + "properties": { + "code": { + "type": "string", + "title": "An identifier for the Pool resize error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "title": "A message describing the Pool resize error, intended to be suitable for display in a user interface." + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "title": "A list of additional error details related to the Pool resize error." + } + }, + "title": "An error that occurred when resizing a Pool." + }, + "CloudServiceConfiguration": { + "properties": { + "osFamily": { + "type": "string", + "title": "The Azure Guest OS family to be installed on the virtual machines in the Pool.", + "description": "Possible values are:\n2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1.\n3 - OS Family 3, equivalent to Windows Server 2012.\n4 - OS Family 4, equivalent to Windows Server 2012 R2.\n5 - OS Family 5, equivalent to Windows Server 2016.\n6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases)." + }, + "osVersion": { + "type": "string", + "title": "The Azure Guest OS version to be installed on the virtual machines in the Pool.", + "description": "The default value is * which specifies the latest operating system version for the specified OS family." + } + }, + "required": [ + "osFamily" + ], + "title": "The configuration for Compute Nodes in a Pool based on the Azure Cloud Services platform." + }, + "ImageReference": { + "properties": { + "publisher": { + "type": "string", + "title": "The publisher of the Azure Virtual Machines Marketplace Image.", + "description": "For example, Canonical or MicrosoftWindowsServer." + }, + "offer": { + "type": "string", + "title": "The offer type of the Azure Virtual Machines Marketplace Image.", + "description": "For example, UbuntuServer or WindowsServer." + }, + "sku": { + "type": "string", + "title": "The SKU of the Azure Virtual Machines Marketplace Image.", + "description": "For example, 18.04-LTS or 2019-Datacenter." + }, + "version": { + "type": "string", + "title": "The version of the Azure Virtual Machines Marketplace Image.", + "description": "A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'." + }, + "virtualMachineImageId": { + "type": "string", + "title": "The ARM resource identifier of the Shared Image Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version.", + "description": "This property is mutually exclusive with other ImageReference properties. The Shared Image Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration." + } + }, + "title": "A reference to an Azure Virtual Machines Marketplace Image or a Shared Image Gallery Image. To get the list of all Azure Marketplace Image references verified by Azure Batch, see the 'List Supported Images' operation." + }, + "WindowsConfiguration": { + "properties": { + "enableAutomaticUpdates": { + "type": "boolean", + "title": "Whether automatic updates are enabled on the virtual machine.", + "description": "If omitted, the default value is true." + } + }, + "title": "Windows operating system settings to apply to the virtual machine." + }, + "DataDisk": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "title": "The logical unit number.", + "description": "The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive." + }, + "caching": { + "$ref": "#/definitions/CachingType", + "title": "The type of caching to be enabled for the data disks.", + "description": "The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "title": "The initial disk size in gigabytes." + }, + "storageAccountType": { + "title": "The storage Account type to be used for the data disk.", + "description": "If omitted, the default is \"standard_lrs\".", + "$ref": "#/definitions/StorageAccountType" + } + }, + "required": [ + "lun", + "diskSizeGB" + ], + "title": "Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them." + }, + "StorageAccountType": { + "type": "string", + "title": "The storage Account type for use in creating data disks.", + "enum": [ + "standard_lrs", + "premium_lrs" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": false, + "values": [ + { + "value": "standard_lrs", + "description": "The data disk should use standard locally redundant storage.", + "name": "StandardLRS" + }, + { + "value": "premium_lrs", + "description": "The data disk should use premium locally redundant storage.", + "name": "PremiumLRS" + } + ] + } + }, + "CachingType": { + "type": "string", + "title": "The type of caching to enable for the disk.", + "description": "The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.", + "enum": [ + "none", + "readonly", + "readwrite" + ], + "x-ms-enum": { + "name": "CachingType", + "modelAsString": false, + "values": [ + { + "value": "none", + "description": "The caching mode for the disk is not enabled." + }, + { + "value": "readonly", + "description": "The caching mode for the disk is read only.", + "name": "readOnly" + }, + { + "value": "readwrite", + "description": "The caching mode for the disk is read and write.", + "name": "readWrite" + } + ] + } + }, + "VirtualMachineConfiguration": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "title": "A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use." + }, + "nodeAgentSKUId": { + "type": "string", + "title": "The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool.", + "description": "The Batch Compute Node agent is a program that runs on each Compute Node in the Pool, and provides the command-and-control interface between the Compute Node and the Batch service. There are different implementations of the Compute Node agent, known as SKUs, for different operating systems. You must specify a Compute Node agent SKU which matches the selected Image reference. To get the list of supported Compute Node agent SKUs along with their list of verified Image references, see the 'List supported Compute Node agent SKUs' operation." + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "title": "Windows operating system settings on the virtual machine.", + "description": "This property must not be specified if the imageReference property specifies a Linux OS Image." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + }, + "title": "The configuration for data disks attached to the Compute Nodes in the Pool.", + "description": "This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine." + }, + "licenseType": { + "type": "string", + "title": "The type of on-premises license to be used when deploying the operating system.", + "description": "This only applies to Images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the Compute Nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:\n\n Windows_Server - The on-premises license is for Windows Server.\n Windows_Client - The on-premises license is for Windows Client.\n" + }, + "containerConfiguration": { + "$ref": "#/definitions/ContainerConfiguration", + "title": "The container configuration for the Pool.", + "description": "If specified, setup is performed on each Compute Node in the Pool to allow Tasks to run in containers. All regular Tasks and Job manager Tasks run on this Pool must specify the containerSettings property, and all other Tasks may specify it." + }, + "diskEncryptionConfiguration": { + "$ref": "#/definitions/DiskEncryptionConfiguration", + "title": "The disk encryption configuration for the pool.", + "description": "If specified, encryption is performed on each node in the pool during node provisioning." + } + }, + "required": [ + "nodeAgentSKUId", + "imageReference" + ], + "title": "The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure." + }, + "ContainerRegistry": { + "properties": { + "registryServer": { + "type": "string", + "title": "The registry URL.", + "description": "If omitted, the default is \"docker.io\"." + }, + "username": { + "type": "string", + "x-ms-client-name": "userName", + "title": "The user name to log into the registry server." + }, + "password": { + "type": "string", + "title": "The password to log into the registry server." + } + }, + "required": [ + "username", + "password" + ], + "title": "A private container registry." + }, + "ContainerConfiguration": { + "properties": { + "type": { + "type": "string", + "title": "The container technology to be used.", + "enum": [ + "dockerCompatible" + ], + "x-ms-enum": { + "name": "ContainerType", + "modelAsString": false, + "values": [ + { + "value": "dockerCompatible", + "description": "A Docker compatible container technology will be used to launch the containers." + } + ] + } + }, + "containerImageNames": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The collection of container Image names.", + "description": "This is the full Image reference, as would be specified to \"docker pull\". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry." + }, + "containerRegistries": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerRegistry" + }, + "title": "Additional private registries from which containers can be pulled.", + "description": "If any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here." + } + }, + "required": [ + "type" + ], + "title": "The configuration for container-enabled Pools." + }, + "DiskEncryptionConfiguration": { + "properties": { + "targets": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false, + "title": "A disk to encrypt.", + "enum": [ + "osdisk", + "temporarydisk" + ], + "x-ms-enum": { + "name": "DiskEncryptionTarget", + "modelAsString": false, + "values": [ + { + "value": "osdisk", + "description": "The temporary disk on the compute node is encrypted. On Linux this encryption applies to other partitions (such as those on mounted data disks) when encryption occurs at boot time.", + "name": "OsDisk" + }, + { + "value": "temporarydisk", + "description": "The temporary disk on the compute node is encrypted. On Linux this encryption applies to other partitions (such as those on mounted data disks) when encryption occurs at boot time.", + "name": "TemporaryDisk" + } + ] + } + }, + "title": "The list of disk targets Batch Service will encrypt on the compute node.", + "description": "If omitted, no disks on the compute nodes in the pool will be encrypted. On Linux pool, only \"TemporaryDisk\" is supported; on Windows pool, \"OsDisk\" and \"TemporaryDisk\" must be specified." + } + }, + "description": "The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Shared Image Gallery Image." + }, + "IPAddressProvisioningType": { + "type": "string", + "title": "The provisioning type for Public IP Addresses for the Pool.", + "enum": [ + "batchmanaged", + "usermanaged", + "nopublicipaddresses" + ], + "x-ms-enum": { + "name": "IPAddressProvisioningType", + "modelAsString": false, + "values": [ + { + "value": "batchmanaged", + "description": "A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool.", + "name": "batchManaged" + }, + { + "value": "usermanaged", + "description": "Public IPs are provided by the user and will be used to provision the Compute Nodes.", + "name": "userManaged" + }, + { + "value": "nopublicipaddresses", + "description": "No public IP Address will be created.", + "name": "noPublicIPAddresses" + } + ] + } + }, + "PublicIPAddressConfiguration": { + "properties": { + "provision": { + "$ref": "#/definitions/IPAddressProvisioningType", + "title": "The provisioning type for Public IP Addresses for the Pool.", + "description": "The default value is BatchManaged." + }, + "ipAddressIds": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The list of public IPs which the Batch service will use when provisioning Compute Nodes.", + "description": "The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}." + } + }, + "description": "The public IP Address configuration of the networking configuration of a Pool." + }, + "NetworkConfiguration": { + "properties": { + "subnetId": { + "type": "string", + "title": "The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.", + "description": "The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. For Pools created with virtualMachineConfiguration only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported, but for Pools created with cloudServiceConfiguration both ARM and classic virtual networks are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For Pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For Pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration", + "externalDocs": { + "url": "https://azure.microsoft.com/en-us/documentation/articles/role-based-access-built-in-roles/#classic-virtual-machine-contributor", + "description": "Setting up RBAC for Azure Batch VNETs" + } + }, + "dynamicVNetAssignmentScope": { + "type": "string", + "title": "The scope of dynamic vnet assignment.", + "enum": [ + "none", + "job" + ], + "x-ms-enum": { + "name": "DynamicVNetAssignmentScope", + "modelAsString": false, + "values": [ + { + "value": "none", + "description": "No dynamic VNet assignment is enabled." + }, + { + "value": "job", + "description": "Dynamic VNet assignment is done per-job." + } + ] + } + }, + "endpointConfiguration": { + "$ref": "#/definitions/PoolEndpointConfiguration", + "title": "The configuration for endpoints on Compute Nodes in the Batch Pool.", + "description": "Pool endpoint configuration is only supported on Pools with the virtualMachineConfiguration property." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/PublicIPAddressConfiguration", + "title": "The Public IPAddress configuration for Compute Nodes in the Batch Pool.", + "description": "Public IP configuration property is only supported on Pools with the virtualMachineConfiguration property." + } + }, + "description": "The network configuration for a Pool." + }, + "CloudPool": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the Pool within the Account.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case)." + }, + "displayName": { + "type": "string", + "title": "The display name for the Pool.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "url": { + "type": "string", + "title": "The URL of the Pool." + }, + "eTag": { + "type": "string", + "title": "The ETag of the Pool.", + "description": "This is an opaque string. You can use it to detect whether the Pool has changed between requests. In particular, you can be pass the ETag when updating a Pool to specify that your changes should take effect only if nobody else has modified the Pool in the meantime." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "title": "The last modified time of the Pool.", + "description": "This is the last time at which the Pool level data, such as the targetDedicatedNodes or enableAutoscale settings, changed. It does not factor in node-level changes such as a Compute Node changing state." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "title": "The creation time of the Pool." + }, + "state": { + "type": "string", + "title": "The current state of the Pool.", + "enum": [ + "active", + "deleting" + ], + "x-ms-enum": { + "name": "PoolState", + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The Pool is available to run Tasks subject to the availability of Compute Nodes." + }, + { + "value": "deleting", + "description": "The user has requested that the Pool be deleted, but the delete operation has not yet completed." + } + ] + } + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Pool entered its current state." + }, + "allocationState": { + "type": "string", + "title": "Whether the Pool is resizing.", + "enum": [ + "steady", + "resizing", + "stopping" + ], + "x-ms-enum": { + "name": "AllocationState", + "modelAsString": false, + "values": [ + { + "value": "steady", + "description": "The Pool is not resizing. There are no changes to the number of Compute Nodes in the Pool in progress. A Pool enters this state when it is created and when no operations are being performed on the Pool to change the number of Compute Nodes." + }, + { + "value": "resizing", + "description": "The Pool is resizing; that is, Compute Nodes are being added to or removed from the Pool." + }, + { + "value": "stopping", + "description": "The Pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed." + } + ] + } + }, + "allocationStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Pool entered its current allocation state." + }, + "vmSize": { + "type": "string", + "title": "The size of virtual machines in the Pool. All virtual machines in a Pool are the same size.", + "description": "For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)." + }, + "cloudServiceConfiguration": { + "$ref": "#/definitions/CloudServiceConfiguration", + "title": "The cloud service configuration for the Pool.", + "description": "This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch Account was created with its poolAllocationMode property set to 'UserSubscription'." + }, + "virtualMachineConfiguration": { + "$ref": "#/definitions/VirtualMachineConfiguration", + "title": "The virtual machine configuration for the Pool.", + "description": "This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for allocation of Compute Nodes to the Pool.", + "description": "This is the timeout for the most recent resize operation. (The initial sizing when the Pool is created counts as a resize.) The default value is 15 minutes." + }, + "resizeErrors": { + "type": "array", + "items": { + "$ref": "#/definitions/ResizeError" + }, + "title": "A list of errors encountered while performing the last resize on the Pool.", + "description": "This property is set only if one or more errors occurred during the last Pool resize, and only when the Pool allocationState is Steady." + }, + "currentDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The number of dedicated Compute Nodes currently in the Pool." + }, + "currentLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The number of low-priority Compute Nodes currently in the Pool.", + "description": "Low-priority Compute Nodes which have been preempted are included in this count." + }, + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of dedicated Compute Nodes in the Pool." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of low-priority Compute Nodes in the Pool." + }, + "enableAutoScale": { + "type": "boolean", + "title": "Whether the Pool size should automatically adjust over time.", + "description": "If false, at least one of targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the Pool automatically resizes according to the formula. The default value is false." + }, + "autoScaleFormula": { + "type": "string", + "title": "A formula for the desired number of Compute Nodes in the Pool.", + "description": "This property is set only if the Pool automatically scales, i.e. enableAutoScale is true." + }, + "autoScaleEvaluationInterval": { + "type": "string", + "format": "duration", + "title": "The time interval at which to automatically adjust the Pool size according to the autoscale formula.", + "description": "This property is set only if the Pool automatically scales, i.e. enableAutoScale is true." + }, + "autoScaleRun": { + "$ref": "#/definitions/AutoScaleRun", + "title": "The results and errors from the last execution of the autoscale formula.", + "description": "This property is set only if the Pool automatically scales, i.e. enableAutoScale is true." + }, + "enableInterNodeCommunication": { + "type": "boolean", + "title": "Whether the Pool permits direct communication between Compute Nodes.", + "description": "This imposes restrictions on which Compute Nodes can be assigned to the Pool. Specifying this value can reduce the chance of the requested number of Compute Nodes to be allocated in the Pool." + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "title": "The network configuration for the Pool." + }, + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "A Task specified to run on each Compute Node as it joins the Pool." + }, + "certificateReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateReference" + }, + "title": "The list of Certificates to be installed on each Compute Node in the Pool.", + "description": "For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "The list of Packages to be installed on each Compute Node in the Pool.", + "description": "Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool." + }, + "applicationLicenses": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The list of application licenses the Batch service will make available on each Compute Node in the Pool.", + "description": "The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, Pool creation will fail." + }, + "taskSlotsPerNode": { + "type": "integer", + "format": "int32", + "title": "The number of task slots that can be used to run concurrent tasks on a single compute node in the pool.", + "description": "The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256." + }, + "taskSchedulingPolicy": { + "$ref": "#/definitions/TaskSchedulingPolicy", + "title": "How Tasks are distributed across Compute Nodes in a Pool.", + "description": "If not specified, the default is spread." + }, + "userAccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/UserAccount" + }, + "title": "The list of user Accounts to be created on each Compute Node in the Pool." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the Pool as metadata." + }, + "stats": { + "$ref": "#/definitions/PoolStatistics", + "title": "Utilization and resource usage statistics for the entire lifetime of the Pool.", + "description": "This property is populated only if the CloudPool was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes." + }, + "mountConfiguration": { + "type": "array", + "items": { + "$ref": "#/definitions/MountConfiguration" + }, + "title": "A list of file systems to mount on each node in the pool.", + "description": "This supports Azure Files, NFS, CIFS/SMB, and Blobfuse." + } + }, + "title": "A Pool in the Azure Batch service." + }, + "PoolAddParameter": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the Pool within the Account.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two Pool IDs within an Account that differ only by case)." + }, + "displayName": { + "type": "string", + "title": "The display name for the Pool.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "vmSize": { + "type": "string", + "title": "The size of virtual machines in the Pool. All virtual machines in a Pool are the same size.", + "description": "For information about available sizes of virtual machines for Cloud Services Pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for Pools using Images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." + }, + "cloudServiceConfiguration": { + "$ref": "#/definitions/CloudServiceConfiguration", + "title": "The cloud service configuration for the Pool.", + "description": "This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch Account was created with its poolAllocationMode property set to 'UserSubscription'." + }, + "virtualMachineConfiguration": { + "$ref": "#/definitions/VirtualMachineConfiguration", + "title": "The virtual machine configuration for the Pool.", + "description": "This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for allocation of Compute Nodes to the Pool.", + "description": "This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of dedicated Compute Nodes in the Pool.", + "description": "This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of low-priority Compute Nodes in the Pool.", + "description": "This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both." + }, + "enableAutoScale": { + "type": "boolean", + "title": "Whether the Pool size should automatically adjust over time.", + "description": "If false, at least one of targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the Pool automatically resizes according to the formula. The default value is false." + }, + "autoScaleFormula": { + "type": "string", + "title": "A formula for the desired number of Compute Nodes in the Pool.", + "description": "This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see 'Automatically scale Compute Nodes in an Azure Batch Pool' (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/)." + }, + "autoScaleEvaluationInterval": { + "type": "string", + "format": "duration", + "title": "The time interval at which to automatically adjust the Pool size according to the autoscale formula.", + "description": "The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "enableInterNodeCommunication": { + "type": "boolean", + "title": "Whether the Pool permits direct communication between Compute Nodes.", + "description": "Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false." + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "title": "The network configuration for the Pool." + }, + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "A Task specified to run on each Compute Node as it joins the Pool.", + "description": "The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted." + }, + "certificateReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateReference" + }, + "title": "The list of Certificates to be installed on each Compute Node in the Pool.", + "description": "For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "The list of Packages to be installed on each Compute Node in the Pool.", + "description": "Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool." + }, + "applicationLicenses": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The list of application licenses the Batch service will make available on each Compute Node in the Pool.", + "description": "The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, Pool creation will fail." + }, + "taskSlotsPerNode": { + "type": "integer", + "format": "int32", + "title": "The number of task slots that can be used to run concurrent tasks on a single compute node in the pool.", + "description": "The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256." + }, + "taskSchedulingPolicy": { + "$ref": "#/definitions/TaskSchedulingPolicy", + "title": "How Tasks are distributed across Compute Nodes in a Pool.", + "description": "If not specified, the default is spread." + }, + "userAccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/UserAccount" + }, + "title": "The list of user Accounts to be created on each Compute Node in the Pool." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the Pool as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + }, + "mountConfiguration": { + "type": "array", + "items": { + "$ref": "#/definitions/MountConfiguration" + }, + "title": "Mount storage using specified file system for the entire lifetime of the pool.", + "description": "Mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based file system." + } + }, + "required": [ + "id", + "vmSize" + ], + "title": "A Pool in the Azure Batch service to add." + }, + "ApplicationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationSummary" + }, + "title": "The list of applications available in the Account." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the applications available in an Account." + }, + "CloudPoolListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudPool" + }, + "title": "The list of Pools." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the Pools in an Account." + }, + "AffinityInformation": { + "properties": { + "affinityId": { + "type": "string", + "title": "An opaque string representing the location of a Compute Node or a Task that has run previously.", + "description": "You can pass the affinityId of a Node to indicate that this Task needs to run on that Compute Node. Note that this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere." + } + }, + "required": [ + "affinityId" + ], + "title": "A locality hint that can be used by the Batch service to select a Compute Node on which to start a Task." + }, + "TaskExecutionInformation": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Task started running.", + "description": "'Running' corresponds to the running state, so if the Task specifies resource files or Packages, then the start time reflects the time at which the Task started downloading or deploying these. If the Task has been restarted or retried, this is the most recent time at which the Task started running. This property is present only for Tasks that are in the running or completed state." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Task completed.", + "description": "This property is set only if the Task is in the Completed state." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "title": "The exit code of the program specified on the Task command line.", + "description": "This property is set only if the Task is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the Task (due to timeout, or user termination via the API) you may see an operating system-defined exit code." + }, + "containerInfo": { + "$ref": "#/definitions/TaskContainerExecutionInformation", + "title": "Information about the container under which the Task is executing.", + "description": "This property is set only if the Task runs in a container context." + }, + "failureInfo": { + "$ref": "#/definitions/TaskFailureInformation", + "title": "Information describing the Task failure, if any.", + "description": "This property is set only if the Task is in the completed state and encountered a failure." + }, + "retryCount": { + "type": "integer", + "format": "int32", + "title": "The number of times the Task has been retried by the Batch service.", + "description": "Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints." + }, + "lastRetryTime": { + "type": "string", + "format": "date-time", + "title": "The most recent time at which a retry of the Task started running.", + "description": "This element is present only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not." + }, + "requeueCount": { + "type": "integer", + "format": "int32", + "title": "The number of times the Task has been requeued by the Batch service as the result of a user request.", + "description": "When the user removes Compute Nodes from a Pool (by resizing/shrinking the pool) or when the Job is being disabled, the user can specify that running Tasks on the Compute Nodes be requeued for execution. This count tracks how many times the Task has been requeued for these reasons." + }, + "lastRequeueTime": { + "type": "string", + "format": "date-time", + "title": "The most recent time at which the Task has been requeued by the Batch service as the result of a user request.", + "description": "This property is set only if the requeueCount is nonzero." + }, + "result": { + "$ref": "#/definitions/TaskExecutionResult", + "title": "The result of the Task execution.", + "description": "If the value is 'failed', then the details of the failure can be found in the failureInfo property." + } + }, + "required": [ + "requeueCount", + "retryCount" + ], + "title": "Information about the execution of a Task." + }, + "ComputeNodeInformation": { + "properties": { + "affinityId": { + "type": "string", + "title": "An identifier for the Node on which the Task ran, which can be passed when adding a Task to request that the Task be scheduled on this Compute Node." + }, + "nodeUrl": { + "type": "string", + "title": "The URL of the Compute Node on which the Task ran. " + }, + "poolId": { + "type": "string", + "title": "The ID of the Pool on which the Task ran." + }, + "nodeId": { + "type": "string", + "title": "The ID of the Compute Node on which the Task ran." + }, + "taskRootDirectory": { + "type": "string", + "title": "The root directory of the Task on the Compute Node." + }, + "taskRootDirectoryUrl": { + "type": "string", + "title": "The URL to the root directory of the Task on the Compute Node." + } + }, + "title": "Information about the Compute Node on which a Task ran." + }, + "NodeAgentInformation": { + "properties": { + "version": { + "type": "string", + "title": "The version of the Batch Compute Node agent running on the Compute Node.", + "description": "This version number can be checked against the Compute Node agent release notes located at https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "title": "The time when the Compute Node agent was updated on the Compute Node.", + "description": "This is the most recent time that the Compute Node agent was updated to a new version." + } + }, + "required": [ + "version", + "lastUpdateTime" + ], + "title": "Information about the Compute Node agent.", + "description": "The Batch Compute Node agent is a program that runs on each Compute Node in the Pool and provides Batch capability on the Compute Node." + }, + "MultiInstanceSettings": { + "properties": { + "numberOfInstances": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes required by the Task.", + "description": "If omitted, the default is 1." + }, + "coordinationCommandLine": { + "type": "string", + "title": "The command line to run on all the Compute Nodes to enable them to coordinate when the primary runs the main Task command.", + "description": "A typical coordination command line launches a background service and verifies that the service is ready to process inter-node messages." + }, + "commonResourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download before running the coordination command line.", + "description": "The difference between common resource files and Task resource files is that common resource files are downloaded for all subtasks including the primary, whereas Task resource files are downloaded only for the primary. Also note that these resource files are not downloaded to the Task working directory, but instead are downloaded to the Task root directory (one directory above the working directory). There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers." + } + }, + "required": [ + "coordinationCommandLine" + ], + "title": "Settings which specify how to run a multi-instance Task.", + "description": "Multi-instance Tasks are commonly used to support MPI Tasks. In the MPI case, if any of the subtasks fail (for example due to exiting with a non-zero exit code) the entire multi-instance Task fails. The multi-instance Task is then terminated and retried, up to its retry limit." + }, + "TaskStatistics": { + "properties": { + "url": { + "type": "string", + "title": "The URL of the statistics." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "userCPUTime": { + "type": "string", + "format": "duration", + "title": "The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by the Task." + }, + "kernelCPUTime": { + "type": "string", + "format": "duration", + "title": "The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by the Task." + }, + "wallClockTime": { + "type": "string", + "format": "duration", + "title": "The total wall clock time of the Task.", + "description": "The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If the Task was retried, this includes the wall clock time of all the Task retries." + }, + "readIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk read operations made by the Task." + }, + "writeIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk write operations made by the Task." + }, + "readIOGiB": { + "type": "number", + "format": "double", + "title": "The total gibibytes read from disk by the Task." + }, + "writeIOGiB": { + "type": "number", + "format": "double", + "title": "The total gibibytes written to disk by the Task." + }, + "waitTime": { + "type": "string", + "format": "duration", + "title": "The total wait time of the Task. The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.)" + } + }, + "required": [ + "url", + "startTime", + "lastUpdateTime", + "userCPUTime", + "kernelCPUTime", + "wallClockTime", + "readIOps", + "writeIOps", + "readIOGiB", + "writeIOGiB", + "waitTime" + ], + "title": "Resource usage statistics for a Task." + }, + "TaskDependencies": { + "properties": { + "taskIds": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The list of Task IDs that this Task depends on. All Tasks in this list must complete successfully before the dependent Task can be scheduled.", + "description": "The taskIds collection is limited to 64000 characters total (i.e. the combined length of all Task IDs). If the taskIds collection exceeds the maximum length, the Add Task request fails with error code TaskDependencyListTooLong. In this case consider using Task ID ranges instead." + }, + "taskIdRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/TaskIdRange" + }, + "title": "The list of Task ID ranges that this Task depends on. All Tasks in all ranges must complete successfully before the dependent Task can be scheduled." + } + }, + "title": "Specifies any dependencies of a Task. Any Task that is explicitly specified or within a dependency range must complete before the dependant Task will be scheduled." + }, + "TaskIdRange": { + "properties": { + "start": { + "type": "integer", + "format": "int32", + "title": "The first Task ID in the range." + }, + "end": { + "type": "integer", + "format": "int32", + "title": "The last Task ID in the range." + } + }, + "title": "A range of Task IDs that a Task can depend on. All Tasks with IDs in the range must complete successfully before the dependent Task can be scheduled.", + "description": "The start and end of the range are inclusive. For example, if a range has start 9 and end 12, then it represents Tasks '9', '10', '11' and '12'.", + "required": [ + "start", + "end" + ] + }, + "CloudTask": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the Task within the Job.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters." + }, + "displayName": { + "type": "string", + "title": "A display name for the Task.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "url": { + "type": "string", + "title": "The URL of the Task." + }, + "eTag": { + "type": "string", + "title": "The ETag of the Task.", + "description": "This is an opaque string. You can use it to detect whether the Task has changed between requests. In particular, you can be pass the ETag when updating a Task to specify that your changes should take effect only if nobody else has modified the Task in the meantime." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "title": "The last modified time of the Task." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "title": "The creation time of the Task." + }, + "exitConditions": { + "$ref": "#/definitions/ExitConditions", + "description": "How the Batch service should respond when the Task completes." + }, + "state": { + "title": "The current state of the Task.", + "$ref": "#/definitions/TaskState" + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Task entered its current state." + }, + "previousState": { + "title": "The previous state of the Task.", + "description": "This property is not set if the Task is in its initial Active state.", + "$ref": "#/definitions/TaskState" + }, + "previousStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Task entered its previous state.", + "description": "This property is not set if the Task is in its initial Active state." + }, + "commandLine": { + "type": "string", + "title": "The command line of the Task.", + "description": "For multi-instance Tasks, the command line is executed as the primary Task, after the primary Task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the Task runs.", + "description": "If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files." + }, + "resourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download to the Compute Node before running the command line.", + "description": "For multi-instance Tasks, the resource files will only be downloaded to the Compute Node on which the primary Task is executed. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers." + }, + "outputFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFile" + }, + "title": "A list of files that the Batch service will upload from the Compute Node after running the command line.", + "description": "For multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed." + }, + "environmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of environment variable settings for the Task." + }, + "affinityInfo": { + "$ref": "#/definitions/AffinityInformation", + "title": "A locality hint that can be used by the Batch service to select a Compute Node on which to start the new Task." + }, + "constraints": { + "$ref": "#/definitions/TaskConstraints", + "title": "The execution constraints that apply to this Task." + }, + "requiredSlots": { + "type": "integer", + "format": "int32", + "title": "The number of scheduling slots that the Task requires to run.", + "description": "The default is 1. A Task can only be scheduled to run on a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this must be 1." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the Task runs.", + "description": "If omitted, the Task runs as a non-administrative user unique to the Task." + }, + "executionInfo": { + "$ref": "#/definitions/TaskExecutionInformation", + "title": "Information about the execution of the Task." + }, + "nodeInfo": { + "$ref": "#/definitions/ComputeNodeInformation", + "title": "Information about the Compute Node on which the Task ran." + }, + "multiInstanceSettings": { + "$ref": "#/definitions/MultiInstanceSettings", + "title": "An object that indicates that the Task is a multi-instance Task, and contains information about how to run the multi-instance Task." + }, + "stats": { + "$ref": "#/definitions/TaskStatistics", + "title": "Resource usage statistics for the Task." + }, + "dependsOn": { + "$ref": "#/definitions/TaskDependencies", + "title": "The Tasks that this Task depends on.", + "description": "This Task will not be scheduled until all Tasks that it depends on have completed successfully. If any of those Tasks fail and exhaust their retry counts, this Task will never be scheduled." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "A list of Packages that the Batch service will deploy to the Compute Node before running the command line.", + "description": "Application packages are downloaded and deployed to a shared directory, not the Task working directory. Therefore, if a referenced package is already on the Node, and is up to date, then it is not re-downloaded; the existing copy on the Compute Node is used. If a referenced Package cannot be installed, for example because the package has been deleted or because download failed, the Task fails." + }, + "authenticationTokenSettings": { + "title": "The settings for an authentication token that the Task can use to perform Batch service operations.", + "description": "If this property is set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job.", + "$ref": "#/definitions/AuthenticationTokenSettings" + } + }, + "title": "An Azure Batch Task.", + "description": "Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing." + }, + "TaskAddParameter": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the Task within the Job.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within a Job that differ only by case)." + }, + "displayName": { + "type": "string", + "title": "A display name for the Task.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "commandLine": { + "type": "string", + "title": "The command line of the Task.", + "description": "For multi-instance Tasks, the command line is executed as the primary Task, after the primary Task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the Task runs.", + "description": "If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files." + }, + "exitConditions": { + "$ref": "#/definitions/ExitConditions", + "description": "How the Batch service should respond when the Task completes." + }, + "resourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download to the Compute Node before running the command line.", + "description": "For multi-instance Tasks, the resource files will only be downloaded to the Compute Node on which the primary Task is executed. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers." + }, + "outputFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFile" + }, + "title": "A list of files that the Batch service will upload from the Compute Node after running the command line.", + "description": "For multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed." + }, + "environmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of environment variable settings for the Task." + }, + "affinityInfo": { + "$ref": "#/definitions/AffinityInformation", + "title": "A locality hint that can be used by the Batch service to select a Compute Node on which to start the new Task." + }, + "constraints": { + "$ref": "#/definitions/TaskConstraints", + "title": "The execution constraints that apply to this Task.", + "description": "If you do not specify constraints, the maxTaskRetryCount is the maxTaskRetryCount specified for the Job, the maxWallClockTime is infinite, and the retentionTime is 7 days." + }, + "requiredSlots": { + "type": "integer", + "format": "int32", + "title": "The number of scheduling slots that the Task required to run.", + "description": "The default is 1. A Task can only be scheduled to run on a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this must be 1." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the Task runs.", + "description": "If omitted, the Task runs as a non-administrative user unique to the Task." + }, + "multiInstanceSettings": { + "$ref": "#/definitions/MultiInstanceSettings", + "title": "An object that indicates that the Task is a multi-instance Task, and contains information about how to run the multi-instance Task." + }, + "dependsOn": { + "$ref": "#/definitions/TaskDependencies", + "title": "The Tasks that this Task depends on.", + "description": "This Task will not be scheduled until all Tasks that it depends on have completed successfully. If any of those Tasks fail and exhaust their retry counts, this Task will never be scheduled. If the Job does not have usesTaskDependencies set to true, and this element is present, the request fails with error code TaskDependenciesNotSpecifiedOnJob." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "A list of Packages that the Batch service will deploy to the Compute Node before running the command line.", + "description": "Application packages are downloaded and deployed to a shared directory, not the Task working directory. Therefore, if a referenced package is already on the Node, and is up to date, then it is not re-downloaded; the existing copy on the Compute Node is used. If a referenced Package cannot be installed, for example because the package has been deleted or because download failed, the Task fails." + }, + "authenticationTokenSettings": { + "title": "The settings for an authentication token that the Task can use to perform Batch service operations.", + "description": "If this property is set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job.", + "$ref": "#/definitions/AuthenticationTokenSettings" + } + }, + "required": [ + "id", + "commandLine" + ], + "title": "An Azure Batch Task to add.", + "description": "Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing." + }, + "TaskAddCollectionParameter": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TaskAddParameter" + }, + "maxItems": 100, + "title": "The collection of Tasks to add. The maximum count of Tasks is 100.", + "description": "The total serialized size of this collection must be less than 1MB. If it is greater than 1MB (for example if each Task has 100's of resource files or environment variables), the request will fail with code 'RequestBodyTooLarge' and should be retried again with fewer Tasks." + } + }, + "required": [ + "value" + ], + "title": "A collection of Azure Batch Tasks to add." + }, + "TaskAddResult": { + "properties": { + "status": { + "type": "string", + "title": "The status of the add Task request.", + "enum": [ + "success", + "clienterror", + "servererror" + ], + "x-ms-enum": { + "name": "TaskAddStatus", + "modelAsString": false, + "values": [ + { + "value": "success", + "description": "The Task was added successfully." + }, + { + "value": "clienterror", + "description": "The Task failed to add due to a client error and should not be retried without modifying the request as appropriate.", + "name": "clientError" + }, + { + "value": "servererror", + "description": "Task failed to add due to a server error and can be retried without modification.", + "name": "serverError" + } + ] + } + }, + "taskId": { + "type": "string", + "title": "The ID of the Task for which this is the result." + }, + "eTag": { + "type": "string", + "title": "The ETag of the Task, if the Task was successfully added.", + "description": "You can use this to detect whether the Task has changed between requests. In particular, you can be pass the ETag with an Update Task request to specify that your changes should take effect only if nobody else has modified the Job in the meantime." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "title": "The last modified time of the Task." + }, + "location": { + "type": "string", + "title": "The URL of the Task, if the Task was successfully added." + }, + "error": { + "$ref": "#/definitions/BatchError", + "title": "The error encountered while attempting to add the Task." + } + }, + "required": [ + "status", + "taskId" + ], + "title": "Result for a single Task added as part of an add Task collection operation." + }, + "TaskAddCollectionResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TaskAddResult" + }, + "title": "The results of the add Task collection operation." + } + }, + "title": "The result of adding a collection of Tasks to a Job." + }, + "SubtaskInformation": { + "properties": { + "id": { + "type": "integer", + "format": "int32", + "title": "The ID of the subtask." + }, + "nodeInfo": { + "$ref": "#/definitions/ComputeNodeInformation", + "title": "Information about the Compute Node on which the subtask ran." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the subtask started running. If the subtask has been restarted or retried, this is the most recent time at which the subtask started running." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the subtask completed.", + "description": "This property is set only if the subtask is in the Completed state." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "title": "The exit code of the program specified on the subtask command line.", + "description": "This property is set only if the subtask is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the subtask (due to timeout, or user termination via the API) you may see an operating system-defined exit code." + }, + "containerInfo": { + "$ref": "#/definitions/TaskContainerExecutionInformation", + "title": "Information about the container under which the Task is executing.", + "description": "This property is set only if the Task runs in a container context." + }, + "failureInfo": { + "$ref": "#/definitions/TaskFailureInformation", + "title": "Information describing the Task failure, if any.", + "description": "This property is set only if the Task is in the completed state and encountered a failure." + }, + "state": { + "title": "The current state of the subtask.", + "$ref": "#/definitions/SubtaskState" + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the subtask entered its current state." + }, + "previousState": { + "title": "The previous state of the subtask.", + "description": "This property is not set if the subtask is in its initial running state.", + "$ref": "#/definitions/SubtaskState" + }, + "previousStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the subtask entered its previous state.", + "description": "This property is not set if the subtask is in its initial running state." + }, + "result": { + "$ref": "#/definitions/TaskExecutionResult", + "title": "The result of the Task execution.", + "description": "If the value is 'failed', then the details of the failure can be found in the failureInfo property." + } + }, + "title": "Information about an Azure Batch subtask." + }, + "CloudTaskListSubtasksResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SubtaskInformation" + }, + "title": "The list of subtasks." + } + }, + "title": "The result of listing the subtasks of a Task." + }, + "CloudTaskListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudTask" + }, + "title": "The list of Tasks." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the Tasks in a Job." + }, + "TaskInformation": { + "properties": { + "taskUrl": { + "type": "string", + "title": "The URL of the Task." + }, + "jobId": { + "type": "string", + "title": "The ID of the Job to which the Task belongs." + }, + "taskId": { + "type": "string", + "title": "The ID of the Task." + }, + "subtaskId": { + "type": "integer", + "format": "int32", + "title": "The ID of the subtask if the Task is a multi-instance Task." + }, + "taskState": { + "title": "The current state of the Task.", + "$ref": "#/definitions/TaskState" + }, + "executionInfo": { + "$ref": "#/definitions/TaskExecutionInformation", + "title": "Information about the execution of the Task." + } + }, + "required": [ + "taskState" + ], + "title": "Information about a Task running on a Compute Node." + }, + "StartTaskInformation": { + "properties": { + "state": { + "type": "string", + "title": "The state of the StartTask on the Compute Node.", + "enum": [ + "running", + "completed" + ], + "x-ms-enum": { + "name": "StartTaskState", + "modelAsString": false, + "values": [ + { + "value": "running", + "description": "The StartTask is currently running." + }, + { + "value": "completed", + "description": "The StartTask has exited with exit code 0, or the StartTask has failed and the retry limit has reached, or the StartTask process did not run due to Task preparation errors (such as resource file download failures)." + } + ] + } + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the StartTask started running.", + "description": "This value is reset every time the Task is restarted or retried (that is, this is the most recent time at which the StartTask started running)." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the StartTask stopped running.", + "description": "This is the end time of the most recent run of the StartTask, if that run has completed (even if that run failed and a retry is pending). This element is not present if the StartTask is currently running." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "title": "The exit code of the program specified on the StartTask command line.", + "description": "This property is set only if the StartTask is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the StartTask (due to timeout, or user termination via the API) you may see an operating system-defined exit code." + }, + "containerInfo": { + "$ref": "#/definitions/TaskContainerExecutionInformation", + "title": "Information about the container under which the Task is executing.", + "description": "This property is set only if the Task runs in a container context." + }, + "failureInfo": { + "$ref": "#/definitions/TaskFailureInformation", + "title": "Information describing the Task failure, if any.", + "description": "This property is set only if the Task is in the completed state and encountered a failure." + }, + "retryCount": { + "type": "integer", + "format": "int32", + "title": "The number of times the Task has been retried by the Batch service.", + "description": "Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints." + }, + "lastRetryTime": { + "type": "string", + "format": "date-time", + "title": "The most recent time at which a retry of the Task started running.", + "description": "This element is present only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not." + }, + "result": { + "$ref": "#/definitions/TaskExecutionResult", + "title": "The result of the Task execution.", + "description": "If the value is 'failed', then the details of the failure can be found in the failureInfo property." + } + }, + "required": [ + "state", + "startTime", + "retryCount" + ], + "title": "Information about a StartTask running on a Compute Node." + }, + "ComputeNodeError": { + "properties": { + "code": { + "type": "string", + "title": "An identifier for the Compute Node error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "title": "A message describing the Compute Node error, intended to be suitable for display in a user interface." + }, + "errorDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "title": "The list of additional error details related to the Compute Node error." + } + }, + "title": "An error encountered by a Compute Node." + }, + "ComputeNode": { + "properties": { + "id": { + "type": "string", + "title": "The ID of the Compute Node.", + "description": "Every Compute Node that is added to a Pool is assigned a unique ID. Whenever a Compute Node is removed from a Pool, all of its local files are deleted, and the ID is reclaimed and could be reused for new Compute Nodes." + }, + "url": { + "type": "string", + "title": "The URL of the Compute Node." + }, + "state": { + "type": "string", + "title": "The current state of the Compute Node.", + "description": "The low-priority Compute Node has been preempted. Tasks which were running on the Compute Node when it was preempted will be rescheduled when another Compute Node becomes available.", + "enum": [ + "idle", + "rebooting", + "reimaging", + "running", + "unusable", + "creating", + "starting", + "waitingforstarttask", + "starttaskfailed", + "unknown", + "leavingpool", + "offline", + "preempted" + ], + "x-ms-enum": { + "name": "ComputeNodeState", + "modelAsString": false, + "values": [ + { + "value": "idle", + "description": "The Compute Node is not currently running a Task." + }, + { + "value": "rebooting", + "description": "The Compute Node is rebooting." + }, + { + "value": "reimaging", + "description": "The Compute Node is reimaging." + }, + { + "value": "running", + "description": "The Compute Node is running one or more Tasks (other than a StartTask)." + }, + { + "value": "unusable", + "description": "The Compute Node cannot be used for Task execution due to errors." + }, + { + "value": "creating", + "description": "The Batch service has obtained the underlying virtual machine from Azure Compute, but it has not yet started to join the Pool." + }, + { + "value": "starting", + "description": "The Batch service is starting on the underlying virtual machine." + }, + { + "value": "waitingforstarttask", + "description": "The StartTask has started running on the Compute Node, but waitForSuccess is set and the StartTask has not yet completed.", + "name": "waitingForStartTask" + }, + { + "value": "starttaskfailed", + "description": "The StartTask has failed on the Compute Node (and exhausted all retries), and waitForSuccess is set. The Compute Node is not usable for running Tasks.", + "name": "startTaskFailed" + }, + { + "value": "unknown", + "description": "The Batch service has lost contact with the Compute Node, and does not know its true state." + }, + { + "value": "leavingpool", + "description": "The Compute Node is leaving the Pool, either because the user explicitly removed it or because the Pool is resizing or autoscaling down.", + "name": "leavingPool" + }, + { + "value": "offline", + "description": "The Compute Node is not currently running a Task, and scheduling of new Tasks to the Compute Node is disabled." + }, + { + "value": "preempted", + "description": "The low-priority Compute Node has been preempted. Tasks which were running on the Compute Node when it was preempted will be rescheduled when another Compute Node becomes available." + } + ] + } + }, + "schedulingState": { + "type": "string", + "title": "Whether the Compute Node is available for Task scheduling.", + "enum": [ + "enabled", + "disabled" + ], + "x-ms-enum": { + "name": "SchedulingState", + "modelAsString": false, + "values": [ + { + "value": "enabled", + "description": "Tasks can be scheduled on the Compute Node." + }, + { + "value": "disabled", + "description": "No new Tasks will be scheduled on the Compute Node. Tasks already running on the Compute Node may still run to completion. All Compute Nodes start with scheduling enabled." + } + ] + } + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Compute Node entered its current state." + }, + "lastBootTime": { + "type": "string", + "format": "date-time", + "title": "The last time at which the Compute Node was started.", + "description": "This property may not be present if the Compute Node state is unusable." + }, + "allocationTime": { + "type": "string", + "format": "date-time", + "title": "The time at which this Compute Node was allocated to the Pool.", + "description": "This is the time when the Compute Node was initially allocated and doesn't change once set. It is not updated when the Compute Node is service healed or preempted." + }, + "ipAddress": { + "type": "string", + "title": "The IP address that other Nodes can use to communicate with this Compute Node.", + "description": "Every Compute Node that is added to a Pool is assigned a unique IP address. Whenever a Compute Node is removed from a Pool, all of its local files are deleted, and the IP address is reclaimed and could be reused for new Compute Nodes." + }, + "affinityId": { + "type": "string", + "title": "An identifier which can be passed when adding a Task to request that the Task be scheduled on this Compute Node.", + "description": "Note that this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere." + }, + "vmSize": { + "type": "string", + "title": "The size of the virtual machine hosting the Compute Node.", + "description": "For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)." + }, + "totalTasksRun": { + "type": "integer", + "format": "int32", + "title": "The total number of Job Tasks completed on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks." + }, + "runningTasksCount": { + "type": "integer", + "format": "int32", + "title": "The total number of currently running Job Tasks on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks." + }, + "runningTaskSlotsCount": { + "type": "integer", + "format": "int32", + "title": "The total number of scheduling slots used by currently running Job Tasks on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks." + }, + "totalTasksSucceeded": { + "type": "integer", + "format": "int32", + "title": "The total number of Job Tasks which completed successfully (with exitCode 0) on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks." + }, + "recentTasks": { + "type": "array", + "items": { + "$ref": "#/definitions/TaskInformation" + }, + "title": "A list of Tasks whose state has recently changed.", + "description": "This property is present only if at least one Task has run on this Compute Node since it was assigned to the Pool." + }, + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "The Task specified to run on the Compute Node as it joins the Pool." + }, + "startTaskInfo": { + "$ref": "#/definitions/StartTaskInformation", + "title": "Runtime information about the execution of the StartTask on the Compute Node." + }, + "certificateReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateReference" + }, + "title": "The list of Certificates installed on the Compute Node.", + "description": "For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ComputeNodeError" + }, + "title": "The list of errors that are currently being encountered by the Compute Node." + }, + "isDedicated": { + "type": "boolean", + "title": "Whether this Compute Node is a dedicated Compute Node. If false, the Compute Node is a low-priority Compute Node." + }, + "endpointConfiguration": { + "$ref": "#/definitions/ComputeNodeEndpointConfiguration", + "title": "The endpoint configuration for the Compute Node." + }, + "nodeAgentInfo": { + "$ref": "#/definitions/NodeAgentInformation", + "title": "Information about the Compute Node agent version and the time the Compute Node upgraded to a new version." + } + }, + "title": "A Compute Node in the Batch service." + }, + "PoolEndpointConfiguration": { + "properties": { + "inboundNATPools": { + "type": "array", + "items": { + "$ref": "#/definitions/InboundNATPool" + }, + "title": "A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally.", + "description": "The maximum number of inbound NAT Pools per Batch Pool is 5. If the maximum number of inbound NAT Pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses." + } + }, + "required": [ + "inboundNATPools" + ], + "title": "The endpoint configuration for a Pool." + }, + "InboundNATPool": { + "properties": { + "name": { + "type": "string", + "title": "The name of the endpoint.", + "description": "The name must be unique within a Batch Pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400." + }, + "protocol": { + "$ref": "#/definitions/InboundEndpointProtocol", + "title": "The protocol of the endpoint." + }, + "backendPort": { + "type": "integer", + "format": "int32", + "title": "The port number on the Compute Node.", + "description": "This must be unique within a Batch Pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400." + }, + "frontendPortRangeStart": { + "type": "integer", + "format": "int32", + "title": "The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes.", + "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400." + }, + "frontendPortRangeEnd": { + "type": "integer", + "format": "int32", + "title": "The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes.", + "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400." + }, + "networkSecurityGroupRules": { + "type": "array", + "title": "A list of network security group rules that will be applied to the endpoint.", + "description": "The maximum number of rules that can be specified across all the endpoints on a Batch Pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.", + "items": { + "$ref": "#/definitions/NetworkSecurityGroupRule" + } + } + }, + "required": [ + "name", + "protocol", + "backendPort", + "frontendPortRangeStart", + "frontendPortRangeEnd" + ], + "title": "A inbound NAT Pool that can be used to address specific ports on Compute Nodes in a Batch Pool externally." + }, + "NetworkSecurityGroupRule": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority for this rule.", + "description": "Priorities within a Pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400." + }, + "access": { + "type": "string", + "title": "The action that should be taken for a specified IP address, subnet range or tag.", + "enum": [ + "allow", + "deny" + ], + "x-ms-enum": { + "name": "NetworkSecurityGroupRuleAccess", + "modelAsString": false, + "values": [ + { + "value": "allow", + "description": "Allow access." + }, + { + "value": "deny", + "description": "Deny access." + } + ] + } + }, + "sourceAddressPrefix": { + "type": "string", + "title": "The source address prefix or tag to match for the rule.", + "description": "Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The source port ranges to match for the rule.", + "description": "Valid values are '*' (for all ports 0 - 65535), a specific port (i.e. 22), or a port range (i.e. 100-200). The ports must be in the range of 0 to 65535. Each entry in this collection must not overlap any other entry (either a range or an individual port). If any other values are provided the request fails with HTTP status code 400. The default value is '*'." + } + }, + "required": [ + "priority", + "access", + "sourceAddressPrefix" + ], + "title": "A network security group rule to apply to an inbound endpoint." + }, + "ComputeNodeEndpointConfiguration": { + "properties": { + "inboundEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/InboundEndpoint" + }, + "title": "The list of inbound endpoints that are accessible on the Compute Node." + } + }, + "required": [ + "inboundEndpoints" + ], + "title": "The endpoint configuration for the Compute Node." + }, + "InboundEndpoint": { + "properties": { + "name": { + "type": "string", + "title": "The name of the endpoint." + }, + "protocol": { + "$ref": "#/definitions/InboundEndpointProtocol", + "title": "The protocol of the endpoint." + }, + "publicIPAddress": { + "type": "string", + "title": "The public IP address of the Compute Node." + }, + "publicFQDN": { + "type": "string", + "title": "The public fully qualified domain name for the Compute Node." + }, + "frontendPort": { + "type": "integer", + "format": "int32", + "title": "The public port number of the endpoint." + }, + "backendPort": { + "type": "integer", + "format": "int32", + "title": "The backend port number of the endpoint." + } + }, + "required": [ + "name", + "protocol", + "publicIPAddress", + "publicFQDN", + "frontendPort", + "backendPort" + ], + "title": "An inbound endpoint on a Compute Node." + }, + "ComputeNodeListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ComputeNode" + }, + "title": "The list of Compute Nodes." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the Compute Nodes in a Pool." + }, + "ComputeNodeUser": { + "properties": { + "name": { + "type": "string", + "title": "The user name of the Account." + }, + "isAdmin": { + "type": "boolean", + "title": "Whether the Account should be an administrator on the Compute Node.", + "description": "The default value is false." + }, + "expiryTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Account should expire.", + "description": "If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day." + }, + "password": { + "type": "string", + "title": "The password of the Account.", + "description": "The password is required for Windows Compute Nodes (those created with 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' using a Windows Image reference). For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property." + }, + "sshPublicKey": { + "type": "string", + "title": "The SSH public key that can be used for remote login to the Compute Node.", + "description": "The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + } + }, + "required": [ + "name" + ], + "title": "A user Account for RDP or SSH access on a Compute Node." + }, + "ComputeNodeGetRemoteLoginSettingsResult": { + "properties": { + "remoteLoginIPAddress": { + "type": "string", + "title": "The IP address used for remote login to the Compute Node." + }, + "remoteLoginPort": { + "type": "integer", + "format": "int32", + "title": "The port used for remote login to the Compute Node." + } + }, + "required": [ + "remoteLoginIPAddress", + "remoteLoginPort" + ], + "title": "The remote login settings for a Compute Node." + }, + "JobSchedulePatchParameter": { + "properties": { + "schedule": { + "$ref": "#/definitions/Schedule", + "title": "The schedule according to which Jobs will be created.", + "description": "If you do not specify this element, the existing schedule is left unchanged." + }, + "jobSpecification": { + "$ref": "#/definitions/JobSpecification", + "title": "The details of the Jobs to be created on this schedule.", + "description": "Updates affect only Jobs that are started after the update has taken place. Any currently active Job continues with the older specification." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the Job Schedule as metadata.", + "description": "If you do not specify this element, existing metadata is left unchanged." + } + }, + "title": "The set of changes to be made to a Job Schedule." + }, + "JobScheduleUpdateParameter": { + "properties": { + "schedule": { + "$ref": "#/definitions/Schedule", + "title": "The schedule according to which Jobs will be created.", + "description": "If you do not specify this element, it is equivalent to passing the default schedule: that is, a single Job scheduled to run immediately." + }, + "jobSpecification": { + "$ref": "#/definitions/JobSpecification", + "title": "Details of the Jobs to be created on this schedule.", + "description": "Updates affect only Jobs that are started after the update has taken place. Any currently active Job continues with the older specification." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the Job Schedule as metadata.", + "description": "If you do not specify this element, it takes the default value of an empty list; in effect, any existing metadata is deleted." + } + }, + "required": [ + "schedule", + "jobSpecification" + ], + "title": "The set of changes to be made to a Job Schedule." + }, + "JobDisableParameter": { + "properties": { + "disableTasks": { + "type": "string", + "title": "What to do with active Tasks associated with the Job.", + "enum": [ + "requeue", + "terminate", + "wait" + ], + "x-ms-enum": { + "name": "DisableJobOption", + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running Tasks and requeue them. The Tasks will run again when the Job is enabled." + }, + { + "value": "terminate", + "description": "Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again." + }, + { + "value": "wait", + "description": "Allow currently running Tasks to complete." + } + ] + } + } + }, + "required": [ + "disableTasks" + ], + "title": "Options when disabling a Job." + }, + "JobTerminateParameter": { + "properties": { + "terminateReason": { + "type": "string", + "title": "The text you want to appear as the Job's TerminateReason. The default is 'UserTerminate'." + } + }, + "title": "Options when terminating a Job." + }, + "JobPatchParameter": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority of the Job.", + "description": "Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. If omitted, the priority of the Job is left unchanged." + }, + "onAllTasksComplete": { + "title": "The action the Batch service should take when all Tasks in the Job are in the completed state.", + "description": "If omitted, the completion behavior is left unchanged. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic Job termination, you cannot turn it off again. If you try to do this, the request fails with an 'invalid property value' error response; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", + "$ref": "#/definitions/OnAllTasksComplete" + }, + "constraints": { + "$ref": "#/definitions/JobConstraints", + "title": "The execution constraints for the Job.", + "description": "If omitted, the existing execution constraints are left unchanged." + }, + "poolInfo": { + "$ref": "#/definitions/PoolInformation", + "title": "The Pool on which the Batch service runs the Job's Tasks.", + "description": "You may change the Pool for a Job only when the Job is disabled. The Patch Job call will fail if you include the poolInfo element and the Job is not disabled. If you specify an autoPoolSpecification in the poolInfo, only the keepAlive property of the autoPoolSpecification can be updated, and then only if the autoPoolSpecification has a poolLifetimeOption of Job (other job properties can be updated as normal). If omitted, the Job continues to run on its current Pool." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the Job as metadata.", + "description": "If omitted, the existing Job metadata is left unchanged." + } + }, + "title": "The set of changes to be made to a Job." + }, + "JobUpdateParameter": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority of the Job.", + "description": "Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. If omitted, it is set to the default value 0." + }, + "constraints": { + "$ref": "#/definitions/JobConstraints", + "title": "The execution constraints for the Job.", + "description": "If omitted, the constraints are cleared." + }, + "poolInfo": { + "$ref": "#/definitions/PoolInformation", + "title": "The Pool on which the Batch service runs the Job's Tasks.", + "description": "You may change the Pool for a Job only when the Job is disabled. The Update Job call will fail if you include the poolInfo element and the Job is not disabled. If you specify an autoPoolSpecification in the poolInfo, only the keepAlive property of the autoPoolSpecification can be updated, and then only if the autoPoolSpecification has a poolLifetimeOption of Job (other job properties can be updated as normal)." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the Job as metadata.", + "description": "If omitted, it takes the default value of an empty list; in effect, any existing metadata is deleted." + }, + "onAllTasksComplete": { + "title": "The action the Batch service should take when all Tasks in the Job are in the completed state.", + "description": "If omitted, the completion behavior is set to noaction. If the current value is terminatejob, this is an error because a Job's completion behavior may not be changed from terminatejob to noaction. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic Job termination, you cannot turn it off again. If you try to do this, the request fails and Batch returns status code 400 (Bad Request) and an 'invalid property value' error response. If you do not specify this element in a PUT request, it is equivalent to passing noaction. This is an error if the current value is terminatejob.", + "$ref": "#/definitions/OnAllTasksComplete" + } + }, + "required": [ + "poolInfo" + ], + "title": "The set of changes to be made to a Job." + }, + "PoolEnableAutoScaleParameter": { + "properties": { + "autoScaleFormula": { + "type": "string", + "title": "The formula for the desired number of Compute Nodes in the Pool.", + "description": "The formula is checked for validity before it is applied to the Pool. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see Automatically scale Compute Nodes in an Azure Batch Pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling)." + }, + "autoScaleEvaluationInterval": { + "type": "string", + "format": "duration", + "title": "The time interval at which to automatically adjust the Pool size according to the autoscale formula.", + "description": "The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If you specify a new interval, then the existing autoscale evaluation schedule will be stopped and a new autoscale evaluation schedule will be started, with its starting time being the time when this request was issued." + } + }, + "title": "Options for enabling automatic scaling on a Pool." + }, + "PoolEvaluateAutoScaleParameter": { + "properties": { + "autoScaleFormula": { + "type": "string", + "title": "The formula for the desired number of Compute Nodes in the Pool.", + "description": "The formula is validated and its results calculated, but it is not applied to the Pool. To apply the formula to the Pool, 'Enable automatic scaling on a Pool'. For more information about specifying this formula, see Automatically scale Compute Nodes in an Azure Batch Pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling)." + } + }, + "required": [ + "autoScaleFormula" + ], + "title": "Options for evaluating an automatic scaling formula on a Pool." + }, + "PoolResizeParameter": { + "properties": { + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of dedicated Compute Nodes in the Pool." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of low-priority Compute Nodes in the Pool." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for allocation of Nodes to the Pool or removal of Compute Nodes from the Pool.", + "description": "The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "nodeDeallocationOption": { + "title": "Determines what to do with a Compute Node and its running task(s) if the Pool size is decreasing.", + "description": "The default value is requeue.", + "$ref": "#/definitions/ComputeNodeDeallocationOption" + } + }, + "title": "Options for changing the size of a Pool." + }, + "PoolUpdatePropertiesParameter": { + "properties": { + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted.", + "description": "If this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is removed from the Pool." + }, + "certificateReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateReference" + }, + "title": "A list of Certificates to be installed on each Compute Node in the Pool.", + "description": "This list replaces any existing Certificate references configured on the Pool. If you specify an empty collection, any existing Certificate references are removed from the Pool. For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "The list of Application Packages to be installed on each Compute Node in the Pool.", + "description": "The list replaces any existing Application Package references on the Pool. Changes to Application Package references affect all new Compute Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Application Package references on any given Pool. If omitted, or if you specify an empty collection, any existing Application Packages references are removed from the Pool. A maximum of 10 references may be specified on a given Pool." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the Pool as metadata.", + "description": "This list replaces any existing metadata configured on the Pool. If omitted, or if you specify an empty collection, any existing metadata is removed from the Pool." + } + }, + "required": [ + "certificateReferences", + "metadata", + "applicationPackageReferences" + ], + "title": "The set of changes to be made to a Pool." + }, + "PoolPatchParameter": { + "properties": { + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted.", + "description": "If this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is left unchanged." + }, + "certificateReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateReference" + }, + "title": "A list of Certificates to be installed on each Compute Node in the Pool.", + "description": "If this element is present, it replaces any existing Certificate references configured on the Pool. If omitted, any existing Certificate references are left unchanged. For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "A list of Packages to be installed on each Compute Node in the Pool.", + "description": "Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. If this element is present, it replaces any existing Package references. If you specify an empty collection, then all Package references are removed from the Pool. If omitted, any existing Package references are left unchanged." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the Pool as metadata.", + "description": "If this element is present, it replaces any existing metadata configured on the Pool. If you specify an empty collection, any metadata is removed from the Pool. If omitted, any existing metadata is left unchanged." + } + }, + "title": "The set of changes to be made to a Pool." + }, + "TaskUpdateParameter": { + "properties": { + "constraints": { + "$ref": "#/definitions/TaskConstraints", + "title": "Constraints that apply to this Task.", + "description": "If omitted, the Task is given the default constraints. For multi-instance Tasks, updating the retention time applies only to the primary Task and not subtasks." + } + }, + "title": "The set of changes to be made to a Task." + }, + "NodeUpdateUserParameter": { + "properties": { + "password": { + "type": "string", + "title": "The password of the Account.", + "description": "The password is required for Windows Compute Nodes (those created with 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' using a Windows Image reference). For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property. If omitted, any existing password is removed." + }, + "expiryTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Account should expire.", + "description": "If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day." + }, + "sshPublicKey": { + "type": "string", + "title": "The SSH public key that can be used for remote login to the Compute Node.", + "description": "The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If omitted, any existing SSH public key is removed." + } + }, + "title": "The set of changes to be made to a user Account on a Compute Node." + }, + "NodeRebootParameter": { + "properties": { + "nodeRebootOption": { + "type": "string", + "title": "When to reboot the Compute Node and what to do with currently running Tasks.", + "description": "The default value is requeue.", + "enum": [ + "requeue", + "terminate", + "taskcompletion", + "retaineddata" + ], + "x-ms-enum": { + "name": "ComputeNodeRebootOption", + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute Node is available. Restart the Compute Node as soon as Tasks have been terminated." + }, + { + "value": "terminate", + "description": "Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Restart the Compute Node as soon as Tasks have been terminated." + }, + { + "value": "taskcompletion", + "description": "Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Restart the Compute Node when all Tasks have completed.", + "name": "taskCompletion" + }, + { + "value": "retaineddata", + "description": "Allow currently running Tasks to complete, then wait for all Task data retention periods to expire. Schedule no new Tasks while waiting. Restart the Compute Node when all Task retention periods have expired.", + "name": "retainedData" + } + ] + } + } + }, + "title": "Options for rebooting a Compute Node." + }, + "NodeReimageParameter": { + "properties": { + "nodeReimageOption": { + "type": "string", + "title": "When to reimage the Compute Node and what to do with currently running Tasks.", + "description": "The default value is requeue.", + "enum": [ + "requeue", + "terminate", + "taskcompletion", + "retaineddata" + ], + "x-ms-enum": { + "name": "ComputeNodeReimageOption", + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute Node is available. Reimage the Compute Node as soon as Tasks have been terminated." + }, + { + "value": "terminate", + "description": "Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Reimage the Compute Node as soon as Tasks have been terminated." + }, + { + "value": "taskcompletion", + "description": "Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Reimage the Compute Node when all Tasks have completed.", + "name": "taskCompletion" + }, + { + "value": "retaineddata", + "description": "Allow currently running Tasks to complete, then wait for all Task data retention periods to expire. Schedule no new Tasks while waiting. Reimage the Compute Node when all Task retention periods have expired.", + "name": "retainedData" + } + ] + } + } + }, + "title": "Options for reimaging a Compute Node." + }, + "NodeDisableSchedulingParameter": { + "properties": { + "nodeDisableSchedulingOption": { + "type": "string", + "title": "What to do with currently running Tasks when disabling Task scheduling on the Compute Node.", + "description": "The default value is requeue.", + "enum": [ + "requeue", + "terminate", + "taskcompletion" + ], + "x-ms-enum": { + "name": "DisableComputeNodeSchedulingOption", + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running Task processes and requeue the Tasks. The Tasks may run again on other Compute Nodes, or when Task scheduling is re-enabled on this Compute Node. Enter offline state as soon as Tasks have been terminated." + }, + { + "value": "terminate", + "description": "Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Enter offline state as soon as Tasks have been terminated." + }, + { + "value": "taskcompletion", + "description": "Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Enter offline state when all Tasks have completed.", + "name": "taskCompletion" + } + ] + } + } + }, + "title": "Options for disabling scheduling on a Compute Node." + }, + "NodeRemoveParameter": { + "properties": { + "nodeList": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string" + }, + "title": "A list containing the IDs of the Compute Nodes to be removed from the specified Pool." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for removal of Compute Nodes to the Pool.", + "description": "The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "nodeDeallocationOption": { + "title": "Determines what to do with a Compute Node and its running task(s) after it has been selected for deallocation.", + "description": "The default value is requeue.", + "$ref": "#/definitions/ComputeNodeDeallocationOption" + } + }, + "required": [ + "nodeList" + ], + "title": "Options for removing Compute Nodes from a Pool." + }, + "OutputFile": { + "properties": { + "filePattern": { + "type": "string", + "title": "A pattern indicating which file(s) to upload.", + "description": "Both relative and absolute paths are supported. Relative paths are relative to the Task working directory. The following wildcards are supported: * matches 0 or more characters (for example pattern abc* would match abc or abcdef), ** matches any directory, ? matches any single character, [abc] matches one character in the brackets, and [a-c] matches one character in the range. Brackets can include a negation to match any character not specified (for example [!abc] matches any character but a, b, or c). If a file name starts with \".\" it is ignored by default but may be matched by specifying it explicitly (for example *.gif will not match .a.gif, but .*.gif will). A simple example: **\\*.txt matches any file that does not start in '.' and ends with .txt in the Task working directory or any subdirectory. If the filename contains a wildcard character it can be escaped using brackets (for example abc[*] would match a file named abc*). Note that both \\ and / are treated as directory separators on Windows, but only / is on Linux. Environment variables (%var% on Windows or $var on Linux) are expanded prior to the pattern being applied." + }, + "destination": { + "title": "The destination for the output file(s).", + "$ref": "#/definitions/OutputFileDestination" + }, + "uploadOptions": { + "title": "Additional options for the upload operation, including under what conditions to perform the upload.", + "$ref": "#/definitions/OutputFileUploadOptions" + } + }, + "required": [ + "filePattern", + "destination", + "uploadOptions" + ], + "title": "A specification for uploading files from an Azure Batch Compute Node to another location after the Batch service has finished executing the Task process.", + "description": "On every file uploads, Batch service writes two log files to the compute node, 'fileuploadout.txt' and 'fileuploaderr.txt'. These log files are used to learn more about a specific failure." + }, + "OutputFileDestination": { + "properties": { + "container": { + "title": "A location in Azure blob storage to which files are uploaded.", + "$ref": "#/definitions/OutputFileBlobContainerDestination" + } + }, + "title": "The destination to which a file should be uploaded." + }, + "OutputFileBlobContainerDestination": { + "properties": { + "path": { + "type": "string", + "title": "The destination blob or virtual directory within the Azure Storage container.", + "description": "If filePattern refers to a specific file (i.e. contains no wildcards), then path is the name of the blob to which to upload that file. If filePattern contains one or more wildcards (and therefore may match multiple files), then path is the name of the blob virtual directory (which is prepended to each blob name) to which to upload the file(s). If omitted, file(s) are uploaded to the root of the container with a blob name matching their file name." + }, + "containerUrl": { + "type": "string", + "title": "The URL of the container within Azure Blob Storage to which to upload the file(s).", + "description": "The URL must include a Shared Access Signature (SAS) granting write permissions to the container." + } + }, + "required": [ + "containerUrl" + ], + "title": "Specifies a file upload destination within an Azure blob storage container." + }, + "OutputFileUploadOptions": { + "properties": { + "uploadCondition": { + "title": "The conditions under which the Task output file or set of files should be uploaded.", + "description": "The default is taskcompletion.", + "$ref": "#/definitions/OutputFileUploadCondition" + } + }, + "required": [ + "uploadCondition" + ], + "title": "Details about an output file upload operation, including under what conditions to perform the upload." + }, + "ErrorMessage": { + "properties": { + "lang": { + "type": "string", + "title": "The language code of the error message" + }, + "value": { + "type": "string", + "title": "The text of the message." + } + }, + "title": "An error message received in an Azure Batch error response." + }, + "BatchErrorDetail": { + "properties": { + "key": { + "type": "string", + "title": "An identifier specifying the meaning of the Value property." + }, + "value": { + "type": "string", + "title": "The additional information included with the error response." + } + }, + "title": "An item of additional information included in an Azure Batch error response." + }, + "BatchError": { + "properties": { + "code": { + "type": "string", + "title": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "$ref": "#/definitions/ErrorMessage", + "title": "A message describing the error, intended to be suitable for display in a user interface." + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/BatchErrorDetail" + }, + "title": "A collection of key-value pairs containing additional details about the error." + } + }, + "title": "An error response received from the Azure Batch service." + }, + "CertificateState": { + "type": "string", + "title": "The state of the Certificate.", + "enum": [ + "active", + "deleting", + "deletefailed" + ], + "x-ms-enum": { + "name": "CertificateState", + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The Certificate is available for use in Pools." + }, + { + "value": "deleting", + "description": "The user has requested that the Certificate be deleted, but the delete operation has not yet completed. You may not reference the Certificate when creating or updating Pools." + }, + { + "value": "deletefailed", + "description": "The user requested that the Certificate be deleted, but there are Pools that still have references to the Certificate, or it is still installed on one or more Nodes. (The latter can occur if the Certificate has been removed from the Pool, but the Compute Node has not yet restarted. Compute Nodes refresh their Certificates only when they restart.) You may use the cancel Certificate delete operation to cancel the delete, or the delete Certificate operation to retry the delete.", + "name": "deleteFailed" + } + ] + } + }, + "ElevationLevel": { + "type": "string", + "title": "The elevation level of the user.", + "enum": [ + "nonadmin", + "admin" + ], + "x-ms-enum": { + "name": "ElevationLevel", + "modelAsString": false, + "values": [ + { + "value": "nonadmin", + "description": "The user is a standard user without elevated access.", + "name": "nonAdmin" + }, + { + "value": "admin", + "description": "The user is a user with elevated access and operates with full Administrator permissions." + } + ] + } + }, + "JobScheduleState": { + "type": "string", + "title": "The state of the Job Schedule.", + "enum": [ + "active", + "completed", + "disabled", + "terminating", + "deleting" + ], + "x-ms-enum": { + "name": "JobScheduleState", + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The Job Schedule is active and will create Jobs as per its schedule." + }, + { + "value": "completed", + "description": "The Job Schedule has terminated, either by reaching its end time or by the user terminating it explicitly." + }, + { + "value": "disabled", + "description": "The user has disabled the Job Schedule. The scheduler will not initiate any new Jobs will on this schedule, but any existing active Job will continue to run." + }, + { + "value": "terminating", + "description": "The Job Schedule has no more work to do, or has been explicitly terminated by the user, but the termination operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, nor is any existing Job active." + }, + { + "value": "deleting", + "description": "The user has requested that the Job Schedule be deleted, but the delete operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, and will delete any existing Jobs and Tasks under the Job Schedule, including any active Job. The Job Schedule will be deleted when all Jobs and Tasks under the Job Schedule have been deleted." + } + ] + } + }, + "JobState": { + "type": "string", + "title": "The state of the Job.", + "enum": [ + "active", + "disabling", + "disabled", + "enabling", + "terminating", + "completed", + "deleting" + ], + "x-ms-enum": { + "name": "JobState", + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The Job is available to have Tasks scheduled." + }, + { + "value": "disabling", + "description": "A user has requested that the Job be disabled, but the disable operation is still in progress (for example, waiting for Tasks to terminate)." + }, + { + "value": "disabled", + "description": "A user has disabled the Job. No Tasks are running, and no new Tasks will be scheduled." + }, + { + "value": "enabling", + "description": "A user has requested that the Job be enabled, but the enable operation is still in progress." + }, + { + "value": "terminating", + "description": "The Job is about to complete, either because a Job Manager Task has completed or because the user has terminated the Job, but the terminate operation is still in progress (for example, because Job Release Tasks are running)." + }, + { + "value": "completed", + "description": "All Tasks have terminated, and the system will not accept any more Tasks or any further changes to the Job." + }, + { + "value": "deleting", + "description": "A user has requested that the Job be deleted, but the delete operation is still in progress (for example, because the system is still terminating running Tasks)." + } + ] + } + }, + "OnAllTasksComplete": { + "type": "string", + "title": "The action the Batch service should take when all Tasks in the Job are in the completed state.", + "enum": [ + "noaction", + "terminatejob" + ], + "x-ms-enum": { + "name": "OnAllTasksComplete", + "modelAsString": false, + "values": [ + { + "value": "noaction", + "description": "Do nothing. The Job remains active unless terminated or disabled by some other means.", + "name": "noAction" + }, + { + "value": "terminatejob", + "description": "Terminate the Job. The Job's terminateReason is set to 'AllTasksComplete'.", + "name": "terminateJob" + } + ] + } + }, + "OnTaskFailure": { + "type": "string", + "title": "The action the Batch service should take when any Task in the Job fails.", + "description": "A Task is considered to have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction.", + "enum": [ + "noaction", + "performexitoptionsjobaction" + ], + "x-ms-enum": { + "name": "OnTaskFailure", + "modelAsString": false, + "values": [ + { + "value": "noaction", + "description": "Do nothing. The Job remains active unless terminated or disabled by some other means.", + "name": "noAction" + }, + { + "value": "performexitoptionsjobaction", + "description": "Take the action associated with the Task exit condition in the Task's exitConditions collection. (This may still result in no action being taken, if that is what the Task specifies.)", + "name": "performExitOptionsJobAction" + } + ] + } + }, + "ErrorCategory": { + "type": "string", + "title": "The category of the error.", + "enum": [ + "usererror", + "servererror" + ], + "x-ms-enum": { + "name": "ErrorCategory", + "modelAsString": false, + "values": [ + { + "value": "usererror", + "description": "The error is due to a user issue, such as misconfiguration.", + "name": "userError" + }, + { + "value": "servererror", + "description": "The error is due to an internal server issue.", + "name": "serverError" + } + ] + } + }, + "TaskState": { + "type": "string", + "title": "The state of the Task.", + "enum": [ + "active", + "preparing", + "running", + "completed" + ], + "x-ms-enum": { + "name": "TaskState", + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The Task is queued and able to run, but is not currently assigned to a Compute Node. A Task enters this state when it is created, when it is enabled after being disabled, or when it is awaiting a retry after a failed run." + }, + { + "value": "preparing", + "description": "The Task has been assigned to a Compute Node, but is waiting for a required Job Preparation Task to complete on the Compute Node. If the Job Preparation Task succeeds, the Task will move to running. If the Job Preparation Task fails, the Task will return to active and will be eligible to be assigned to a different Compute Node." + }, + { + "value": "running", + "description": "The Task is running on a Compute Node. This includes task-level preparation such as downloading resource files or deploying Packages specified on the Task - it does not necessarily mean that the Task command line has started executing." + }, + { + "value": "completed", + "description": "The Task is no longer eligible to run, usually because the Task has finished successfully, or the Task has finished unsuccessfully and has exhausted its retry limit. A Task is also marked as completed if an error occurred launching the Task, or when the Task has been terminated." + } + ] + } + }, + "SubtaskState": { + "type": "string", + "title": "The state of the subtask.", + "enum": [ + "preparing", + "running", + "completed" + ], + "x-ms-enum": { + "name": "SubtaskState", + "modelAsString": false, + "values": [ + { + "value": "preparing", + "description": "The Task has been assigned to a Compute Node, but is waiting for a required Job Preparation Task to complete on the Compute Node. If the Job Preparation Task succeeds, the Task will move to running. If the Job Preparation Task fails, the Task will return to active and will be eligible to be assigned to a different Compute Node." + }, + { + "value": "running", + "description": "The Task is running on a Compute Node. This includes task-level preparation such as downloading resource files or deploying Packages specified on the Task - it does not necessarily mean that the Task command line has started executing." + }, + { + "value": "completed", + "description": "The Task is no longer eligible to run, usually because the Task has finished successfully, or the Task has finished unsuccessfully and has exhausted its retry limit. A Task is also marked as completed if an error occurred launching the Task, or when the Task has been terminated." + } + ] + } + }, + "ComputeNodeDeallocationOption": { + "type": "string", + "title": "Determines what to do with a Compute Node and its running task(s) after it has been selected for deallocation.", + "description": "The default value is requeue.", + "enum": [ + "requeue", + "terminate", + "taskcompletion", + "retaineddata" + ], + "x-ms-enum": { + "name": "ComputeNodeDeallocationOption", + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute Node is available. Remove Compute Nodes as soon as Tasks have been terminated." + }, + { + "value": "terminate", + "description": "Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove Compute Nodes as soon as Tasks have been terminated." + }, + { + "value": "taskcompletion", + "description": "Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Remove Compute Nodes when all Tasks have completed.", + "name": "taskCompletion" + }, + { + "value": "retaineddata", + "description": "Allow currently running Tasks to complete, then wait for all Task data retention periods to expire. Schedule no new Tasks while waiting. Remove Compute Nodes when all Task retention periods have expired.", + "name": "retainedData" + } + ] + } + }, + "OutputFileUploadCondition": { + "type": "string", + "title": "The conditions under which a Task output file or set of files should be uploaded.", + "enum": [ + "tasksuccess", + "taskfailure", + "taskcompletion" + ], + "x-ms-enum": { + "name": "OutputFileUploadCondition", + "modelAsString": false, + "values": [ + { + "value": "tasksuccess", + "description": "Upload the file(s) only after the Task process exits with an exit code of 0.", + "name": "taskSuccess" + }, + { + "value": "taskfailure", + "description": "Upload the file(s) only after the Task process exits with a nonzero exit code.", + "name": "taskFailure" + }, + { + "value": "taskcompletion", + "description": "Upload the file(s) after the Task process exits, no matter what the exit code was.", + "name": "taskCompletion" + } + ] + } + }, + "TaskExecutionResult": { + "type": "string", + "title": "The result of Task execution.", + "enum": [ + "success", + "failure" + ], + "x-ms-enum": { + "name": "TaskExecutionResult", + "modelAsString": false, + "values": [ + { + "value": "success", + "description": "The Task ran successfully.", + "name": "success" + }, + { + "value": "failure", + "description": "There was an error during processing of the Task. The failure may have occurred before the Task process was launched, while the Task process was executing, or after the Task process exited.", + "name": "failure" + } + ] + } + }, + "InboundEndpointProtocol": { + "type": "string", + "title": "The protocol of the endpoint.", + "enum": [ + "tcp", + "udp" + ], + "x-ms-enum": { + "name": "InboundEndpointProtocol", + "modelAsString": false, + "values": [ + { + "value": "tcp", + "description": "Use TCP for the endpoint.", + "name": "tcp" + }, + { + "value": "udp", + "description": "Use UDP for the endpoint.", + "name": "udp" + } + ] + } + }, + "UploadBatchServiceLogsConfiguration": { + "properties": { + "containerUrl": { + "type": "string", + "title": "The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s).", + "description": "The URL must include a Shared Access Signature (SAS) granting write permissions to the container. The SAS duration must allow enough time for the upload to finish. The start time for SAS is optional and recommended to not be specified." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start of the time range from which to upload Batch Service log file(s).", + "description": "Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The end of the time range from which to upload Batch Service log file(s).", + "description": "Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested. If omitted, the default is to upload all logs available after the startTime." + } + }, + "required": [ + "containerUrl", + "startTime" + ], + "title": "The Azure Batch service log files upload configuration for a Compute Node." + }, + "UploadBatchServiceLogsResult": { + "properties": { + "virtualDirectoryName": { + "type": "string", + "title": "The virtual directory within Azure Blob Storage container to which the Batch Service log file(s) will be uploaded.", + "description": "The virtual directory name is part of the blob name for each log file uploaded, and it is built based poolId, nodeId and a unique identifier." + }, + "numberOfFilesUploaded": { + "type": "integer", + "format": "int32", + "title": "The number of log files which will be uploaded." + } + }, + "required": [ + "virtualDirectoryName", + "numberOfFilesUploaded" + ], + "title": "The result of uploading Batch service log files from a specific Compute Node." + }, + "PoolNodeCountsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PoolNodeCounts" + }, + "description": "A list of Compute Node counts by Pool." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the Compute Node counts in the Account." + }, + "PoolNodeCounts": { + "properties": { + "poolId": { + "type": "string", + "title": "The ID of the Pool." + }, + "dedicated": { + "$ref": "#/definitions/NodeCounts", + "title": "The number of dedicated Compute Nodes in each state." + }, + "lowPriority": { + "$ref": "#/definitions/NodeCounts", + "title": "The number of low priority Compute Nodes in each state." + } + }, + "required": [ + "poolId" + ], + "title": "The number of Compute Nodes in each state for a Pool." + }, + "NodeCounts": { + "properties": { + "creating": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the creating state." + }, + "idle": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the idle state." + }, + "offline": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the offline state." + }, + "preempted": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the preempted state." + }, + "rebooting": { + "type": "integer", + "format": "int32", + "title": "The count of Compute Nodes in the rebooting state." + }, + "reimaging": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the reimaging state." + }, + "running": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the running state." + }, + "starting": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the starting state." + }, + "startTaskFailed": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the startTaskFailed state." + }, + "leavingPool": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the leavingPool state." + }, + "unknown": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the unknown state." + }, + "unusable": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the unusable state." + }, + "waitingForStartTask": { + "type": "integer", + "format": "int32", + "title": "The number of Compute Nodes in the waitingForStartTask state." + }, + "total": { + "type": "integer", + "format": "int32", + "title": "The total number of Compute Nodes." + } + }, + "required": [ + "creating", + "idle", + "offline", + "preempted", + "rebooting", + "reimaging", + "running", + "starting", + "startTaskFailed", + "leavingPool", + "unknown", + "unusable", + "waitingForStartTask", + "total" + ], + "title": "The number of Compute Nodes in each Compute Node state." + }, + "MountConfiguration": { + "properties": { + "azureBlobFileSystemConfiguration": { + "$ref": "#/definitions/AzureBlobFileSystemConfiguration", + "title": "The Azure Storage Container to mount using blob FUSE on each node.", + "description": "This property is mutually exclusive with all other properties." + }, + "nfsMountConfiguration": { + "$ref": "#/definitions/NFSMountConfiguration", + "title": "The NFS file system to mount on each node.", + "description": "This property is mutually exclusive with all other properties." + }, + "cifsMountConfiguration": { + "$ref": "#/definitions/CIFSMountConfiguration", + "title": "The CIFS/SMB file system to mount on each node.", + "description": "This property is mutually exclusive with all other properties." + }, + "azureFileShareConfiguration": { + "$ref": "#/definitions/AzureFileShareConfiguration", + "title": "The Azure File Share to mount on each node.", + "description": "This property is mutually exclusive with all other properties." + } + }, + "title": "The file system to mount on each node." + }, + "AzureBlobFileSystemConfiguration": { + "properties": { + "accountName": { + "type": "string", + "title": "The Azure Storage Account name." + }, + "containerName": { + "type": "string", + "title": "The Azure Blob Storage Container name." + }, + "accountKey": { + "type": "string", + "title": "The Azure Storage Account key.", + "description": "This property is mutually exclusive with sasKey and one must be specified." + }, + "sasKey": { + "type": "string", + "title": "The Azure Storage SAS token.", + "description": "This property is mutually exclusive with accountKey and one must be specified." + }, + "blobfuseOptions": { + "type": "string", + "title": "Additional command line options to pass to the mount command.", + "description": "These are 'net use' options in Windows and 'mount' options in Linux." + }, + "relativeMountPath": { + "type": "string", + "title": "The relative path on the compute node where the file system will be mounted", + "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." + } + }, + "required": [ + "accountName", + "containerName", + "relativeMountPath" + ], + "title": "Information used to connect to an Azure Storage Container using Blobfuse." + }, + "NFSMountConfiguration": { + "properties": { + "source": { + "type": "string", + "title": "The URI of the file system to mount." + }, + "relativeMountPath": { + "type": "string", + "title": "The relative path on the compute node where the file system will be mounted", + "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." + }, + "mountOptions": { + "type": "string", + "title": "Additional command line options to pass to the mount command.", + "description": "These are 'net use' options in Windows and 'mount' options in Linux." + } + }, + "required": [ + "source", + "relativeMountPath" + ], + "title": "Information used to connect to an NFS file system." + }, + "CIFSMountConfiguration": { + "properties": { + "username": { + "type": "string", + "title": "The user to use for authentication against the CIFS file system." + }, + "source": { + "type": "string", + "title": "The URI of the file system to mount." + }, + "relativeMountPath": { + "type": "string", + "title": "The relative path on the compute node where the file system will be mounted", + "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." + }, + "mountOptions": { + "type": "string", + "title": "Additional command line options to pass to the mount command.", + "description": "These are 'net use' options in Windows and 'mount' options in Linux." + }, + "password": { + "type": "string", + "title": "The password to use for authentication against the CIFS file system." + } + }, + "required": [ + "username", + "source", + "password", + "relativeMountPath" + ], + "title": "Information used to connect to a CIFS file system." + }, + "AzureFileShareConfiguration": { + "properties": { + "accountName": { + "type": "string", + "title": "The Azure Storage account name." + }, + "azureFileUrl": { + "type": "string", + "title": "The Azure Files URL.", + "description": "This is of the form 'https://{account}.file.core.windows.net/'." + }, + "accountKey": { + "type": "string", + "title": "The Azure Storage account key." + }, + "relativeMountPath": { + "type": "string", + "title": "The relative path on the compute node where the file system will be mounted", + "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." + }, + "mountOptions": { + "type": "string", + "title": "Additional command line options to pass to the mount command.", + "description": "These are 'net use' options in Windows and 'mount' options in Linux." + } + }, + "required": [ + "accountName", + "azureFileUrl", + "accountKey", + "relativeMountPath" + ], + "title": "Information used to connect to an Azure Fileshare." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API Version." + }, + "batchUrl": { + "name": "batchUrl", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "description": "The base URL for all Azure Batch service requests." + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/AccountListPoolNodeCounts.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/AccountListPoolNodeCounts.json new file mode 100644 index 000000000000..fd5329b8a55d --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/AccountListPoolNodeCounts.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "poolId": "pool1", + "dedicated": { + "creating": 0, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "total": 0 + }, + "lowPriority": { + "creating": 0, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 2, + "starting": 1, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "total": 3 + } + }, + { + "poolId": "pool2", + "dedicated": { + "creating": 0, + "idle": 1, + "leavingPool": 0, + "offline": 3, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "total": 4 + }, + "lowPriority": { + "creating": 0, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "total": 0 + } + }, + { + "poolId": "pool3", + "dedicated": { + "creating": 0, + "idle": 5, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 4, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "total": 9 + }, + "lowPriority": { + "creating": 7, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 4, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "total": 11 + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/AccountListSupportedImages.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/AccountListSupportedImages.json new file mode 100644 index 000000000000..9e44b35f461f --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/AccountListSupportedImages.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "nodeAgentSKUId": "batch.node.centos 7", + "imageReference": { + "publisher": "OpenLogic", + "offer": "CentOS", + "sku": "7.2", + "version": "latest" + }, + "verificationType": "verified", + "capabilities": [ + "DockerCompatible", + "NvidiaTeslaDriverInstalled" + ], + "osType": "linux" + }, + { + "nodeAgentSKUId": "batch.node.centos 7", + "imageReference": { + "publisher": "OpenLogic", + "offer": "CentOS", + "sku": "7.1", + "version": "latest" + }, + "verificationType": "unverified", + "osType": "linux", + "batchSupportEndOfLife": "2019-11-01T00:00:00.0Z" + }, + { + "nodeAgentSKUId": "batch.node.debian 8", + "imageReference": { + "publisher": "Credativ", + "offer": "Debian", + "sku": "8", + "version": "latest" + }, + "verificationType": "verified", + "osType": "linux" + }, + { + "nodeAgentSKUId": "batch.node.windows amd64", + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "latest" + }, + "verificationType": "verified", + "osType": "windows" + }, + { + "nodeAgentSKUId": "batch.node.windows amd64", + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-Datacenter", + "version": "latest" + }, + "verificationType": "verified", + "osType": "windows" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/ApplicationGet.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/ApplicationGet.json new file mode 100644 index 000000000000..c668e0cc8b5c --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/ApplicationGet.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "applicationId": "my_application_id" + }, + "responses": { + "200": { + "body": { + "id": "my_application_id", + "versions": [ + "v1.0" + ], + "displayName": "my_display_name" + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/ApplicationList.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/ApplicationList.json new file mode 100644 index 000000000000..6da4a4f8240c --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/ApplicationList.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "my_application_id", + "versions": [ + "v1.0" + ], + "displayName": "my_display_name" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/CertificateAdd.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/CertificateAdd.json new file mode 100644 index 000000000000..51d9f44dc128 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/CertificateAdd.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "certificate": { + "thumbprintAlgorithm": "sha1", + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "data": "#####...", + "certificateFormat": "pfx", + "password": "certpassword" + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/CertificateCancelDelete.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/CertificateCancelDelete.json new file mode 100644 index 000000000000..5d12eb51782d --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/CertificateCancelDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "thumbprintAlgorithm": "sha1", + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/CertificateDelete.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/CertificateDelete.json new file mode 100644 index 000000000000..d9a41ac18fd7 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/CertificateDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "thumbprintAlgorithm": "sha1", + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/CertificateGet.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/CertificateGet.json new file mode 100644 index 000000000000..4edfd98d70ec --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/CertificateGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "thumbprintAlgorithm": "sha1", + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "thumbprintAlgorithm": "sha1", + "url": "https://account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567)", + "state": "deletefailed", + "stateTransitionTime": "2014-07-31T21:12:58.236Z", + "previousState": "deleting", + "previousStateTransitionTime": "2014-07-31T21:11:58.236Z", + "publicData": "#####...", + "deleteCertificateError": { + "code": "PoolsReferencingCertificate", + "message": "The specified certificate is being used by the below mentioned pool(s)", + "values": [ + { + "name": "Pools", + "value": "mypool1" + } + ] + } + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/CertificateList.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/CertificateList.json new file mode 100644 index 000000000000..505982b557ec --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/CertificateList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "thumbprintAlgorithm": "sha1", + "url": "https://account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567)", + "state": "deletefailed", + "stateTransitionTime": "2014-07-31T21:12:58.236Z", + "previousState": "deleting", + "previousStateTransitionTime": "2014-07-31T21:11:58.236Z", + "publicData": "#####...", + "deleteCertificateError": { + "code": "PoolsReferencingCertificate", + "message": "The specified certificate is being used by the below mentioned pool(s)", + "values": [ + { + "name": "Pools", + "value": "mypool1" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileDeleteFromNode.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileDeleteFromNode.json new file mode 100644 index 000000000000..7e50e97535b7 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileDeleteFromNode.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileDeleteFromTask.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileDeleteFromTask.json new file mode 100644 index 000000000000..83cdc5d8a44d --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileDeleteFromTask.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "taskId": "task1", + "filePath": "wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileGetFromNode.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileGetFromNode.json new file mode 100644 index 000000000000..5c8caab50236 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileGetFromNode.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "nodeId": "nodeId", + "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream", + "body": "This is actually a byte stream. This request/response is being presented as a string for readability in the example" + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileGetFromTask.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileGetFromTask.json new file mode 100644 index 000000000000..d91097ed9b81 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileGetFromTask.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "taskId": "task1", + "filePath": "wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream", + "body": "This is actually a byte stream. This request/response is being presented as a string for readability in the example" + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileGetPropertiesFromNode.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileGetPropertiesFromNode.json new file mode 100644 index 000000000000..4018bb01a152 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileGetPropertiesFromNode.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "nodeId": "nodeId", + "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream" + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileGetPropertiesFromTask.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileGetPropertiesFromTask.json new file mode 100644 index 000000000000..94a53b325051 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileGetPropertiesFromTask.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "taskId": "taskId", + "filePath": "wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream" + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileListFromNode.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileListFromNode.json new file mode 100644 index 000000000000..4f7a05445642 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileListFromNode.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "shared", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/shared", + "isDirectory": true + }, + { + "name": "startup\\ProcessEnv.cmd", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup\\ProcessEnv.cmd", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.679195Z", + "lastModified": "2014-09-19T21:56:17.679195Z", + "contentLength": 1813, + "contentType": "application/octet-stream" + } + }, + { + "name": "startup\\stderr.txt", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup\\stderr.txt", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.5590855Z", + "lastModified": "2014-09-19T21:56:17.5590855Z", + "contentLength": 0, + "contentType": "application/octet-stream" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileListFromTask.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileListFromTask.json new file mode 100644 index 000000000000..641cb5c09b2c --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/FileListFromTask.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "startup\\ProcessEnv.cmd", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\ProcessEnv.cmd", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.679195Z", + "lastModified": "2014-09-19T21:56:17.679195Z", + "contentLength": 1813, + "contentType": "application/octet-stream" + } + }, + { + "name": "startup\\stderr.txt", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\stderr.txt", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.5590855Z", + "lastModified": "2014-09-19T21:56:17.5590855Z", + "contentLength": 0, + "contentType": "application/octet-stream" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobAdd_Basic.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobAdd_Basic.json new file mode 100644 index 000000000000..bb1e4709ff40 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobAdd_Basic.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "job": { + "id": "jobId", + "priority": 0, + "poolInfo": { + "poolId": "poolId" + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobAdd_Complex.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobAdd_Complex.json new file mode 100644 index 000000000000..dd0de6b2d6a7 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobAdd_Complex.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "job": { + "id": "jobId", + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "jobManagerTask": { + "id": "taskId", + "commandLine": "myprogram.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas", + "filePath": "myprogram.exe" + }, + { + "storageContainerUrl": "http://mystorage1.blob.core.windows.net/data?sas", + "filePath": "datafolder" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": 0, + "retentionTime": "PT1H" + }, + "requiredSlots": 2, + "killJobOnCompletion": false, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "admin" + } + }, + "runExclusive": true + }, + "poolInfo": { + "autoPoolSpecification": { + "autoPoolIdPrefix": "mypool", + "poolLifetimeOption": "job", + "pool": { + "vmSize": "small", + "cloudServiceConfiguration": { + "osFamily": "4", + "osVersion": "*" + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 2, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "startTask": { + "commandLine": "myprogram2.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas", + "filePath": "myprogram2.exe" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "admin" + } + }, + "maxTaskRetryCount": 2, + "waitForSuccess": true + }, + "certificateReferences": [ + { + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "thumbprintAlgorithm": "sha1", + "storeLocation": "localmachine", + "storeName": "Root", + "visibility": [ + "task" + ] + } + ], + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + } + }, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobDelete.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobDelete.json new file mode 100644 index 000000000000..3b296a3c42c6 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobDisable.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobDisable.json new file mode 100644 index 000000000000..76e59fa0de45 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobDisable.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobDisableParameter": { + "disableTasks": "terminate" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobEnable.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobEnable.json new file mode 100644 index 000000000000..3b296a3c42c6 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobEnable.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobGet.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobGet.json new file mode 100644 index 000000000000..b27d2338b3f9 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobGet.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "jobId", + "url": "https://account.region.batch.azure.com/jobs/jobId", + "eTag": "0x8D4100FC49F0278", + "lastModified": "2016-11-19T00:05:27.5391608Z", + "creationTime": "2016-11-19T00:05:25.311915Z", + "state": "completed", + "stateTransitionTime": "2016-11-19T00:05:27.578581Z", + "previousState": "active", + "previousStateTransitionTime": "2016-11-19T00:05:27.2137716Z", + "priority": 0, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + }, + "executionInfo": { + "startTime": "2016-11-19T00:05:25.3309105Z", + "endTime": "2016-11-19T00:05:27.578581Z", + "poolId": "poolId", + "terminateReason": "UserTerminate" + }, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobGetLifetimeStatistics.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobGetLifetimeStatistics.json new file mode 100644 index 000000000000..906a39988de6 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobGetLifetimeStatistics.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "url": "https://account.region.batch.core.windows.net/lifetimejobstats", + "startTime": "2014-08-01T18:30:00.4345729Z", + "lastUpdateTime": "2014-08-04T18:30:00.4345729Z", + "userCPUTime": "PT0S", + "kernelCPUTime": "PT0S", + "wallClockTime": "PT0S", + "readIOps": 0, + "writeIOps": 0, + "readIOGiB": 10.0, + "writeIOGiB": 5.0, + "numSucceededTasks": 0, + "numFailedTasks": 0, + "numTaskRetries": 0, + "waitTime": "PT0S" + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobGetTaskCounts.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobGetTaskCounts.json new file mode 100644 index 000000000000..2a4691f25abb --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobGetTaskCounts.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "taskCounts": { + "active": 5, + "running": 7, + "completed": 4, + "succeeded": 2, + "failed": 2 + }, + "taskSlotCounts": { + "active": 5, + "running": 7, + "completed": 4, + "succeeded": 2, + "failed": 2 + } + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobList.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobList.json new file mode 100644 index 000000000000..43990e520346 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "jobId", + "url": "https://account.region.batch.azure.com/jobs/jobId", + "eTag": "0x8D4100FC46D5BF4", + "lastModified": "2016-11-19T00:05:27.2137716Z", + "creationTime": "2016-11-19T00:05:25.311915Z", + "state": "active", + "stateTransitionTime": "2016-11-19T00:05:27.2137716Z", + "previousState": "disabled", + "previousStateTransitionTime": "2016-11-19T00:05:26.88777Z", + "priority": 0, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + }, + "executionInfo": { + "startTime": "2016-11-19T00:05:25.3309105Z", + "poolId": "poolId" + }, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobListFromJobSchedule.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobListFromJobSchedule.json new file mode 100644 index 000000000000..67c7d3b4a2ea --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobListFromJobSchedule.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "jobId", + "url": "https://account.region.batch.azure.com/jobs/jobId", + "eTag": "0x8D4100FC46D5BF4", + "lastModified": "2016-11-19T00:05:27.2137716Z", + "creationTime": "2016-11-19T00:05:25.311915Z", + "state": "active", + "stateTransitionTime": "2016-11-19T00:05:27.2137716Z", + "previousState": "disabled", + "previousStateTransitionTime": "2016-11-19T00:05:26.88777Z", + "priority": 0, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + }, + "executionInfo": { + "startTime": "2016-11-19T00:05:25.3309105Z", + "poolId": "poolId" + }, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobListPreparationAndReleaseTaskStatus.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobListPreparationAndReleaseTaskStatus.json new file mode 100644 index 000000000000..396b2e4581f1 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobListPreparationAndReleaseTaskStatus.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "poolId": "poolId", + "nodeId": "tvm-2167304207_1-20140905t174658z", + "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z", + "jobPreparationTaskExecutionInfo": { + "state": "completed", + "startTime": "2015-05-01T10:20:31Z", + "endTime": "2015-05-02T20:12:42Z", + "taskRootDirectory": "tasks/myjob/job-1/myjobpreptask", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobpreptask", + "exitCode": 0, + "retryCount": 0 + }, + "jobReleaseTaskExecutionInfo": { + "state": "completed", + "startTime": "2015-05-01T10:20:31Z", + "endTime": "2015-05-02T20:12:42Z", + "taskRootDirectory": "tasks/myjob/job-1/myjobreleasetask", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobreleasetask", + "exitCode": 0 + } + } + ], + "odata.nextLink": "https://account.region.batch.azure.com/jobs/myjob/jobpreparationandreleasestatus?$skipToken=tvm-2167304207_1-20140905t174658z&api-version=2020-09-01.12.0" + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobPatch.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobPatch.json new file mode 100644 index 000000000000..2e28d3734615 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobPatch.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobPatchParameter": { + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "poolInfo": { + "poolId": "poolId" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleAdd_Basic.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleAdd_Basic.json new file mode 100644 index 000000000000..8cef6bca6462 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleAdd_Basic.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "cloudJobSchedule": { + "id": "jobScheduleId", + "schedule": { + "recurrenceInterval": "PT5M" + }, + "jobSpecification": { + "poolInfo": { + "poolId": "poolId" + } + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleAdd_Complex.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleAdd_Complex.json new file mode 100644 index 000000000000..3a0ab999490a --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleAdd_Complex.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "cloudJobSchedule": { + "id": "jobScheduleId", + "schedule": { + "doNotRunUntil": "2014-09-10T02:30:00.000Z", + "doNotRunAfter": "2014-09-10T06:30:00.000Z", + "startWindow": "PT1M", + "recurrenceInterval": "PT5M" + }, + "jobSpecification": { + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "jobManagerTask": { + "id": "mytask1", + "commandLine": "myprogram.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas", + "filePath": "myprogram.exe" + }, + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/test.txt?sas", + "filePath": "test.txt" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": 0, + "retentionTime": "PT1H" + }, + "requiredSlots": 2, + "killJobOnCompletion": true, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "runExclusive": true + }, + "poolInfo": { + "autoPoolSpecification": { + "autoPoolIdPrefix": "mypool", + "poolLifetimeOption": "jobschedule", + "pool": { + "vmSize": "small", + "cloudServiceConfiguration": { + "osFamily": "4", + "osVersion": "*" + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 2, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "startTask": { + "commandLine": "myprogram2.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas", + "filePath": "myprogram2.exe" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "admin" + } + }, + "maxTaskRetryCount": 2, + "waitForSuccess": true + }, + "certificateReferences": [ + { + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "thumbprintAlgorithm": "sha1", + "storeLocation": "localmachine", + "storeName": "Root", + "visibility": [ + "task" + ] + } + ], + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + } + } + }, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleDelete.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleDelete.json new file mode 100644 index 000000000000..14e0811ce888 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleDisable.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleDisable.json new file mode 100644 index 000000000000..287b1c271025 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleDisable.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleEnable.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleEnable.json new file mode 100644 index 000000000000..287b1c271025 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleEnable.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleExists.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleExists.json new file mode 100644 index 000000000000..93bcdd818777 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleExists.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleGet.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleGet.json new file mode 100644 index 000000000000..b169b3bef501 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleGet.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "jobScheduleId", + "url": "https://account.region.batch.azure.com/jobschedules/jobScheduleId", + "eTag": "0x8D40FFD2E848323", + "lastModified": "2016-11-18T21:52:24.7661347Z", + "creationTime": "2016-11-18T21:52:22.5431125Z", + "state": "completed", + "stateTransitionTime": "2016-11-18T21:52:24.8371778Z", + "previousState": "active", + "previousStateTransitionTime": "2016-11-18T21:52:24.0064874Z", + "jobSpecification": { + "priority": 0, + "usesTaskDependencies": false, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "testPool" + } + }, + "executionInfo": { + "recentJob": { + "url": "https://account.region.batch.azure.com/jobschedules/jobScheduleId:job-1", + "id": "jobScheduleId:job-1" + }, + "endTime": "2016-11-18T21:52:24.8371778Z" + } + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleList.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleList.json new file mode 100644 index 000000000000..6cd0731819cc --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleList.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "jobSchedule1", + "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule1", + "eTag": "0x8D40FFD2E10996A", + "lastModified": "2016-11-18T21:52:24.0064874Z", + "creationTime": "2016-11-18T21:52:22.5431125Z", + "state": "active", + "stateTransitionTime": "2016-11-18T21:52:24.0064874Z", + "previousState": "disabled", + "previousStateTransitionTime": "2016-11-18T21:52:23.6471782Z", + "jobSpecification": { + "priority": 0, + "usesTaskDependencies": false, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + } + }, + "executionInfo": { + "recentJob": { + "url": "https://account.region.batch.azure.com/jobs/jobSchedule1:job-1", + "id": "jobSchedule1:job-1" + } + } + }, + { + "id": "jobSchedule2", + "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule2", + "eTag": "0x8D40FFCFF760B51", + "lastModified": "2016-11-18T21:51:05.8184017Z", + "creationTime": "2016-11-18T21:51:05.8184017Z", + "state": "active", + "stateTransitionTime": "2016-11-18T21:51:05.8184017Z", + "schedule": { + "doNotRunUntil": "2020-01-01T12:30:00Z" + }, + "jobSpecification": { + "priority": 0, + "usesTaskDependencies": false, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "testPool2" + } + }, + "executionInfo": { + "nextRunTime": "2020-01-01T12:30:00Z" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobSchedulePatch.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobSchedulePatch.json new file mode 100644 index 000000000000..81a5508137af --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobSchedulePatch.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobSchedulePatchParameter": { + "schedule": { + "doNotRunUntil": "2025-01-01T12:30:00Z" + }, + "jobSpecification": { + "priority": 0, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + } + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleTerminate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleTerminate.json new file mode 100644 index 000000000000..14e0811ce888 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleTerminate.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleUpdate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleUpdate.json new file mode 100644 index 000000000000..f87cd8150731 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobScheduleUpdate.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobScheduleUpdateParameter": { + "schedule": { + "doNotRunUntil": "2025-01-01T12:30:00Z" + }, + "jobSpecification": { + "priority": 0, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + } + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobTerminate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobTerminate.json new file mode 100644 index 000000000000..57f565f320b1 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobTerminate.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobTerminateParameter": { + "terminateReason": "User supplied termination reason" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobUpdate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobUpdate.json new file mode 100644 index 000000000000..4719db878b12 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/JobUpdate.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobUpdateParameter": { + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "poolInfo": { + "poolId": "poolId" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeAddUser.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeAddUser.json new file mode 100644 index 000000000000..a7ab64e40b13 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeAddUser.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "user": { + "name": "userName", + "isAdmin": false, + "expiryTime": "2017-08-01T00:00:00Z", + "password": "Password" + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeDeleteUser.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeDeleteUser.json new file mode 100644 index 000000000000..b0bee107d329 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeDeleteUser.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "userName": "userName", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeDisableScheduling.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeDisableScheduling.json new file mode 100644 index 000000000000..d079cb68ef08 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeDisableScheduling.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeDisableSchedulingParameter": { + "nodeDisableSchedulingOption": "terminate" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeEnableScheduling.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeEnableScheduling.json new file mode 100644 index 000000000000..621b7944c0bd --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeEnableScheduling.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeGetRemoteDesktop.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeGetRemoteDesktop.json new file mode 100644 index 000000000000..e12b60648ab5 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeGetRemoteDesktop.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": "This is actually a byte stream. This request/response is being presented as a string for readability in the example" + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeGetRemoteLoginSettings.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeGetRemoteLoginSettings.json new file mode 100644 index 000000000000..5241f16fd45b --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeGetRemoteLoginSettings.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "remoteLoginIPAddress": "1.1.1.1", + "remoteLoginPort": 50000 + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeGet_Basic.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeGet_Basic.json new file mode 100644 index 000000000000..d15497f19b9f --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeGet_Basic.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "poolId": "poolId", + "nodeId": "tvm-1695681911_2-20161122t193202z", + "api-version": "2020-09-01.12.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "tvm-1695681911_2-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T19:37:31.4285526Z", + "lastBootTime": "2016-11-22T19:37:28.623369Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_2-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T19:37:31.4285526Z", + "endTime": "2016-11-22T19:37:31.838028Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T19:37:28.623369Z" + } + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeList.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeList.json new file mode 100644 index 000000000000..4b2668f99f15 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeList.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "tvm-1695681911_1-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T22:22:27.2236818Z", + "lastBootTime": "2016-11-22T22:22:24.4634125Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_1-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "runningTaskSlotsCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T22:22:27.2236818Z", + "endTime": "2016-11-22T22:22:27.567189Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" + } + }, + { + "id": "tvm-1695681911_2-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T19:37:31.4285526Z", + "lastBootTime": "2016-11-22T19:37:28.623369Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_2-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "runningTaskSlotsCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T19:37:31.4285526Z", + "endTime": "2016-11-22T19:37:31.838028Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" + } + }, + { + "id": "tvm-1695681911_3-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_3-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T19:36:51.0013378Z", + "lastBootTime": "2016-11-22T19:36:48.21721Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_3-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "runningTaskSlotsCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T19:36:51.0013378Z", + "endTime": "2016-11-22T19:36:51.2363447Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeReboot.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeReboot.json new file mode 100644 index 000000000000..964687451745 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeReboot.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeRebootParameter": { + "nodeRebootOption": "terminate" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeReimage.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeReimage.json new file mode 100644 index 000000000000..2afb95c328ca --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeReimage.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeReimageParameter": { + "nodeReimageOption": "terminate" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeUpdateUser.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeUpdateUser.json new file mode 100644 index 000000000000..c2e2a1e45e92 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeUpdateUser.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "userName": "userName", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeUpdateUserParameter": { + "password": "12345", + "expiryTime": "2016-11-27T00:45:48.7320857Z" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeUploadBatchServiceLogs.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeUploadBatchServiceLogs.json new file mode 100644 index 000000000000..ac9bf2557395 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/NodeUploadBatchServiceLogs.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "uploadBatchServiceLogsConfiguration": { + "containerUrl": "https://somestorageacct.blob.core.windows.net/batch-compute-node-logs?se=2017-12-09T18%3A51%3A00Z&sp=w&sv=2016-05-31&sr=c&sig", + "startTime": "2017-11-27T00:00:00Z" + } + }, + "responses": { + "200": { + "body": { + "virtualDirectoryName": "poolId/tvm-1695681911-1-20161121t182739z/0795539d-82fe-48e3-bbff-2964905b6de0", + "numberOfFilesUploaded": 8 + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolAdd_CloudServiceConfiguration.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolAdd_CloudServiceConfiguration.json new file mode 100644 index 000000000000..fcb99e19c195 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolAdd_CloudServiceConfiguration.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "poolId", + "vmSize": "small", + "cloudServiceConfiguration": { + "osFamily": "4" + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 3, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolAdd_MountConfiguration.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolAdd_MountConfiguration.json new file mode 100644 index 000000000000..57f9c0f2f58c --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolAdd_MountConfiguration.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "pool2", + "vmSize": "standard_a1", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "16.04.0-LTS" + }, + "nodeAgentSKUId": "batch.node.ubuntu 16.04" + }, + "mountConfiguration": [ + { + "azureBlobFileSystemConfiguration": { + "accountName": "accountName", + "containerName": "blobContainerName", + "accountKey": "accountKey", + "relativeMountPath": "bfusepath" + } + }, + { + "azureFileShareConfiguration": { + "accountName": "accountName", + "azureFileUrl": "https://myaccount.file.core.windows.net/fileshare", + "accountKey": "accountKey", + "relativeMountPath": "filesharepath", + "mountOptions": "mount options ver=1.0" + } + }, + { + "nfsMountConfiguration": { + "source": "somesource nfs url", + "relativeMountPath": "mountpath", + "mountOptions": "mount options ver=1.0" + } + }, + { + "cifsMountConfiguration": { + "username": "accountName", + "password": "password", + "source": "//myaccount.file.core.windows.net/file", + "relativeMountPath": "mountpath", + "mountOptions": "mount options ver=1.0" + } + } + ], + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 3, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolAdd_VirtualMachineConfiguration.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolAdd_VirtualMachineConfiguration.json new file mode 100644 index 000000000000..5bc7a4b886e0 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolAdd_VirtualMachineConfiguration.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "pool2", + "vmSize": "standard_a1", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "16.04.0-LTS" + }, + "nodeAgentSKUId": "batch.node.ubuntu 16.04" + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 3, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolAdd_VirtualMachineConfigurationWithContainers.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolAdd_VirtualMachineConfigurationWithContainers.json new file mode 100644 index 000000000000..88bca975c31f --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolAdd_VirtualMachineConfigurationWithContainers.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "pool2", + "vmSize": "standard_a1", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "16.04.0-LTS" + }, + "nodeAgentSKUId": "batch.node.ubuntu 16.04", + "containerConfiguration": { + "type": "dockerCompatible", + "containerImageNames": [ + "busybox" + ] + } + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 3, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolDelete.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolDelete.json new file mode 100644 index 000000000000..ccc0b81b402e --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolDisableAutoScale.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolDisableAutoScale.json new file mode 100644 index 000000000000..1114a1ce73e3 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolDisableAutoScale.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolEnableAutoscale.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolEnableAutoscale.json new file mode 100644 index 000000000000..f9308dbcd95f --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolEnableAutoscale.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "poolEnableAutoScaleParameter": { + "autoScaleFormula": "$TargetDedicated=0", + "autoScaleEvaluationInterval": "PT8M" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolEvaluateAutoscale.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolEvaluateAutoscale.json new file mode 100644 index 000000000000..15e17c4821cd --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolEvaluateAutoscale.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "poolEvaluateAutoScaleParameter": { + "autoScaleFormula": "$TargetDedicated=1" + } + }, + "responses": { + "200": { + "body": { + "timestamp": "2016-11-22T19:39:28.5246331Z", + "results": "$TargetDedicated=1;$NodeDeallocationOption=requeue" + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolExists.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolExists.json new file mode 100644 index 000000000000..041fca2f0bff --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolExists.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolGetLifetimeStatistics.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolGetLifetimeStatistics.json new file mode 100644 index 000000000000..2f804d1809aa --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolGetLifetimeStatistics.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "url": "https://account.region.batch.core.windows.net/lifetimepoolstats", + "startTime": "2014-08-01T18:30:00.4345729Z", + "lastUpdateTime": "2014-08-04T18:30:00.4345729Z", + "usageStats": { + "startTime": "2014-08-01T18:30:00.4345729Z", + "lastUpdateTime": "2014-08-04T18:30:00.4345729Z", + "dedicatedCoreTime": "PT0S" + }, + "resourceStats": { + "startTime": "2014-08-01T18:30:00.4345729Z", + "lastUpdateTime": "2014-08-04T18:30:00.4345729Z", + "avgCPUPercentage": 40.0, + "avgMemoryGiB": 2.0, + "peakMemoryGiB": 4.0, + "avgDiskGiB": 125.0, + "peakDiskGiB": 240.0, + "diskReadIOps": 0, + "diskWriteIOps": 0, + "diskReadGiB": 10.0, + "diskWriteGiB": 1.0, + "networkReadGiB": 20.0, + "networkWriteGiB": 25.0 + } + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolGet_Basic.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolGet_Basic.json new file mode 100644 index 000000000000..b397fd8c028e --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolGet_Basic.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "pool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "pool", + "url": "https://account.region.batch.azure.com/pools/pool", + "eTag": "0x8D413091E739A56", + "lastModified": "2016-11-22T18:55:25.2608598Z", + "creationTime": "2016-11-22T18:55:24.2632496Z", + "state": "active", + "stateTransitionTime": "2016-11-22T18:55:24.2632496Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z", + "vmSize": "standard_a1", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "16.04.0-LTS", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.ubuntu 16.04" + } + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolListUsageMetrics.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolListUsageMetrics.json new file mode 100644 index 000000000000..64b854240086 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolListUsageMetrics.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "startTime": "2013-04-01T00:00:00Z", + "endTime": "2013-04-01T00:30:00Z", + "poolId": "p1", + "vmSize": "a1", + "totalCoreHours": 39.384838 + }, + { + "startTime": "2013-04-01T00:30:00Z", + "endTime": "2013-04-01T01:00:00Z", + "poolId": "p2", + "vmSize": "a8", + "totalCoreHours": 3039.384838 + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolList_Basic.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolList_Basic.json new file mode 100644 index 000000000000..9871ed2b00a9 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolList_Basic.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "testPool", + "url": "https://accountname.region.batch.azure.com/pools/testPool", + "eTag": "0x8D4123BEF87D233", + "lastModified": "2016-11-21T18:26:39.7108787Z", + "creationTime": "2016-11-21T18:26:39.7108787Z", + "state": "active", + "stateTransitionTime": "2016-11-21T18:26:39.7108787Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2016-11-21T18:27:40.287803Z", + "vmSize": "small", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 3, + "currentLowPriorityNodes": 0, + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "cloudServiceConfiguration": { + "osFamily": "4", + "osVersion": "*" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolPatch.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolPatch.json new file mode 100644 index 000000000000..b5f4a7e33be4 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolPatch.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "poolPatchParameter": { + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolRemoveNodes.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolRemoveNodes.json new file mode 100644 index 000000000000..ec5a7f4d40ed --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolRemoveNodes.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeRemoveParameter": { + "nodeList": [ + "tvm-1695681911_1-20161122t224741z", + "tvm-1695681911_2-20161122t224741z" + ] + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolResize.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolResize.json new file mode 100644 index 000000000000..d6abe2d54922 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolResize.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "resizePool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "poolResizeParameter": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolStopResize.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolStopResize.json new file mode 100644 index 000000000000..ccc0b81b402e --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolStopResize.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolUpdate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolUpdate.json new file mode 100644 index 000000000000..4be088f9c864 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/PoolUpdate.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "poolUpdatePropertiesParameter": { + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'" + }, + "certificateReferences": [], + "applicationPackageReferences": [], + "metadata": [] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAddCollection_Basic.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAddCollection_Basic.json new file mode 100644 index 000000000000..f6f783ad9dcc --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAddCollection_Basic.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "taskCollection": { + "value": [ + { + "id": "simple1", + "commandLine": "cmd /c dir /s" + }, + { + "id": "simple2", + "commandLine": "cmd /c dir /s" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "status": "success", + "taskId": "simple1", + "eTag": "0x8D3D623CD661246", + "lastModified": "2016-09-06T07:02:44.7589958Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple1" + }, + { + "status": "success", + "taskId": "simple2", + "eTag": "0x8D3D623CD7072CC", + "lastModified": "2016-09-06T07:02:44.8270028Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple2" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAddCollection_Complex.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAddCollection_Complex.json new file mode 100644 index 000000000000..5a30f66ebcc9 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAddCollection_Complex.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "taskCollection": { + "value": [ + { + "id": "complex1", + "commandLine": "cmd /c dir /s", + "resourceFiles": [ + { + "autoStorageContainerName": "containerName", + "filePath": "data" + } + ], + "environmentSettings": [ + { + "name": "env1", + "value": "value1" + }, + { + "name": "env2", + "value": "value2" + } + ], + "affinityInfo": { + "affinityId": "affinityId" + }, + "constraints": { + "maxWallClockTime": "P1D", + "retentionTime": "P2D", + "maxTaskRetryCount": 5 + }, + "requiredSlots": 2, + "multiInstanceSettings": { + "numberOfInstances": 3, + "coordinationCommandLine": "cmd /c echo coordinating", + "commonResourceFiles": [ + { + "httpUrl": "https://common.blob.core.windows.net/", + "filePath": "common.exe" + } + ] + } + }, + { + "id": "simple3", + "commandLine": "cmd /c dir /s" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "taskId": "simple3", + "status": "success", + "eTag": "0x8D3D623CE295629", + "lastModified": "2016-09-06T07:02:46.0386857Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple3" + }, + { + "taskId": "complex1", + "status": "success", + "eTag": "0x8D3D623CE29A412", + "lastModified": "2016-09-06T07:02:46.0406802Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/complex1" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAdd_Basic.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAdd_Basic.json new file mode 100644 index 000000000000..4f57f322e72d --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAdd_Basic.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "task1", + "commandLine": "cmd /c echo task1" + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAdd_ContainerSettings.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAdd_ContainerSettings.json new file mode 100644 index 000000000000..53369b6c6967 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAdd_ContainerSettings.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "taskId", + "commandLine": "bash -c 'echo hello'", + "containerSettings": { + "imageName": "ubuntu", + "containerRunOptions": "--rm" + }, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAdd_ExitConditions.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAdd_ExitConditions.json new file mode 100644 index 000000000000..254568f2be10 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAdd_ExitConditions.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "taskId", + "commandLine": "cmd /c exit 3", + "exitConditions": { + "exitCodeRanges": [ + { + "start": 2, + "end": 4, + "exitOptions": { + "jobAction": "terminate" + } + } + ] + }, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAdd_RequiredSlots.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAdd_RequiredSlots.json new file mode 100644 index 000000000000..927722fab1c5 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskAdd_RequiredSlots.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "task1", + "requiredSlots": 2, + "commandLine": "cmd /c echo task1" + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskDelete.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskDelete.json new file mode 100644 index 000000000000..e3bcdf4f63b6 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskGet.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskGet.json new file mode 100644 index 000000000000..eb32de875da8 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskGet.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "testTask", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId", + "eTag": "0x8D3D62350711C55", + "creationTime": "2016-09-06T06:59:15.1161429Z", + "lastModified": "2016-09-06T06:59:15.1161429Z", + "state": "active", + "stateTransitionTime": "2016-09-06T06:59:15.1161429Z", + "commandLine": "cmd /c hostname", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "multiInstanceSettings": { + "numberOfInstances": 3, + "coordinationCommandLine": "cmd /c echo coordinating" + }, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "retentionTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "requiredSlots": 2, + "executionInfo": { + "retryCount": 0, + "requeueCount": 0 + } + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskList.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskList.json new file mode 100644 index 000000000000..520c4a707c8f --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskList.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "task1", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task1", + "eTag": "0x8D4125FD1A825A4", + "creationTime": "2016-11-21T22:43:31.4733476Z", + "lastModified": "2016-11-21T22:43:31.4733476Z", + "state": "active", + "stateTransitionTime": "2016-11-21T22:43:31.4733476Z", + "commandLine": "cmd /c echo task1", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "retentionTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "requiredSlots": 2, + "executionInfo": { + "retryCount": 0, + "requeueCount": 0 + } + }, + { + "id": "task2", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task2", + "eTag": "0x8D4125FD2153345", + "creationTime": "2016-11-21T22:43:31.6736345Z", + "lastModified": "2016-11-21T22:43:32.1880389Z", + "state": "active", + "stateTransitionTime": "2016-11-21T22:43:31.6736345Z", + "commandLine": "cmd /c echo task2", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "retentionTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 3 + }, + "requiredSlots": 2, + "executionInfo": { + "retryCount": 0, + "requeueCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskListSubtasks.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskListSubtasks.json new file mode 100644 index 000000000000..e259e7461712 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskListSubtasks.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": 1, + "startTime": "2016-09-06T06:59:16.3139271Z", + "endTime": "2016-09-06T06:59:20.0242024Z", + "state": "completed", + "stateTransitionTime": "2016-09-06T06:59:20.0242024Z", + "previousState": "running", + "previousStateTransitionTime": "2016-09-06T06:59:16.3139271Z", + "exitCode": 0, + "nodeInfo": { + "affinityId": "TVM:tvm-2544493925_3-20160905t051718z", + "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z", + "poolId": "mpiPool", + "nodeId": "tvm-2544493925_3-20160905t051718z", + "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\1", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z/files//workitems/jobId/job-1/taskId/1" + } + }, + { + "id": 2, + "startTime": "2016-09-06T06:59:16.9702844Z", + "state": "running", + "stateTransitionTime": "2016-09-06T06:59:16.9702844Z", + "nodeInfo": { + "affinityId": "TVM:tvm-2544493925_2-20160905t051718z", + "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z", + "poolId": "mpiPool", + "nodeId": "tvm-2544493925_2-20160905t051718z", + "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\2", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z/files//workitems/jobId/job-1/taskId/2" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskReactivate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskReactivate.json new file mode 100644 index 000000000000..22e0815189c1 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskReactivate.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskTerminate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskTerminate.json new file mode 100644 index 000000000000..22e0815189c1 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskTerminate.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskUpdate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskUpdate.json new file mode 100644 index 000000000000..f46819eb85f6 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2020-09-01.12.0/examples/TaskUpdate.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2020-09-01.12.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "taskUpdateParameter": { + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": 3, + "retentionTime": "PT1H" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/readme.go.md b/specification/batch/data-plane/readme.go.md index 3f970038d20a..ce9f53e4369b 100644 --- a/specification/batch/data-plane/readme.go.md +++ b/specification/batch/data-plane/readme.go.md @@ -20,6 +20,16 @@ batch: - tag: package-2019-06.9.0 - tag: package-2019-08.10.0 - tag: package-2020-03.11.0 + - tag: package-2020-09.12.0 +``` + +### Tag: package-2020-09.12.0 and go + +These settings apply only when `--tag=package-2020-09.12.0 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2020-09.12.0' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/2020-09-01.12.0/$(namespace) ``` ### Tag: package-2020-03.11.0 and go diff --git a/specification/batch/data-plane/readme.md b/specification/batch/data-plane/readme.md index adfd75a18255..d3d4c786623f 100644 --- a/specification/batch/data-plane/readme.md +++ b/specification/batch/data-plane/readme.md @@ -26,7 +26,16 @@ These are the global settings for the Batch API. ``` yaml openapi-type: data-plane -tag: package-2020-03.11.0 +tag: package-2020-09.12.0 +``` + +### Tag: package-2020-09.12.0 + +These settings apply only when `--tag=package-2020-09.12.0` is specified on the command line. + +``` yaml $(tag) == 'package-2020-09.12.0' +input-file: +- Microsoft.Batch/stable/2020-09-01.12.0/BatchService.json ``` ### Tag: package-2020-03.11.0 @@ -360,6 +369,7 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.Batch/stable/2020-09-01.12.0/BatchService.json - $(this-folder)/Microsoft.Batch/stable/2020-03-01.11.0/BatchService.json - $(this-folder)/Microsoft.Batch/stable/2019-08-01.10.0/BatchService.json - $(this-folder)/Microsoft.Batch/stable/2019-06-01.9.0/BatchService.json diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/BatchManagement.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/BatchManagement.json new file mode 100644 index 000000000000..b17f00cf9811 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/BatchManagement.json @@ -0,0 +1,5147 @@ +{ + "swagger": "2.0", + "info": { + "title": "BatchManagement", + "version": "2020-09-01", + "x-ms-code-generation-settings": { + "name": "BatchManagementClient" + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}": { + "put": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_Create", + "x-ms-examples": { + "BatchAccountCreate_Default": { + "$ref": "./examples/BatchAccountCreate_Default.json" + }, + "BatchAccountCreate_BYOS": { + "$ref": "./examples/BatchAccountCreate_BYOS.json" + }, + "PrivateBatchAccountCreate": { + "$ref": "./examples/PrivateBatchAccountCreate.json" + }, + "BatchAccountCreate_SystemAssignedIdentity": { + "$ref": "./examples/BatchAccountCreate_SystemAssignedIdentity.json" + } + }, + "description": "Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z0-9]+$", + "minLength": 3, + "maxLength": 24, + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BatchAccountCreateParameters" + }, + "description": "Additional parameters for account creation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the Batch account entity.", + "schema": { + "$ref": "#/definitions/BatchAccount" + } + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that specifies the delay in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_Update", + "x-ms-examples": { + "BatchAccountUpdate": { + "$ref": "./examples/BatchAccountUpdate.json" + } + }, + "description": "Updates the properties of an existing Batch account.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BatchAccountUpdateParameters" + }, + "description": "Additional parameters for account update." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the Batch account entity.", + "schema": { + "$ref": "#/definitions/BatchAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_Delete", + "x-ms-examples": { + "BatchAccountDelete": { + "$ref": "./examples/BatchAccountDelete.json" + } + }, + "description": "Deletes the specified Batch account.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that specifies the delay in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "NoContent -- account does not exist in the subscription." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_Get", + "x-ms-examples": { + "BatchAccountGet": { + "$ref": "./examples/BatchAccountGet.json" + }, + "PrivateBatchAccountGet": { + "$ref": "./examples/PrivateBatchAccountGet.json" + } + }, + "description": "Gets information about the specified Batch account.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the Batch account entity.", + "schema": { + "$ref": "#/definitions/BatchAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/batchAccounts": { + "get": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_List", + "x-ms-examples": { + "BatchAccountList": { + "$ref": "./examples/BatchAccountList.json" + } + }, + "description": "Gets information about the Batch accounts associated with the subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of Batch account entities associated with the subscription.", + "schema": { + "$ref": "#/definitions/BatchAccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts": { + "get": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_ListByResourceGroup", + "x-ms-examples": { + "BatchAccountListByResourceGroup": { + "$ref": "./examples/BatchAccountListByResourceGroup.json" + } + }, + "description": "Gets information about the Batch accounts associated with the specified resource group.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of Batch account entities associated with the resource group.", + "schema": { + "$ref": "#/definitions/BatchAccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/syncAutoStorageKeys": { + "post": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_SynchronizeAutoStorageKeys", + "x-ms-examples": { + "BatchAccountSynchronizeAutoStorageKeys": { + "$ref": "./examples/BatchAccountSynchronizeAutoStorageKeys.json" + } + }, + "description": "Synchronizes access keys for the auto-storage account configured for the specified Batch account.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The operation was successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/regenerateKeys": { + "post": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_RegenerateKey", + "x-ms-examples": { + "BatchAccountRegenerateKey": { + "$ref": "./examples/BatchAccountRegenerateKey.json" + } + }, + "description": "Regenerates the specified account key for the Batch account.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BatchAccountRegenerateKeyParameters" + }, + "description": "The type of key to regenerate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the Batch account keys.", + "schema": { + "$ref": "#/definitions/BatchAccountKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/listKeys": { + "post": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_GetKeys", + "x-ms-examples": { + "BatchAccountGetKeys": { + "$ref": "./examples/BatchAccountGetKeys.json" + } + }, + "summary": "Gets the account keys for the specified Batch account.", + "description": "This operation applies only to Batch accounts created with a poolAllocationMode of 'BatchService'. If the Batch account was created with a poolAllocationMode of 'UserSubscription', clients cannot use access to keys to authenticate, and must use Azure Active Directory instead. In this case, getting the keys will fail.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the keys of the Batch account.", + "schema": { + "$ref": "#/definitions/BatchAccountKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}/activate": { + "post": { + "tags": [ + "ApplicationPackage" + ], + "operationId": "ApplicationPackage_Activate", + "x-ms-examples": { + "ApplicationPackageActivate": { + "$ref": "./examples/ApplicationPackageActivate.json" + } + }, + "description": "Activates the specified application package. This should be done after the `ApplicationPackage` was created and uploaded. This needs to be done before an `ApplicationPackage` can be used on Pools or Tasks.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/VersionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ActivateApplicationPackageParameters" + }, + "description": "The parameters for the request." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the application package entity.", + "schema": { + "$ref": "#/definitions/ApplicationPackage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}": { + "put": { + "tags": [ + "Application" + ], + "operationId": "Application_Create", + "x-ms-examples": { + "ApplicationCreate": { + "$ref": "./examples/ApplicationCreate.json" + } + }, + "description": "Adds an application to the specified Batch account.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/Application" + }, + "description": "The parameters for the request." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the application entity.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Application" + ], + "operationId": "Application_Delete", + "x-ms-examples": { + "ApplicationDelete": { + "$ref": "./examples/ApplicationDelete.json" + } + }, + "description": "Deletes an application.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "204": { + "description": "The operation was successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "Application" + ], + "operationId": "Application_Get", + "x-ms-examples": { + "ApplicationGet": { + "$ref": "./examples/ApplicationGet.json" + } + }, + "description": "Gets information about the specified application.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the application entity.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Application" + ], + "operationId": "Application_Update", + "x-ms-examples": { + "ApplicationUpdate": { + "$ref": "./examples/ApplicationUpdate.json" + } + }, + "description": "Updates settings for the specified application.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Application" + }, + "description": "The parameters for the request." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the application entity.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}": { + "put": { + "tags": [ + "ApplicationPackage" + ], + "operationId": "ApplicationPackage_Create", + "x-ms-examples": { + "ApplicationPackageCreate": { + "$ref": "./examples/ApplicationPackageCreate.json" + } + }, + "description": "Creates an application package record. The record contains the SAS where the package should be uploaded to. Once it is uploaded the `ApplicationPackage` needs to be activated using `ApplicationPackageActive` before it can be used.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/VersionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ApplicationPackage" + }, + "description": "The parameters for the request." + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the application package entity.", + "schema": { + "$ref": "#/definitions/ApplicationPackage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationPackage" + ], + "operationId": "ApplicationPackage_Delete", + "x-ms-examples": { + "ApplicationPackageDelete": { + "$ref": "./examples/ApplicationPackageDelete.json" + } + }, + "description": "Deletes an application package record and its associated binary file.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/VersionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "204": { + "description": "The operation was successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "ApplicationPackage" + ], + "operationId": "ApplicationPackage_Get", + "x-ms-examples": { + "ApplicationPackageGet": { + "$ref": "./examples/ApplicationPackageGet.json" + } + }, + "description": "Gets information about the specified application package.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/VersionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the application package entity.", + "schema": { + "$ref": "#/definitions/ApplicationPackage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Application_List", + "x-ms-examples": { + "ApplicationList": { + "$ref": "./examples/ApplicationList.json" + } + }, + "description": "Lists all of the applications in the specified account.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of the application entities associated with the specified account.", + "schema": { + "$ref": "#/definitions/ListApplicationsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions": { + "get": { + "tags": [ + "ApplicationPackage" + ], + "operationId": "ApplicationPackage_List", + "x-ms-examples": { + "ApplicationList": { + "$ref": "./examples/ApplicationPackageList.json" + } + }, + "description": "Lists all of the application packages in the specified application.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of the application package entities associated with the specified application.", + "schema": { + "$ref": "#/definitions/ListApplicationPackagesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/quotas": { + "get": { + "tags": [ + "Location" + ], + "operationId": "Location_GetQuotas", + "x-ms-examples": { + "LocationGetQuotas": { + "$ref": "./examples/LocationGetQuotas.json" + } + }, + "description": "Gets the Batch service quotas for the specified subscription at the given location.", + "parameters": [ + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The region for which to retrieve Batch service quotas." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the Batch service quotas for the subscription in the specified location.", + "schema": { + "$ref": "#/definitions/BatchLocationQuota" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/Microsoft.Batch/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists available operations for the Microsoft.Batch provider", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the list of available operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/checkNameAvailability": { + "post": { + "operationId": "Location_CheckNameAvailability", + "description": "Checks whether the Batch account name is available in the specified region.", + "x-ms-examples": { + "LocationCheckNameAvailability_Available": { + "$ref": "./examples/LocationCheckNameAvailability_Available.json" + }, + "LocationCheckNameAvailability_AlreadyExists": { + "$ref": "./examples/LocationCheckNameAvailability_AlreadyExists.json" + } + }, + "parameters": [ + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The desired region for the name check." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + }, + "description": "Properties needed to check the availability of a name." + } + ], + "responses": { + "200": { + "description": "Success. Returns details about whether a Batch account name is available.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates": { + "get": { + "tags": [ + "Certificate" + ], + "operationId": "Certificate_ListByBatchAccount", + "description": "Lists all of the certificates in the specified account.", + "x-ms-examples": { + "ListCertificates": { + "$ref": "./examples/CertificateList.json" + }, + "ListCertificates - Filter and Select": { + "$ref": "./examples/CertificateListWithFilter.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Comma separated list of properties that should be returned. e.g. \"properties/provisioningState\". Only top level properties under properties/ are valid for selection." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are \"properties/provisioningState\", \"properties/provisioningStateTransitionTime\", \"name\"." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of certificates associated with the account.", + "schema": { + "$ref": "#/definitions/ListCertificatesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}": { + "put": { + "tags": [ + "Certificate" + ], + "operationId": "Certificate_Create", + "description": "Creates a new certificate inside the specified account.", + "x-ms-examples": { + "CreateCertificate - Minimal Pfx": { + "$ref": "./examples/CertificateCreate_Minimal.json" + }, + "CreateCertificate - Minimal Cer": { + "$ref": "./examples/CertificateCreate_MinimalCer.json" + }, + "CreateCertificate - Full": { + "$ref": "./examples/CertificateCreate_Full.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/CertificateNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateCreateOrUpdateParameters" + }, + "description": "Additional parameters for certificate creation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The entity state (ETag) version of the certificate to update. A value of \"*\" can be used to apply the operation only if the certificate already exists. If omitted, this operation will always be applied." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Set to '*' to allow a new certificate to be created, but to prevent updating an existing certificate. Other values will be ignored." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the certificate entity.", + "schema": { + "$ref": "#/definitions/Certificate" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Certificate" + ], + "operationId": "Certificate_Update", + "description": "Updates the properties of an existing certificate.", + "x-ms-examples": { + "UpdateCertificate": { + "$ref": "./examples/CertificateUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/CertificateNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateCreateOrUpdateParameters" + }, + "description": "Certificate entity to update." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The entity state (ETag) version of the certificate to update. This value can be omitted or set to \"*\" to apply the operation unconditionally." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the certificate entity.", + "schema": { + "$ref": "#/definitions/Certificate" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Certificate" + ], + "operationId": "Certificate_Delete", + "description": "Deletes the specified certificate.", + "x-ms-examples": { + "CertificateDelete": { + "$ref": "./examples/CertificateDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/CertificateNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "204": { + "description": "The operation was successful." + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Certificate" + ], + "operationId": "Certificate_Get", + "description": "Gets information about the specified certificate.", + "x-ms-examples": { + "Get Certificate": { + "$ref": "./examples/CertificateGet.json" + }, + "Get Certificate with Deletion Error": { + "$ref": "./examples/CertificateGetWithDeletionError.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/CertificateNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the certificate entity.", + "schema": { + "$ref": "#/definitions/Certificate" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}/cancelDelete": { + "post": { + "tags": [ + "Certificate" + ], + "operationId": "Certificate_CancelDeletion", + "summary": "Cancels a failed deletion of a certificate from the specified account.", + "description": "If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.", + "x-ms-examples": { + "CertificateCancelDeletion": { + "$ref": "./examples/CertificateCancelDeletion.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/CertificateNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the certificate entity.", + "schema": { + "$ref": "#/definitions/Certificate" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResource" + ], + "operationId": "PrivateLinkResource_ListByBatchAccount", + "description": "Lists all of the private link resources in the specified account.", + "x-ms-examples": { + "ListPrivateLinkResource": { + "$ref": "./examples/PrivateLinkResourcesList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response." + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of private link resources associated with the account.", + "schema": { + "$ref": "#/definitions/ListPrivateLinkResourcesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateLinkResources/{privateLinkResourceName}": { + "get": { + "tags": [ + "PrivateLinkResource" + ], + "operationId": "PrivateLinkResource_Get", + "description": "Gets information about the specified private link resource.", + "x-ms-examples": { + "GetPrivateLinkResource": { + "$ref": "./examples/PrivateLinkResourceGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PrivateLinkResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the private link resource.", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnection" + ], + "operationId": "PrivateEndpointConnection_ListByBatchAccount", + "description": "Lists all of the private endpoint connections in the specified account.", + "x-ms-examples": { + "ListPrivateEndpointConnections": { + "$ref": "./examples/PrivateEndpointConnectionsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response." + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of private link resources associated with the account.", + "schema": { + "$ref": "#/definitions/ListPrivateEndpointConnectionsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnection" + ], + "operationId": "PrivateEndpointConnection_Get", + "description": "Gets information about the specified private endpoint connection.", + "x-ms-examples": { + "GetPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnectionGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "PrivateEndpointConnection" + ], + "operationId": "PrivateEndpointConnection_Update", + "description": "Updates the properties of an existing private endpoint connection.", + "x-ms-examples": { + "UpdatePrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnectionUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "PrivateEndpointConnection properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The state (ETag) version of the private endpoint connection to update. This value can be omitted or set to \"*\" to apply the operation unconditionally." + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the PrivateEndpointConnection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "204": { + "description": "The operation was successful." + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools": { + "get": { + "tags": [ + "Pool" + ], + "operationId": "Pool_ListByBatchAccount", + "description": "Lists all of the pools in the specified account.", + "x-ms-examples": { + "ListPool": { + "$ref": "./examples/PoolList.json" + }, + "ListPoolWithFilter": { + "$ref": "./examples/PoolListWithFilter.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Comma separated list of properties that should be returned. e.g. \"properties/provisioningState\". Only top level properties under properties/ are valid for selection." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are:\n\n name\n properties/allocationState\n properties/allocationStateTransitionTime\n properties/creationTime\n properties/provisioningState\n properties/provisioningStateTransitionTime\n properties/lastModified\n properties/vmSize\n properties/interNodeCommunication\n properties/scaleSettings/autoScale\n properties/scaleSettings/fixedScale" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of certificates associated with the account.", + "schema": { + "$ref": "#/definitions/ListPoolsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}": { + "put": { + "tags": [ + "Pool" + ], + "operationId": "Pool_Create", + "description": "Creates a new pool inside the specified account.", + "x-ms-examples": { + "CreatePool - Minimal CloudServiceConfiguration": { + "$ref": "./examples/PoolCreate_MinimalCloudServiceConfiguration.json" + }, + "CreatePool - Minimal VirtualMachineConfiguration": { + "$ref": "./examples/PoolCreate_MinimalVirtualMachineConfiguration.json" + }, + "CreatePool - Full Example": { + "$ref": "./examples/PoolCreate_FullExample.json" + }, + "CreatePool - Custom Image": { + "$ref": "./examples/PoolCreate_SharedImageGallery.json" + }, + "CreatePool - Public IPs": { + "$ref": "./examples/PoolCreate_PublicIPs.json" + }, + "CreatePool - Full VirtualMachineConfiguration": { + "$ref": "./examples/PoolCreate_VirtualMachineConfiguration.json" + }, + "CreatePool - No public IP": { + "$ref": "./examples/PoolCreate_NoPublicIPAddresses.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Pool" + }, + "description": "Additional parameters for pool creation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The entity state (ETag) version of the pool to update. A value of \"*\" can be used to apply the operation only if the pool already exists. If omitted, this operation will always be applied." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Set to '*' to allow a new pool to be created, but to prevent updating an existing pool. Other values will be ignored." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the pool entity.", + "schema": { + "$ref": "#/definitions/Pool" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Pool" + ], + "operationId": "Pool_Update", + "description": "Updates the properties of an existing pool.", + "x-ms-examples": { + "UpdatePool - Resize Pool": { + "$ref": "./examples/PoolUpdate_ResizePool.json" + }, + "UpdatePool - Enable Autoscale": { + "$ref": "./examples/PoolUpdate_EnableAutoScale.json" + }, + "UpdatePool - Remove Start Task": { + "$ref": "./examples/PoolUpdate_RemoveStartTask.json" + }, + "UpdatePool - Other Properties": { + "$ref": "./examples/PoolUpdate_OtherProperties.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Pool" + }, + "description": "Pool properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The entity state (ETag) version of the pool to update. This value can be omitted or set to \"*\" to apply the operation unconditionally." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the pool entity.", + "schema": { + "$ref": "#/definitions/Pool" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Pool" + ], + "operationId": "Pool_Delete", + "description": "Deletes the specified pool.", + "x-ms-examples": { + "DeletePool": { + "$ref": "./examples/PoolDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "204": { + "description": "The operation was successful." + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Pool" + ], + "operationId": "Pool_Get", + "description": "Gets information about the specified pool.", + "x-ms-examples": { + "GetPool": { + "$ref": "./examples/PoolGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the pool entity.", + "schema": { + "$ref": "#/definitions/Pool" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}/disableAutoScale": { + "post": { + "tags": [ + "Pool" + ], + "operationId": "Pool_DisableAutoScale", + "description": "Disables automatic scaling for a pool.", + "x-ms-examples": { + "Disable AutoScale": { + "$ref": "./examples/PoolDisableAutoScale.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the pool entity.", + "schema": { + "$ref": "#/definitions/Pool" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}/stopResize": { + "post": { + "tags": [ + "Pool" + ], + "operationId": "Pool_StopResize", + "summary": "Stops an ongoing resize operation on the pool.", + "description": "This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.", + "x-ms-examples": { + "StopPoolResize": { + "$ref": "./examples/PoolStopResize.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the pool entity.", + "schema": { + "$ref": "#/definitions/Pool" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "AutoStorageBaseProperties": { + "properties": { + "storageAccountId": { + "type": "string", + "description": "The resource ID of the storage account to be used for auto-storage account." + } + }, + "required": [ + "storageAccountId" + ], + "description": "The properties related to the auto-storage account." + }, + "BatchAccountUpdateProperties": { + "properties": { + "autoStorage": { + "$ref": "#/definitions/AutoStorageBaseProperties", + "description": "The properties related to the auto-storage account." + }, + "encryption": { + "title": "The encryption configuration for the Batch account.", + "description": "Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.", + "$ref": "#/definitions/EncryptionProperties" + } + }, + "description": "The properties of a Batch account." + }, + "BatchAccountCreateProperties": { + "properties": { + "autoStorage": { + "$ref": "#/definitions/AutoStorageBaseProperties", + "description": "The properties related to the auto-storage account." + }, + "poolAllocationMode": { + "title": "The allocation mode to use for creating pools in the Batch account.", + "description": "The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService.", + "$ref": "#/definitions/PoolAllocationMode" + }, + "keyVaultReference": { + "$ref": "#/definitions/KeyVaultReference", + "description": "A reference to the Azure key vault associated with the Batch account." + }, + "publicNetworkAccess": { + "title": "The network access type for accessing Azure Batch account.", + "description": "If not specified, the default value is 'enabled'.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "encryption": { + "title": "The encryption configuration for the Batch account.", + "description": "Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.", + "$ref": "#/definitions/EncryptionProperties" + } + }, + "description": "The properties of a Batch account." + }, + "BatchAccountCreateParameters": { + "properties": { + "location": { + "type": "string", + "description": "The region in which to create the account." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The user-specified tags associated with the account." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BatchAccountCreateProperties", + "description": "The properties of the Batch account." + }, + "identity": { + "$ref": "#/definitions/BatchAccountIdentity", + "description": "The identity of the Batch account." + } + }, + "required": [ + "location" + ], + "description": "Parameters supplied to the Create operation." + }, + "KeyVaultReference": { + "properties": { + "id": { + "type": "string", + "description": "The resource ID of the Azure key vault associated with the Batch account." + }, + "url": { + "type": "string", + "description": "The URL of the Azure key vault associated with the Batch account." + } + }, + "required": [ + "id", + "url" + ], + "description": "Identifies the Azure key vault associated with a Batch account." + }, + "AutoStorageProperties": { + "properties": { + "lastKeySync": { + "type": "string", + "format": "date-time", + "description": "The UTC time at which storage keys were last synchronized with the Batch account." + } + }, + "required": [ + "lastKeySync" + ], + "allOf": [ + { + "$ref": "#/definitions/AutoStorageBaseProperties" + } + ], + "description": "Contains information about the auto-storage account associated with a Batch account." + }, + "VirtualMachineFamilyCoreQuota": { + "properties": { + "name": { + "readOnly": true, + "x-nullable": false, + "type": "string", + "description": "The Virtual Machine family name." + }, + "coreQuota": { + "readOnly": true, + "x-nullable": false, + "type": "integer", + "format": "int32", + "description": "The core quota for the VM family for the Batch account." + } + }, + "description": "A VM Family and its associated core quota for the Batch account." + }, + "BatchAccountIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the Batch account. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the Batch account. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the Batch account.", + "enum": [ + "SystemAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false, + "values": [ + { + "value": "SystemAssigned", + "description": "Batch account has a system assigned identity with it." + }, + { + "value": "None", + "description": "Batch account has no identity associated with it. Setting `None` in update account will remove existing identities." + } + ] + } + } + }, + "description": "The identity of the Batch account, if configured. This is only used when the user specifies 'Microsoft.KeyVault' as their Batch account encryption configuration.", + "required": [ + "type" + ] + }, + "BatchAccountProperties": { + "properties": { + "accountEndpoint": { + "type": "string", + "readOnly": true, + "description": "The account endpoint used to interact with the Batch service." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "x-nullable": false, + "description": "The provisioned state of the resource", + "enum": [ + "Invalid", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Cancelled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false, + "values": [ + { + "value": "Invalid", + "description": "The account is in an invalid state." + }, + { + "value": "Creating", + "description": "The account is being created." + }, + { + "value": "Deleting", + "description": "The account is being deleted." + }, + { + "value": "Succeeded", + "description": "The account has been created and is ready for use." + }, + { + "value": "Failed", + "description": "The last operation for the account is failed." + }, + { + "value": "Cancelled", + "description": "The last operation for the account is cancelled." + } + ] + } + }, + "poolAllocationMode": { + "readOnly": true, + "x-nullable": false, + "title": "The allocation mode to use for creating pools in the Batch account.", + "$ref": "#/definitions/PoolAllocationMode" + }, + "keyVaultReference": { + "title": "A reference to the Azure key vault associated with the Batch account.", + "readOnly": true, + "$ref": "#/definitions/KeyVaultReference" + }, + "publicNetworkAccess": { + "readOnly": true, + "x-nullable": true, + "title": "The network interface type for accessing Azure Batch service and Batch account operations.", + "description": "If not specified, the default value is 'enabled'.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "privateEndpointConnections": { + "readOnly": true, + "x-nullable": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "List of private endpoint connections associated with the Batch account" + }, + "autoStorage": { + "title": "The properties and status of any auto-storage account associated with the Batch account.", + "readOnly": true, + "$ref": "#/definitions/AutoStorageProperties" + }, + "encryption": { + "title": "The encryption configuration for the Batch account.", + "description": "Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.", + "readOnly": true, + "$ref": "#/definitions/EncryptionProperties" + }, + "dedicatedCoreQuota": { + "readOnly": true, + "x-nullable": true, + "type": "integer", + "format": "int32", + "title": "The dedicated core quota for the Batch account.", + "description": "For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned." + }, + "lowPriorityCoreQuota": { + "readOnly": true, + "x-nullable": true, + "type": "integer", + "format": "int32", + "title": "The low-priority core quota for the Batch account.", + "description": "For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned." + }, + "dedicatedCoreQuotaPerVMFamily": { + "readOnly": true, + "x-nullable": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineFamilyCoreQuota" + }, + "description": "A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned." + }, + "dedicatedCoreQuotaPerVMFamilyEnforced": { + "readOnly": true, + "x-nullable": false, + "type": "boolean", + "title": "A value indicating whether the core quota for the Batch Account is enforced per Virtual Machine family or not.", + "description": "Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply." + }, + "poolQuota": { + "readOnly": true, + "x-nullable": false, + "type": "integer", + "format": "int32", + "title": "The pool quota for the Batch account." + }, + "activeJobAndJobScheduleQuota": { + "readOnly": true, + "x-nullable": false, + "type": "integer", + "format": "int32", + "title": "The active job and job schedule quota for the Batch account." + } + }, + "description": "Account specific properties." + }, + "BatchAccount": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BatchAccountProperties", + "description": "The properties associated with the account." + }, + "identity": { + "$ref": "#/definitions/BatchAccountIdentity", + "description": "The identity of the Batch account." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Contains information about an Azure Batch account." + }, + "BatchAccountUpdateParameters": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The user-specified tags associated with the account." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BatchAccountUpdateProperties", + "description": "The properties of the account." + }, + "identity": { + "$ref": "#/definitions/BatchAccountIdentity", + "description": "The identity of the Batch account." + } + }, + "description": "Parameters for updating an Azure Batch account." + }, + "BatchAccountListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BatchAccount" + }, + "description": "The collection of Batch accounts returned by the listing operation." + }, + "nextLink": { + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "EncryptionProperties": { + "properties": { + "keySource": { + "type": "string", + "description": "Type of the key source.", + "enum": [ + "Microsoft.Batch", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "KeySource", + "modelAsString": false, + "values": [ + { + "value": "Microsoft.Batch", + "description": "Batch creates and manages the encryption keys used to protect the account data." + }, + { + "value": "Microsoft.KeyVault", + "description": "The encryption keys used to protect the account data are stored in an external key vault. If this is set then the Batch Account identity must be set to `SystemAssigned` and a valid Key Identifier must also be supplied under the keyVaultProperties." + } + ] + } + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Additional details when using Microsoft.KeyVault" + } + }, + "description": "Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead." + }, + "KeyVaultProperties": { + "properties": { + "keyIdentifier": { + "type": "string", + "description": "Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. To be usable the following prerequisites must be met:\n\n The Batch Account has a System Assigned identity\n The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions\n The KeyVault has soft-delete and purge protection enabled" + } + }, + "description": "KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault." + }, + "BatchAccountRegenerateKeyParameters": { + "properties": { + "keyName": { + "type": "string", + "description": "The type of account key to regenerate.", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "AccountKeyType", + "modelAsString": false, + "values": [ + { + "value": "Primary", + "description": "The primary account key." + }, + { + "value": "Secondary", + "description": "The secondary account key." + } + ] + } + } + }, + "required": [ + "keyName" + ], + "description": "Parameters supplied to the RegenerateKey operation." + }, + "BatchAccountKeys": { + "properties": { + "accountName": { + "type": "string", + "readOnly": true, + "description": "The Batch account name." + }, + "primary": { + "type": "string", + "readOnly": true, + "description": "The primary key associated with the account." + }, + "secondary": { + "type": "string", + "readOnly": true, + "description": "The secondary key associated with the account." + } + }, + "description": "A set of Azure Batch account keys." + }, + "ActivateApplicationPackageParameters": { + "properties": { + "format": { + "type": "string", + "description": "The format of the application package binary file." + } + }, + "required": [ + "format" + ], + "description": "Parameters for an activating an application package." + }, + "Application": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationProperties", + "description": "The properties associated with the Application." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Contains information about an application in a Batch account." + }, + "ApplicationProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "The display name for the application." + }, + "allowUpdates": { + "type": "boolean", + "description": "A value indicating whether packages within the application may be overwritten using the same version string." + }, + "defaultVersion": { + "type": "string", + "description": "The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package." + } + }, + "description": "The properties associated with the Application." + }, + "ApplicationPackage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationPackageProperties", + "description": "The properties associated with the Application Package." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "An application package which represents a particular version of an application." + }, + "ApplicationPackageProperties": { + "properties": { + "state": { + "type": "string", + "readOnly": true, + "description": "The current state of the application package.", + "enum": [ + "Pending", + "Active" + ], + "x-ms-enum": { + "name": "PackageState", + "modelAsString": false, + "values": [ + { + "value": "Pending", + "description": "The application package has been created but has not yet been activated." + }, + { + "value": "Active", + "description": "The application package is ready for use." + } + ] + } + }, + "format": { + "type": "string", + "readOnly": true, + "description": "The format of the application package, if the package is active." + }, + "storageUrl": { + "type": "string", + "readOnly": true, + "description": "The URL for the application package in Azure Storage." + }, + "storageUrlExpiry": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The UTC time at which the Azure Storage URL will expire." + }, + "lastActivationTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time at which the package was last activated, if the package is active." + } + }, + "description": "Properties of an application package" + }, + "ListApplicationsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Application" + }, + "description": "The list of applications." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "The result of performing list applications." + }, + "ListApplicationPackagesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackage" + }, + "description": "The list of application packages." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "The result of performing list application packages." + }, + "BatchLocationQuota": { + "properties": { + "accountQuota": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The number of Batch accounts that may be created under the subscription in the specified region." + } + }, + "description": "Quotas associated with a Batch region for a particular subscription." + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource." + }, + "location": { + "readOnly": true, + "type": "string", + "description": "The location of the resource." + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags of the resource." + } + }, + "description": "A definition of an Azure resource.", + "x-ms-azure-resource": true + }, + "ProxyResource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "The ETag of the resource, used for concurrency statements." + } + }, + "description": "A definition of an Azure resource.", + "x-ms-azure-resource": true + }, + "PublicNetworkAccessType": { + "type": "string", + "description": "The network access type for operating on the resources in the Batch account.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccessType", + "modelAsString": false, + "values": [ + { + "value": "Enabled", + "description": "Enables connectivity to Azure Batch through public DNS." + }, + { + "value": "Disabled", + "description": "Disables public connectivity and enables private connectivity to Azure Batch Service through private endpoint resource." + } + ] + } + }, + "PoolAllocationMode": { + "type": "string", + "description": "The allocation mode for creating pools in the Batch account.", + "enum": [ + "BatchService", + "UserSubscription" + ], + "x-ms-enum": { + "name": "PoolAllocationMode", + "modelAsString": false, + "values": [ + { + "value": "BatchService", + "description": "Pools will be allocated in subscriptions owned by the Batch service." + }, + { + "value": "UserSubscription", + "description": "Pools will be allocated in a subscription owned by the user." + } + ] + } + }, + "CertificateBaseProperties": { + "properties": { + "thumbprintAlgorithm": { + "type": "string", + "title": "The algorithm of the certificate thumbprint.", + "description": "This must match the first portion of the certificate name. Currently required to be 'SHA1'." + }, + "thumbprint": { + "type": "string", + "title": "The thumbprint of the certificate.", + "description": "This must match the thumbprint from the name." + }, + "format": { + "type": "string", + "x-nullable": false, + "description": "The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx.", + "enum": [ + "Pfx", + "Cer" + ], + "x-ms-enum": { + "name": "CertificateFormat", + "modelAsString": false, + "values": [ + { + "value": "Pfx", + "description": "The certificate is a PFX (PKCS#12) formatted certificate or certificate chain." + }, + { + "value": "Cer", + "description": "The certificate is a base64-encoded X.509 certificate." + } + ] + } + } + } + }, + "CertificateProperties": { + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "x-nullable": false, + "title": "The provisioned state of the resource", + "enum": [ + "Succeeded", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "CertificateProvisioningState", + "modelAsString": false, + "values": [ + { + "value": "Succeeded", + "description": "The certificate is available for use in pools." + }, + { + "value": "Deleting", + "description": "The user has requested that the certificate be deleted, but the delete operation has not yet completed. You may not reference the certificate when creating or updating pools." + }, + { + "value": "Failed", + "description": "The user requested that the certificate be deleted, but there are pools that still have references to the certificate, or it is still installed on one or more compute nodes. (The latter can occur if the certificate has been removed from the pool, but the node has not yet restarted. Nodes refresh their certificates only when they restart.) You may use the cancel certificate delete operation to cancel the delete, or the delete certificate operation to retry the delete." + } + ] + } + }, + "provisioningStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the certificate entered its current state.", + "readOnly": true + }, + "previousProvisioningState": { + "type": "string", + "readOnly": true, + "x-nullable": false, + "description": "The previous provisioned state of the resource", + "enum": [ + "Succeeded", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "CertificateProvisioningState", + "modelAsString": false, + "values": [ + { + "value": "Succeeded", + "description": "The certificate is available for use in pools." + }, + { + "value": "Deleting", + "description": "The user has requested that the certificate be deleted, but the delete operation has not yet completed. You may not reference the certificate when creating or updating pools." + }, + { + "value": "Failed", + "description": "The user requested that the certificate be deleted, but there are pools that still have references to the certificate, or it is still installed on one or more compute nodes. (The latter can occur if the certificate has been removed from the pool, but the node has not yet restarted. Nodes refresh their certificates only when they restart.) You may use the cancel certificate delete operation to cancel the delete, or the delete certificate operation to retry the delete." + } + ] + } + }, + "previousProvisioningStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the certificate entered its previous state.", + "readOnly": true + }, + "publicData": { + "type": "string", + "readOnly": true, + "description": "The public key of the certificate." + }, + "deleteCertificateError": { + "readOnly": true, + "$ref": "#/definitions/DeleteCertificateError", + "title": "The error which occurred while deleting the certificate", + "description": "This is only returned when the certificate provisioningState is 'Failed'." + } + }, + "allOf": [ + { + "$ref": "#/definitions/CertificateBaseProperties" + } + ], + "description": "Certificate properties." + }, + "CertificateCreateOrUpdateProperties": { + "allOf": [ + { + "$ref": "#/definitions/CertificateBaseProperties" + } + ], + "properties": { + "data": { + "type": "string", + "title": "The base64-encoded contents of the certificate.", + "description": "The maximum size is 10KB." + }, + "password": { + "type": "string", + "title": "The password to access the certificate's private key.", + "description": "This must not be specified if the certificate format is Cer." + } + }, + "description": "Certificate properties for create operations", + "required": [ + "data" + ] + }, + "Certificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CertificateProperties", + "description": "The properties associated with the certificate." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Contains information about a certificate." + }, + "CertificateCreateOrUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CertificateCreateOrUpdateProperties", + "description": "The properties associated with the certificate." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Contains information about a certificate." + }, + "ListCertificatesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Certificate" + }, + "description": "The collection of returned certificates." + }, + "nextLink": { + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "DeleteCertificateError": { + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/DeleteCertificateError" + }, + "description": "A list of additional details about the error." + } + }, + "required": [ + "code", + "message" + ], + "description": "An error response from the Batch service." + }, + "PrivateLinkResource": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "The properties associated with the private link resource." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Contains information about a private link resource." + }, + "PrivateLinkResourceProperties": { + "properties": { + "groupId": { + "type": "string", + "title": "The group id of the private link resource.", + "description": "The group id is used to establish the private link connection.", + "readOnly": true + }, + "requiredMembers": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The list of required members that are used to establish the private link connection.", + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The list of required zone names for the private DNS resource name", + "readOnly": true + } + }, + "description": "Private link resource properties." + }, + "PrivateEndpointConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties associated with the private endpoint connection." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Contains information about a private link resource." + }, + "PrivateEndpointConnectionProperties": { + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "x-nullable": false, + "title": "The provisioning state of the private endpoint connection.", + "enum": [ + "Succeeded", + "Updating", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": false, + "values": [ + { + "value": "Succeeded", + "description": "The connection status is final and is ready for use if Status is Approved." + }, + { + "value": "Updating", + "description": "The user has requested that the connection status be updated, but the update operation has not yet completed. You may not reference the connection when connecting the Batch account." + }, + { + "value": "Failed", + "description": "The user requested that the connection be updated and it failed. You may retry the update operation." + } + ] + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "title": "The ARM resource identifier of the private endpoint." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "title": "The private link service connection state of the private endpoint connection." + } + }, + "description": "Private endpoint connection properties." + }, + "PrivateEndpoint": { + "properties": { + "id": { + "type": "string", + "title": "The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.", + "readOnly": true + } + }, + "description": "The private endpoint of the private endpoint connection." + }, + "PrivateLinkServiceConnectionState": { + "properties": { + "status": { + "$ref": "#/definitions/PrivateLinkServiceConnectionStatus", + "title": "The status for the private endpoint connection of Batch account" + }, + "description": { + "type": "string", + "title": "Description of the private Connection state" + }, + "actionRequired": { + "type": "string", + "title": "Action required on the private connection state", + "readOnly": true + } + }, + "required": [ + "status" + ], + "description": "The private link service connection state of the private endpoint connection" + }, + "PrivateLinkServiceConnectionStatus": { + "type": "string", + "title": "The status of the Batch private endpoint connection", + "enum": [ + "Approved", + "Pending", + "Rejected", + "Disconnected" + ], + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": false, + "values": [ + { + "value": "Approved", + "description": "The private endpoint connection is approved and can be used to access Batch account" + }, + { + "value": "Pending", + "description": "The private endpoint connection is pending and cannot be used to access Batch account" + }, + { + "value": "Rejected", + "description": "The private endpoint connection is rejected and cannot be used to access Batch account" + }, + { + "value": "Disconnected", + "description": "The private endpoint connection is disconnected and cannot be used to access Batch account" + } + ] + } + }, + "Pool": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PoolProperties", + "description": "The properties associated with the pool." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Contains information about a pool." + }, + "PoolProperties": { + "properties": { + "displayName": { + "type": "string", + "title": "The display name for the pool.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "title": "The last modified time of the pool.", + "description": "This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state.", + "readOnly": true + }, + "creationTime": { + "type": "string", + "format": "date-time", + "title": "The creation time of the pool.", + "readOnly": true + }, + "provisioningState": { + "type": "string", + "title": "The current state of the pool.", + "enum": [ + "Succeeded", + "Deleting" + ], + "x-ms-enum": { + "name": "PoolProvisioningState", + "modelAsString": false, + "values": [ + { + "value": "Succeeded", + "description": "The pool is available to run tasks subject to the availability of compute nodes." + }, + { + "value": "Deleting", + "description": "The user has requested that the pool be deleted, but the delete operation has not yet completed." + } + ] + }, + "readOnly": true + }, + "provisioningStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the pool entered its current state.", + "readOnly": true + }, + "allocationState": { + "type": "string", + "title": "Whether the pool is resizing.", + "enum": [ + "Steady", + "Resizing", + "Stopping" + ], + "x-ms-enum": { + "name": "AllocationState", + "modelAsString": false, + "values": [ + { + "value": "Steady", + "description": "The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of nodes." + }, + { + "value": "Resizing", + "description": "The pool is resizing; that is, compute nodes are being added to or removed from the pool." + }, + { + "value": "Stopping", + "description": "The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed." + } + ] + }, + "readOnly": true + }, + "allocationStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the pool entered its current allocation state.", + "readOnly": true + }, + "vmSize": { + "type": "string", + "title": "The size of virtual machines in the pool. All VMs in a pool are the same size.", + "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." + }, + "deploymentConfiguration": { + "$ref": "#/definitions/DeploymentConfiguration", + "title": "This property describes how the pool nodes will be deployed - using Cloud Services or Virtual Machines.", + "description": "Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS)." + }, + "currentDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The number of compute nodes currently in the pool.", + "readOnly": true + }, + "currentLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The number of low priority compute nodes currently in the pool.", + "readOnly": true + }, + "scaleSettings": { + "$ref": "#/definitions/ScaleSettings", + "title": "Settings which configure the number of nodes in the pool." + }, + "autoScaleRun": { + "$ref": "#/definitions/AutoScaleRun", + "title": "The results and errors from the last execution of the autoscale formula.", + "description": "This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.", + "readOnly": true + }, + "interNodeCommunication": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "InterNodeCommunicationState", + "modelAsString": false, + "values": [ + { + "value": "Enabled", + "description": "Enable network communication between virtual machines." + }, + { + "value": "Disabled", + "description": "Disable network communication between virtual machines." + } + ] + }, + "title": "Whether the pool permits direct communication between nodes.", + "description": "This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'." + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "title": "The network configuration for the pool." + }, + "taskSlotsPerNode": { + "type": "integer", + "format": "int32", + "title": "The number of task slots that can be used to run concurrent tasks on a single compute node in the pool.", + "description": "The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256." + }, + "taskSchedulingPolicy": { + "$ref": "#/definitions/TaskSchedulingPolicy", + "title": "How tasks are distributed across compute nodes in a pool.", + "description": "If not specified, the default is spread." + }, + "userAccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/UserAccount" + }, + "title": "The list of user accounts to be created on each node in the pool." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the pool as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + }, + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "A task specified to run on each compute node as it joins the pool.", + "description": "In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool." + }, + "certificates": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateReference" + }, + "title": "The list of certificates to be installed on each compute node in the pool.", + "description": "For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory." + }, + "applicationPackages": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "The list of application packages to be installed on each compute node in the pool.", + "description": "Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool." + }, + "applicationLicenses": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The list of application licenses the Batch service will make available on each compute node in the pool.", + "description": "The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail." + }, + "resizeOperationStatus": { + "$ref": "#/definitions/ResizeOperationStatus", + "title": "Contains details about the current or last completed resize operation.", + "readOnly": true + }, + "mountConfiguration": { + "type": "array", + "items": { + "$ref": "#/definitions/MountConfiguration" + }, + "title": "A list of file systems to mount on each node in the pool.", + "description": "This supports Azure Files, NFS, CIFS/SMB, and Blobfuse." + } + }, + "description": "Pool properties." + }, + "DeploymentConfiguration": { + "properties": { + "cloudServiceConfiguration": { + "$ref": "#/definitions/CloudServiceConfiguration", + "title": "The cloud service configuration for the pool.", + "description": "This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'." + }, + "virtualMachineConfiguration": { + "$ref": "#/definitions/VirtualMachineConfiguration", + "title": "The virtual machine configuration for the pool.", + "description": "This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified." + } + }, + "title": "Deployment configuration properties." + }, + "ScaleSettings": { + "properties": { + "fixedScale": { + "$ref": "#/definitions/FixedScaleSettings", + "title": "Fixed scale settings for the pool.", + "description": "This property and autoScale are mutually exclusive and one of the properties must be specified." + }, + "autoScale": { + "$ref": "#/definitions/AutoScaleSettings", + "title": "AutoScale settings for the pool.", + "description": "This property and fixedScale are mutually exclusive and one of the properties must be specified." + } + }, + "title": "Scale settings for the pool", + "description": "Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes." + }, + "AutoScaleSettings": { + "properties": { + "formula": { + "type": "string", + "title": "A formula for the desired number of compute nodes in the pool.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/batch/batch-automatic-scaling", + "description": "Create an automatic scaling formula for scaling compute nodes in a Batch pool" + } + }, + "evaluationInterval": { + "type": "string", + "format": "duration", + "title": "The time interval at which to automatically adjust the pool size according to the autoscale formula.", + "description": "If omitted, the default value is 15 minutes (PT15M)." + } + }, + "required": [ + "formula" + ], + "title": "AutoScale settings for the pool." + }, + "FixedScaleSettings": { + "properties": { + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for allocation of compute nodes to the pool.", + "description": "The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of dedicated compute nodes in the pool.", + "description": "At least one of targetDedicatedNodes, targetLowPriorityNodes must be set." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of low-priority compute nodes in the pool.", + "description": "At least one of targetDedicatedNodes, targetLowPriorityNodes must be set." + }, + "nodeDeallocationOption": { + "title": "Determines what to do with a node and its running task(s) if the pool size is decreasing.", + "description": "If omitted, the default value is Requeue.", + "$ref": "#/definitions/ComputeNodeDeallocationOption" + } + }, + "title": "Fixed scale settings for the pool." + }, + "ComputeNodeDeallocationOption": { + "type": "string", + "title": "Determines what to do with a node and its running task(s) after it has been selected for deallocation.", + "enum": [ + "Requeue", + "Terminate", + "TaskCompletion", + "RetainedData" + ], + "x-ms-enum": { + "name": "ComputeNodeDeallocationOption", + "modelAsString": false, + "values": [ + { + "value": "Requeue", + "description": "Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated." + }, + { + "value": "Terminate", + "description": "Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated." + }, + { + "value": "TaskCompletion", + "description": "Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed." + }, + { + "value": "RetainedData", + "description": "Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired." + } + ] + } + }, + "CertificateReference": { + "properties": { + "id": { + "type": "string", + "title": "The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool." + }, + "storeLocation": { + "type": "string", + "title": "The location of the certificate store on the compute node into which to install the certificate.", + "description": "The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.", + "enum": [ + "CurrentUser", + "LocalMachine" + ], + "x-ms-enum": { + "name": "CertificateStoreLocation", + "modelAsString": false, + "values": [ + { + "value": "CurrentUser", + "description": "Certificates should be installed to the CurrentUser certificate store." + }, + { + "value": "LocalMachine", + "description": "Certificates should be installed to the LocalMachine certificate store." + } + ] + } + }, + "storeName": { + "type": "string", + "title": "The name of the certificate store on the compute node into which to install the certificate.", + "description": "This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My." + }, + "visibility": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false, + "enum": [ + "StartTask", + "Task", + "RemoteUser" + ], + "x-ms-enum": { + "name": "CertificateVisibility", + "modelAsString": false, + "values": [ + { + "value": "StartTask", + "description": "The certificate should be visible to the user account under which the start task is run. Note that if AutoUser Scope is Pool for both the StartTask and a Task, this certificate will be visible to the Task as well." + }, + { + "value": "Task", + "description": "The certificate should be visible to the user accounts under which job tasks are run." + }, + { + "value": "RemoteUser", + "description": "The certificate should be visible to the user accounts under which users remotely access the node." + } + ] + } + }, + "title": "Which user accounts on the compute node should have access to the private data of the certificate." + } + }, + "required": [ + "id" + ], + "title": "A reference to a certificate to be installed on compute nodes in a pool. This must exist inside the same account as the pool." + }, + "ApplicationPackageReference": { + "properties": { + "id": { + "type": "string", + "title": "The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists." + }, + "version": { + "type": "string", + "title": "The version of the application to deploy. If omitted, the default version is deployed.", + "description": "If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409." + } + }, + "title": "Link to an application package inside the batch account", + "required": [ + "id" + ] + }, + "ResizeError": { + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ResizeError" + }, + "title": "Additional details about the error." + } + }, + "title": "An error that occurred when resizing a pool.", + "required": [ + "code", + "message" + ] + }, + "AutoScaleRunError": { + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/AutoScaleRunError" + }, + "title": "Additional details about the error." + } + }, + "title": "An error that occurred when autoscaling a pool.", + "required": [ + "code", + "message" + ] + }, + "AutoScaleRun": { + "properties": { + "evaluationTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the autoscale formula was last evaluated." + }, + "results": { + "type": "string", + "title": "The final values of all variables used in the evaluation of the autoscale formula.", + "description": "Each variable value is returned in the form $variable=value, and variables are separated by semicolons." + }, + "error": { + "$ref": "#/definitions/AutoScaleRunError", + "title": "Details of the error encountered evaluating the autoscale formula on the pool, if the evaluation was unsuccessful." + } + }, + "required": [ + "evaluationTime" + ], + "title": "The results and errors from an execution of a pool autoscale formula." + }, + "VirtualMachineConfiguration": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "title": "A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use." + }, + "nodeAgentSkuId": { + "type": "string", + "title": "The SKU of the Batch node agent to be provisioned on compute nodes in the pool.", + "description": "The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation." + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "title": "Windows operating system settings on the virtual machine.", + "description": "This property must not be specified if the imageReference specifies a Linux OS image." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + }, + "title": "The configuration for data disks attached to the compute nodes in the pool.", + "description": "This property must be specified if the compute nodes in the pool need to have empty data disks attached to them." + }, + "licenseType": { + "type": "string", + "title": "The type of on-premises license to be used when deploying the operating system.", + "description": "This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:\n\n Windows_Server - The on-premises license is for Windows Server.\n Windows_Client - The on-premises license is for Windows Client.\n" + }, + "containerConfiguration": { + "$ref": "#/definitions/ContainerConfiguration", + "title": "The container configuration for the pool.", + "description": "If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it." + }, + "diskEncryptionConfiguration": { + "$ref": "#/definitions/DiskEncryptionConfiguration", + "title": "The disk encryption configuration for the pool.", + "description": "If specified, encryption is performed on each node in the pool during node provisioning." + } + }, + "required": [ + "imageReference", + "nodeAgentSkuId" + ], + "title": "The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure." + }, + "ContainerRegistry": { + "properties": { + "registryServer": { + "type": "string", + "title": "The registry URL.", + "description": "If omitted, the default is \"docker.io\"." + }, + "username": { + "type": "string", + "x-ms-client-name": "userName", + "title": "The user name to log into the registry server." + }, + "password": { + "type": "string", + "title": "The password to log into the registry server." + } + }, + "required": [ + "username", + "password" + ], + "title": "A private container registry." + }, + "DiskEncryptionConfiguration": { + "properties": { + "targets": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false, + "title": "The disks to encrypt on each compute node.", + "description": "If omitted, no disks on the compute nodes in the pool will be encrypted.", + "enum": [ + "OsDisk", + "TemporaryDisk" + ], + "x-ms-enum": { + "name": "DiskEncryptionTarget", + "modelAsString": false, + "values": [ + { + "value": "OsDisk", + "description": "The OS Disk on the compute node is encrypted.", + "name": "OsDisk" + }, + { + "value": "TemporaryDisk", + "description": "The temporary disk on the compute node is encrypted. On Linux this encryption applies to other partitions (such as those on mounted data disks) when encryption occurs at boot time.", + "name": "TemporaryDisk" + } + ] + } + }, + "title": "The list of disk targets Batch Service will encrypt on the compute node", + "description": "On Linux pool, only \"TemporaryDisk\" is supported; on Windows pool, \"OsDisk\" and \"TemporaryDisk\" must be specified." + } + }, + "description": "The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image Gallery Image." + }, + "ContainerConfiguration": { + "properties": { + "type": { + "type": "string", + "title": "The container technology to be used.", + "enum": [ + "DockerCompatible" + ], + "x-ms-enum": { + "name": "ContainerType", + "modelAsString": false, + "values": [ + { + "value": "DockerCompatible", + "description": "A Docker compatible container technology will be used to launch the containers." + } + ] + } + }, + "containerImageNames": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The collection of container image names.", + "description": "This is the full image reference, as would be specified to \"docker pull\". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry." + }, + "containerRegistries": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerRegistry" + }, + "title": "Additional private registries from which containers can be pulled.", + "description": "If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here." + } + }, + "required": [ + "type" + ], + "title": "The configuration for container-enabled pools." + }, + "WindowsConfiguration": { + "properties": { + "enableAutomaticUpdates": { + "type": "boolean", + "title": "Whether automatic updates are enabled on the virtual machine.", + "description": "If omitted, the default value is true." + } + }, + "title": "Windows operating system settings to apply to the virtual machine." + }, + "ImageReference": { + "properties": { + "publisher": { + "type": "string", + "title": "The publisher of the Azure Virtual Machines Marketplace image.", + "description": "For example, Canonical or MicrosoftWindowsServer." + }, + "offer": { + "type": "string", + "title": "The offer type of the Azure Virtual Machines Marketplace image.", + "description": "For example, UbuntuServer or WindowsServer." + }, + "sku": { + "type": "string", + "title": "The SKU of the Azure Virtual Machines Marketplace image.", + "description": "For example, 18.04-LTS or 2019-Datacenter." + }, + "version": { + "type": "string", + "title": "The version of the Azure Virtual Machines Marketplace image.", + "description": "A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'." + }, + "id": { + "type": "string", + "title": "The ARM resource identifier of the Shared Image Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionId}.", + "description": "This property is mutually exclusive with other properties. The Shared Image Gallery image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration." + } + }, + "title": "A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation." + }, + "DataDisk": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "title": "The logical unit number.", + "description": "The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive." + }, + "caching": { + "$ref": "#/definitions/CachingType", + "title": "The type of caching to be enabled for the data disks.", + "description": "Values are:\n\n none - The caching mode for the disk is not enabled.\n readOnly - The caching mode for the disk is read only.\n readWrite - The caching mode for the disk is read and write.\n\n The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "title": "The initial disk size in GB when creating new data disk." + }, + "storageAccountType": { + "title": "The storage account type to be used for the data disk.", + "description": "If omitted, the default is \"Standard_LRS\". Values are:\n\n Standard_LRS - The data disk should use standard locally redundant storage.\n Premium_LRS - The data disk should use premium locally redundant storage.", + "$ref": "#/definitions/StorageAccountType" + } + }, + "required": [ + "lun", + "diskSizeGB" + ], + "description": "Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them." + }, + "TaskSchedulingPolicy": { + "properties": { + "nodeFillType": { + "type": "string", + "title": "How tasks should be distributed across compute nodes.", + "enum": [ + "Spread", + "Pack" + ], + "x-ms-enum": { + "name": "ComputeNodeFillType", + "modelAsString": false, + "values": [ + { + "value": "Spread", + "description": "Tasks should be assigned evenly across all nodes in the pool." + }, + { + "value": "Pack", + "description": "As many tasks as possible (taskSlotsPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool." + } + ] + } + } + }, + "required": [ + "nodeFillType" + ], + "title": "Specifies how tasks should be distributed across compute nodes." + }, + "LinuxUserConfiguration": { + "properties": { + "uid": { + "type": "integer", + "format": "int32", + "title": "The user ID of the user account.", + "description": "The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid." + }, + "gid": { + "type": "integer", + "format": "int32", + "title": "The group ID for the user account.", + "description": "The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid." + }, + "sshPrivateKey": { + "type": "string", + "title": "The SSH private key for the user account.", + "description": "The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done)." + } + }, + "title": "Properties used to create a user account on a Linux node." + }, + "WindowsUserConfiguration": { + "properties": { + "loginMode": { + "type": "string", + "title": "Login mode for user", + "description": "Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode.", + "enum": [ + "Batch", + "Interactive" + ], + "x-ms-enum": { + "name": "LoginMode", + "modelAsString": false, + "values": [ + { + "value": "Batch", + "description": "The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes." + }, + { + "value": "Interactive", + "description": "The LOGON32_LOGON_INTERACTIVE Win32 login mode. Some applications require having permissions associated with the interactive login mode. If this is the case for an application used in your task, then this option is recommended." + } + ] + } + } + }, + "title": "Properties used to create a user account on a Windows node." + }, + "UserAccount": { + "properties": { + "name": { + "type": "string", + "title": "The name of the user account." + }, + "password": { + "type": "string", + "title": "The password for the user account." + }, + "elevationLevel": { + "title": "The elevation level of the user account.", + "description": "nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.", + "$ref": "#/definitions/ElevationLevel" + }, + "linuxUserConfiguration": { + "title": "The Linux-specific user configuration for the user account.", + "description": "This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.", + "$ref": "#/definitions/LinuxUserConfiguration" + }, + "windowsUserConfiguration": { + "title": "The Windows-specific user configuration for the user account.", + "description": "This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.", + "$ref": "#/definitions/WindowsUserConfiguration" + } + }, + "required": [ + "name", + "password" + ], + "title": "Properties used to create a user on an Azure Batch node." + }, + "StartTask": { + "properties": { + "commandLine": { + "type": "string", + "title": "The command line of the start task.", + "description": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. Required if any other properties of the startTask are specified." + }, + "resourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download to the compute node before running the command line." + }, + "environmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of environment variable settings for the start task." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the start task runs.", + "description": "If omitted, the task runs as a non-administrative user unique to the task." + }, + "maxTaskRetryCount": { + "type": "integer", + "format": "int32", + "title": "The maximum number of times the task may be retried.", + "description": "The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit." + }, + "waitForSuccess": { + "type": "boolean", + "title": "Whether the Batch service should wait for the start task to complete successfully (that is, to exit with exit code 0) before scheduling any tasks on the compute node.", + "description": "If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the start task runs.", + "description": "When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container." + } + }, + "title": "A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged.", + "description": "In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task." + }, + "TaskContainerSettings": { + "properties": { + "containerRunOptions": { + "type": "string", + "title": "Additional options to the container create command.", + "description": "These additional options are supplied as arguments to the \"docker create\" command, in addition to those controlled by the Batch Service." + }, + "imageName": { + "type": "string", + "title": "The image to use to create the container in which the task will run.", + "description": "This is the full image reference, as would be specified to \"docker pull\". If no tag is provided as part of the image name, the tag \":latest\" is used as a default." + }, + "registry": { + "$ref": "#/definitions/ContainerRegistry", + "title": "The private registry which contains the container image.", + "description": "This setting can be omitted if was already provided at pool creation." + }, + "workingDirectory": { + "type": "string", + "title": "A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.", + "enum": [ + "TaskWorkingDirectory", + "ContainerImageDefault" + ], + "x-ms-enum": { + "name": "ContainerWorkingDirectory", + "modelAsString": false, + "values": [ + { + "value": "TaskWorkingDirectory", + "description": "Use the standard Batch service task working directory, which will contain the Task resource files populated by Batch." + }, + { + "value": "ContainerImageDefault", + "description": "Using container image defined working directory. Beware that this directory will not contain the resource files downloaded by Batch." + } + ] + } + } + }, + "required": [ + "imageName" + ], + "title": "The container settings for a task." + }, + "ResourceFile": { + "properties": { + "autoStorageContainerName": { + "type": "string", + "title": "The storage container name in the auto storage account.", + "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified." + }, + "storageContainerUrl": { + "type": "string", + "title": "The URL of the blob container within Azure Blob Storage.", + "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the blob, or set the ACL for the blob or its container to allow public access." + }, + "httpUrl": { + "type": "string", + "title": "The URL of the file to download.", + "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access." + }, + "blobPrefix": { + "type": "string", + "title": "The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded.", + "description": "The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded." + }, + "filePath": { + "type": "string", + "title": "The location on the compute node to which to download the file, relative to the task's working directory.", + "description": "If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..')." + }, + "fileMode": { + "type": "string", + "title": "The file permission mode attribute in octal format.", + "description": "This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file." + } + }, + "title": "A single file or multiple files to be downloaded to a compute node." + }, + "EnvironmentSetting": { + "properties": { + "name": { + "type": "string", + "title": "The name of the environment variable." + }, + "value": { + "type": "string", + "title": "The value of the environment variable." + } + }, + "required": [ + "name" + ], + "title": "An environment variable to be set on a task process." + }, + "UserIdentity": { + "properties": { + "userName": { + "type": "string", + "title": "The name of the user identity under which the task is run.", + "description": "The userName and autoUser properties are mutually exclusive; you must specify one but not both." + }, + "autoUser": { + "$ref": "#/definitions/AutoUserSpecification", + "title": "The auto user under which the task is run.", + "description": "The userName and autoUser properties are mutually exclusive; you must specify one but not both." + } + }, + "title": "The definition of the user identity under which the task is run.", + "description": "Specify either the userName or autoUser property, but not both." + }, + "AutoUserSpecification": { + "properties": { + "scope": { + "type": "string", + "title": "The scope for the auto user", + "description": "The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks.", + "enum": [ + "Task", + "Pool" + ], + "x-ms-enum": { + "name": "AutoUserScope", + "modelAsString": false, + "values": [ + { + "value": "Task", + "description": "Specifies that the service should create a new user for the task." + }, + { + "value": "Pool", + "description": "Specifies that the task runs as the common auto user account which is created on every node in a pool." + } + ] + } + }, + "elevationLevel": { + "title": "The elevation level of the auto user.", + "description": "The default value is nonAdmin.", + "$ref": "#/definitions/ElevationLevel" + } + }, + "title": "Specifies the parameters for the auto user that runs a task on the Batch service." + }, + "ElevationLevel": { + "type": "string", + "title": "The elevation level of the user.", + "enum": [ + "NonAdmin", + "Admin" + ], + "x-ms-enum": { + "name": "ElevationLevel", + "modelAsString": false, + "values": [ + { + "value": "NonAdmin", + "description": "The user is a standard user without elevated access." + }, + { + "value": "Admin", + "description": "The user is a user with elevated access and operates with full Administrator permissions." + } + ] + } + }, + "StorageAccountType": { + "type": "string", + "title": "The storage account type for use in creating data disks.", + "enum": [ + "Standard_LRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": false, + "values": [ + { + "value": "Standard_LRS", + "description": "The data disk should use standard locally redundant storage." + }, + { + "value": "Premium_LRS", + "description": "The data disk should use premium locally redundant storage." + } + ] + } + }, + "CachingType": { + "type": "string", + "title": "The type of caching to enable for the disk.", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingType", + "modelAsString": false, + "values": [ + { + "value": "None", + "description": "The caching mode for the disk is not enabled." + }, + { + "value": "ReadOnly", + "description": "The caching mode for the disk is read only." + }, + { + "value": "ReadWrite", + "description": "The caching mode for the disk is read and write." + } + ] + } + }, + "IPAddressProvisioningType": { + "type": "string", + "title": "The provisioning type for Public IP Addresses for the Batch Pool.", + "enum": [ + "BatchManaged", + "UserManaged", + "NoPublicIPAddresses" + ], + "x-ms-enum": { + "name": "IPAddressProvisioningType", + "modelAsString": false, + "values": [ + { + "value": "BatchManaged", + "description": "A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool." + }, + { + "value": "UserManaged", + "description": "Public IPs are provided by the user and will be used to provision the Compute Nodes." + }, + { + "value": "NoPublicIPAddresses", + "description": "No public IP Address will be created for the Compute Nodes in the Pool." + } + ] + } + }, + "PublicIPAddressConfiguration": { + "properties": { + "provision": { + "$ref": "#/definitions/IPAddressProvisioningType", + "title": "The provisioning type for Public IP Addresses for the pool", + "description": "The default value is BatchManaged" + }, + "ipAddressIds": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The list of public IPs which the Batch service will use when provisioning Compute Nodes.", + "description": "The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}." + } + }, + "description": "The public IP Address configuration of the networking configuration of a Pool." + }, + "NetworkConfiguration": { + "properties": { + "subnetId": { + "type": "string", + "title": "The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.", + "description": "The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration", + "externalDocs": { + "url": "https://azure.microsoft.com/en-us/documentation/articles/role-based-access-built-in-roles/#classic-virtual-machine-contributor", + "description": "Setting up RBAC for Azure Batch VNets" + } + }, + "endpointConfiguration": { + "$ref": "#/definitions/PoolEndpointConfiguration", + "title": "The configuration for endpoints on compute nodes in the Batch pool.", + "description": "Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/PublicIPAddressConfiguration", + "title": "The Public IPAddress configuration for Compute Nodes in the Batch Pool.", + "description": "This property is only supported on Pools with the virtualMachineConfiguration property." + } + }, + "description": "The network configuration for a pool." + }, + "CloudServiceConfiguration": { + "properties": { + "osFamily": { + "type": "string", + "title": "The Azure Guest OS family to be installed on the virtual machines in the pool.", + "description": "Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases)." + }, + "osVersion": { + "type": "string", + "title": "The Azure Guest OS version to be installed on the virtual machines in the pool.", + "description": "The default value is * which specifies the latest operating system version for the specified OS family." + } + }, + "required": [ + "osFamily" + ], + "title": "The configuration for nodes in a pool based on the Azure Cloud Services platform." + }, + "MetadataItem": { + "properties": { + "name": { + "type": "string", + "title": "The name of the metadata item." + }, + "value": { + "type": "string", + "title": "The value of the metadata item." + } + }, + "required": [ + "name", + "value" + ], + "title": "A name-value pair associated with a Batch service resource.", + "description": "The Batch service does not assign any meaning to this metadata; it is solely for the use of user code." + }, + "ResizeOperationStatus": { + "properties": { + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of dedicated compute nodes in the pool." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of low-priority compute nodes in the pool." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool.", + "description": "The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "nodeDeallocationOption": { + "title": "Determines what to do with a node and its running task(s) if the pool size is decreasing.", + "description": "The default value is requeue.", + "$ref": "#/definitions/ComputeNodeDeallocationOption" + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The time when this resize operation was started." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ResizeError" + }, + "title": "Details of any errors encountered while performing the last resize on the pool.", + "description": "This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady." + } + }, + "title": "Details about the current or last completed resize operation.", + "description": "Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady)." + }, + "PoolEndpointConfiguration": { + "properties": { + "inboundNatPools": { + "type": "array", + "items": { + "$ref": "#/definitions/InboundNatPool" + }, + "title": "A list of inbound NAT pools that can be used to address specific ports on an individual compute node externally.", + "description": "The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses." + } + }, + "required": [ + "inboundNatPools" + ], + "title": "The endpoint configuration for a pool." + }, + "InboundNatPool": { + "properties": { + "name": { + "type": "string", + "title": "The name of the endpoint.", + "description": "The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400." + }, + "protocol": { + "type": "string", + "title": "The protocol of the endpoint.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "InboundEndpointProtocol", + "modelAsString": false, + "values": [ + { + "value": "TCP", + "description": "Use TCP for the endpoint." + }, + { + "value": "UDP", + "description": "Use UDP for the endpoint." + } + ] + } + }, + "backendPort": { + "type": "integer", + "format": "int32", + "title": "The port number on the compute node.", + "description": "This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400." + }, + "frontendPortRangeStart": { + "type": "integer", + "format": "int32", + "title": "The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes.", + "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400." + }, + "frontendPortRangeEnd": { + "type": "integer", + "format": "int32", + "title": "The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes.", + "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400." + }, + "networkSecurityGroupRules": { + "type": "array", + "title": "A list of network security group rules that will be applied to the endpoint.", + "description": "The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.", + "items": { + "$ref": "#/definitions/NetworkSecurityGroupRule" + } + } + }, + "required": [ + "name", + "protocol", + "backendPort", + "frontendPortRangeStart", + "frontendPortRangeEnd" + ], + "title": "A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally." + }, + "NetworkSecurityGroupRule": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority for this rule.", + "description": "Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400." + }, + "access": { + "type": "string", + "title": "The action that should be taken for a specified IP address, subnet range or tag.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "NetworkSecurityGroupRuleAccess", + "modelAsString": false, + "values": [ + { + "value": "Allow", + "description": "Allow access." + }, + { + "value": "Deny", + "description": "Deny access." + } + ] + } + }, + "sourceAddressPrefix": { + "type": "string", + "title": "The source address prefix or tag to match for the rule.", + "description": "Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The source port ranges to match for the rule.", + "description": "Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *." + } + }, + "required": [ + "priority", + "access", + "sourceAddressPrefix" + ], + "title": "A network security group rule to apply to an inbound endpoint." + }, + "ListPrivateLinkResourcesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "The collection of returned private link resources." + }, + "nextLink": { + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "ListPrivateEndpointConnectionsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The collection of returned private endpoint connection." + }, + "nextLink": { + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "ListPoolsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Pool" + }, + "description": "The collection of returned pools." + }, + "nextLink": { + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the Batch service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Batch service." + }, + "Operation": { + "title": "A REST API operation", + "type": "object", + "properties": { + "name": { + "title": "The operation name.", + "description": "This is of the format {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "title": "The object that describes the operation.", + "properties": { + "provider": { + "title": "Friendly name of the resource provider.", + "type": "string" + }, + "operation": { + "title": "The operation type.", + "description": "For example: read, write, delete, or listKeys/action", + "type": "string" + }, + "resource": { + "title": "The resource type on which the operation is performed.", + "type": "string" + }, + "description": { + "title": "The friendly name of the operation", + "type": "string" + } + } + }, + "origin": { + "title": "The intended executor of the operation.", + "type": "string" + }, + "properties": { + "title": "Properties of the operation.", + "type": "object" + } + } + }, + "OperationListResult": { + "title": "Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "title": "The list of operations supported by the resource provider." + }, + "nextLink": { + "type": "string", + "title": "The URL to get the next set of operation list results if there are any." + } + } + }, + "CheckNameAvailabilityParameters": { + "properties": { + "name": { + "type": "string", + "description": "The name to check for availability" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Batch/batchAccounts" + ], + "x-ms-enum": { + "name": "ResourceType", + "modelAsString": false, + "values": [ + { + "value": "Microsoft.Batch/batchAccounts", + "description": "The Batch account resource type.", + "name": "BatchAccounts" + } + ] + }, + "description": "The resource type." + } + }, + "required": [ + "name", + "type" + ], + "description": "Parameters for a check name availability request." + }, + "CheckNameAvailabilityResult": { + "properties": { + "nameAvailable": { + "readOnly": true, + "type": "boolean", + "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used." + }, + "reason": { + "readOnly": true, + "type": "string", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "NameAvailabilityReason", + "modelAsString": false, + "values": [ + { + "value": "Invalid", + "description": "The requested name is invalid." + }, + { + "value": "AlreadyExists", + "description": "The requested name is already in use." + } + ] + }, + "description": "Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "Gets an error message explaining the Reason value in more detail." + } + }, + "description": "The CheckNameAvailability operation response." + }, + "MountConfiguration": { + "properties": { + "azureBlobFileSystemConfiguration": { + "$ref": "#/definitions/AzureBlobFileSystemConfiguration", + "title": "The Azure Storage Container to mount using blob FUSE on each node.", + "description": "This property is mutually exclusive with all other properties." + }, + "nfsMountConfiguration": { + "$ref": "#/definitions/NFSMountConfiguration", + "title": "The NFS file system to mount on each node.", + "description": "This property is mutually exclusive with all other properties." + }, + "cifsMountConfiguration": { + "$ref": "#/definitions/CIFSMountConfiguration", + "title": "The CIFS/SMB file system to mount on each node.", + "description": "This property is mutually exclusive with all other properties." + }, + "azureFileShareConfiguration": { + "$ref": "#/definitions/AzureFileShareConfiguration", + "title": "The Azure File Share to mount on each node.", + "description": "This property is mutually exclusive with all other properties." + } + }, + "title": "The file system to mount on each node." + }, + "AzureBlobFileSystemConfiguration": { + "properties": { + "accountName": { + "type": "string", + "title": "The Azure Storage Account name." + }, + "containerName": { + "type": "string", + "title": "The Azure Blob Storage Container name." + }, + "accountKey": { + "type": "string", + "title": "The Azure Storage Account key.", + "description": "This property is mutually exclusive with sasKey and one must be specified." + }, + "sasKey": { + "type": "string", + "title": "The Azure Storage SAS token.", + "description": "This property is mutually exclusive with accountKey and one must be specified." + }, + "blobfuseOptions": { + "type": "string", + "title": "Additional command line options to pass to the mount command.", + "description": "These are 'net use' options in Windows and 'mount' options in Linux." + }, + "relativeMountPath": { + "type": "string", + "title": "The relative path on the compute node where the file system will be mounted", + "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." + } + }, + "required": [ + "accountName", + "containerName", + "relativeMountPath" + ], + "title": "Information used to connect to an Azure Storage Container using Blobfuse." + }, + "NFSMountConfiguration": { + "properties": { + "source": { + "type": "string", + "title": "The URI of the file system to mount." + }, + "relativeMountPath": { + "type": "string", + "title": "The relative path on the compute node where the file system will be mounted", + "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." + }, + "mountOptions": { + "type": "string", + "title": "Additional command line options to pass to the mount command.", + "description": "These are 'net use' options in Windows and 'mount' options in Linux." + } + }, + "required": [ + "source", + "relativeMountPath" + ], + "title": "Information used to connect to an NFS file system." + }, + "CIFSMountConfiguration": { + "properties": { + "username": { + "type": "string", + "title": "The user to use for authentication against the CIFS file system." + }, + "source": { + "type": "string", + "title": "The URI of the file system to mount." + }, + "relativeMountPath": { + "type": "string", + "title": "The relative path on the compute node where the file system will be mounted", + "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." + }, + "mountOptions": { + "type": "string", + "title": "Additional command line options to pass to the mount command.", + "description": "These are 'net use' options in Windows and 'mount' options in Linux." + }, + "password": { + "type": "string", + "title": "The password to use for authentication against the CIFS file system." + } + }, + "required": [ + "username", + "source", + "password", + "relativeMountPath" + ], + "title": "Information used to connect to a CIFS file system." + }, + "AzureFileShareConfiguration": { + "properties": { + "accountName": { + "type": "string", + "title": "The Azure Storage account name." + }, + "azureFileUrl": { + "type": "string", + "title": "The Azure Files URL.", + "description": "This is of the form 'https://{account}.file.core.windows.net/'." + }, + "accountKey": { + "type": "string", + "title": "The Azure Storage account key." + }, + "relativeMountPath": { + "type": "string", + "title": "The relative path on the compute node where the file system will be mounted", + "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." + }, + "mountOptions": { + "type": "string", + "title": "Additional command line options to pass to the mount command.", + "description": "These are 'net use' options in Windows and 'mount' options in Linux." + } + }, + "required": [ + "accountName", + "azureFileUrl", + "accountKey", + "relativeMountPath" + ], + "title": "Information used to connect to an Azure Fileshare." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to be used with the HTTP request." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group that contains the Batch account.", + "x-ms-parameter-location": "method" + }, + "AccountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+$", + "minLength": 3, + "maxLength": 24, + "description": "The name of the Batch account.", + "x-ms-parameter-location": "method" + }, + "CertificateNameParameter": { + "name": "certificateName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[\\w]+-[\\w]+$", + "minLength": 5, + "maxLength": 45, + "description": "The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.", + "x-ms-parameter-location": "method" + }, + "PoolNameParameter": { + "name": "poolName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "minLength": 1, + "maxLength": 64, + "description": "The pool name. This must be unique within the account.", + "x-ms-parameter-location": "method" + }, + "PrivateLinkResourceNameParameter": { + "name": "privateLinkResourceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+\\.?[a-fA-F0-9-]*$", + "minLength": 1, + "maxLength": 101, + "description": "The private link resource name. This must be unique within the account.", + "x-ms-parameter-location": "method" + }, + "PrivateEndpointConnectionNameParameter": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+\\.?[a-fA-F0-9-]*$", + "minLength": 1, + "maxLength": 101, + "description": "The private endpoint connection name. This must be unique within the account.", + "x-ms-parameter-location": "method" + }, + "ApplicationNameParameter": { + "name": "applicationName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the application. This must be unique within the account.", + "x-ms-parameter-location": "method" + }, + "VersionNameParameter": { + "name": "versionName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-][a-zA-Z0-9_.-]*$", + "minLength": 1, + "maxLength": 64, + "description": "The version of the application.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationCreate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationCreate.json new file mode 100644 index 000000000000..6b8e8cd6dc8c --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationCreate.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid", + "applicationName": "app1", + "parameters": { + "properties": { + "allowUpdates": false, + "displayName": "myAppName" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D64F8EBB3DC411\"" + }, + "body": { + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1", + "name": "app1", + "etag": "W/\"0x8D64F8EBB3DC411\"", + "properties": { + "allowUpdates": false, + "displayName": "myAppName" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationDelete.json new file mode 100644 index 000000000000..9b227efde0f1 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid", + "applicationName": "app1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationGet.json new file mode 100644 index 000000000000..741f95bce72b --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid", + "applicationName": "app1" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D64F915BDF7F00\"" + }, + "body": { + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1", + "name": "app1", + "etag": "W/\"0x8D64F915BDF7F00\"", + "properties": { + "allowUpdates": true, + "displayName": "Sample Application" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationList.json new file mode 100644 index 000000000000..469e7cb6537e --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1", + "name": "app1", + "etag": "W/\"0x8D64F91A9089879\"", + "properties": { + "allowUpdates": false, + "defaultVersion": "1" + } + }, + { + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app2", + "name": "app1", + "etag": "W/\"0x8D64F91A9089879\"", + "properties": { + "allowUpdates": false, + "defaultVersion": "2.0", + "displayName": "myAppName" + } + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationPackageActivate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationPackageActivate.json new file mode 100644 index 000000000000..a83232097169 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationPackageActivate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid", + "applicationName": "app1", + "versionName": "1", + "parameters": { + "format": "zip" + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D64FEC83A3B436\"" + }, + "body": { + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1", + "name": "1", + "etag": "W/\"0x8D64FEC83A3B436\"", + "properties": { + "state": "Active", + "format": "zip", + "lastActivationTime": "2017-06-27T18:48:09.9330991Z" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationPackageCreate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationPackageCreate.json new file mode 100644 index 000000000000..309a702809e9 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationPackageCreate.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid", + "applicationName": "app1", + "versionName": "1" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D64FEC83A3B436\"" + }, + "body": { + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1", + "name": "1", + "etag": "W/\"0x8D64FEC83A3B436\"", + "properties": { + "storageUrl": "http://mystorage1.blob.core.windows.net/myapp?mysas", + "storageUrlExpiry": "2017-06-27T18:48:09.9330991Z", + "state": "Pending" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationPackageDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationPackageDelete.json new file mode 100644 index 000000000000..6bcf59ddc31e --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationPackageDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid", + "applicationName": "app1", + "versionName": "1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationPackageGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationPackageGet.json new file mode 100644 index 000000000000..f3056d495ef3 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationPackageGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid", + "applicationName": "app1", + "versionName": "1" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D64FEC83A3B436\"" + }, + "body": { + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1", + "name": "1", + "etag": "W/\"0x8D64FEC83A3B436\"", + "properties": { + "state": "Active", + "format": "zip", + "lastActivationTime": "2017-06-27T18:48:09.9330991Z" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationPackageList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationPackageList.json new file mode 100644 index 000000000000..65a151f160bb --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationPackageList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid", + "applicationName": "app1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1.0", + "name": "1.0", + "etag": "W/\"0x8D64FF0B9F47F67\"", + "properties": { + "state": "Pending" + } + }, + { + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/2.0", + "name": "2.0", + "etag": "W/\"0x8D64FF0B9F47F67\"", + "properties": { + "state": "Active", + "format": "zip", + "lastActivationTime": "2017-06-27T18:48:09.9330991Z" + } + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationUpdate.json new file mode 100644 index 000000000000..b8c547c50f69 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/ApplicationUpdate.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid", + "applicationName": "app1", + "parameters": { + "properties": { + "allowUpdates": true, + "displayName": "myAppName", + "defaultVersion": "2" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D64F915BDF7F00\"" + }, + "body": { + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1", + "name": "app1", + "etag": "W/\"0x8D64F915BDF7F00\"", + "properties": { + "allowUpdates": true, + "displayName": "myAppName", + "defaultVersion": "2" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountCreate_BYOS.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountCreate_BYOS.json new file mode 100644 index 000000000000..432f68c14f1f --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountCreate_BYOS.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid", + "parameters": { + "location": "japaneast", + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "poolAllocationMode": "UserSubscription", + "keyVaultReference": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample", + "url": "http://sample.vault.azure.net/" + } + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "UserSubscription", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + }, + "keyVaultReference": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample", + "url": "http://sample.vault.azure.net/" + }, + "publicNetworkAccess": "Enabled" + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountCreate_Default.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountCreate_Default.json new file mode 100644 index 000000000000..3a615a73bbb3 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountCreate_Default.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid", + "parameters": { + "location": "japaneast", + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + } + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "BatchService", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + }, + "publicNetworkAccess": "Enabled" + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountCreate_SystemAssignedIdentity.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountCreate_SystemAssignedIdentity.json new file mode 100644 index 000000000000..ccece80c6834 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountCreate_SystemAssignedIdentity.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid", + "parameters": { + "location": "japaneast", + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + } + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "BatchService", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + }, + "publicNetworkAccess": "Enabled" + }, + "identity": { + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "type": "SystemAssigned" + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountDelete.json new file mode 100644 index 000000000000..10eaf26f009a --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountGet.json new file mode 100644 index 000000000000..30f14fa187c2 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "BatchService", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + }, + "publicNetworkAccess": "Enabled" + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountGetKeys.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountGetKeys.json new file mode 100644 index 000000000000..7ab92a5b58e6 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountGetKeys.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "accountName": "sampleacct", + "primary": "AAAA==", + "secondary": "BBBB==" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountList.json new file mode 100644 index 000000000000..703fc01822af --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "BatchService", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + }, + "publicNetworkAccess": "Enabled" + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountListByResourceGroup.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountListByResourceGroup.json new file mode 100644 index 000000000000..15a83c30b5b9 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountListByResourceGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "BatchService", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + }, + "publicNetworkAccess": "Enabled" + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountRegenerateKey.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountRegenerateKey.json new file mode 100644 index 000000000000..84ec60d93d81 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountRegenerateKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid", + "parameters": { + "keyName": "Primary" + } + }, + "responses": { + "200": { + "body": { + "accountName": "sampleacct", + "primary": "AAAA==", + "secondary": "BBBB==" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountSynchronizeAutoStorageKeys.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountSynchronizeAutoStorageKeys.json new file mode 100644 index 000000000000..409b0dcc2a60 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountSynchronizeAutoStorageKeys.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountUpdate.json new file mode 100644 index 000000000000..019431d6ed87 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/BatchAccountUpdate.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid", + "parameters": { + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "BatchService", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + }, + "publicNetworkAccess": "Enabled" + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateCancelDeletion.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateCancelDeletion.json new file mode 100644 index 000000000000..7c6934776ce4 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateCancelDeletion.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid", + "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDD513C3EDBB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "type": "Microsoft.Batch/batchAccounts/certificates", + "etag": "W/\"0x8D4EDD513C3EDBB\"", + "properties": { + "thumbprintAlgorithm": "sha1", + "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z", + "previousProvisioningState": "Failed", + "previousProvisioningStateTransitionTime": "2017-07-21T00:22:54.3299195Z", + "format": "Pfx", + "publicData": "MIICrjCCAZagAwI..." + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateCreate_Full.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateCreate_Full.json new file mode 100644 index 000000000000..8d2d14c40ed4 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateCreate_Full.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid", + "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "parameters": { + "properties": { + "thumbprintAlgorithm": "sha1", + "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "data": "MIIJsgIBAzCCCW4GCSqGSIb3DQE...", + "password": "KG0UY40e...", + "format": "Pfx" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDD5118668F7\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "type": "Microsoft.Batch/batchAccounts/certificates", + "etag": "W/\"0x8D4EDD5118668F7\"", + "properties": { + "thumbprintAlgorithm": "sha1", + "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z", + "format": "Pfx", + "publicData": "MIICrjCCAZagAwI..." + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateCreate_Minimal.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateCreate_Minimal.json new file mode 100644 index 000000000000..51cbabcd15c2 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateCreate_Minimal.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid", + "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "parameters": { + "properties": { + "data": "MIIJsgIBAzCCCW4GCSqGSIb3DQE...", + "password": "KG0UY40e..." + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDD5118668F7\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "type": "Microsoft.Batch/batchAccounts/certificates", + "etag": "W/\"0x8D4EDD5118668F7\"", + "properties": { + "thumbprintAlgorithm": "sha1", + "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z", + "format": "Pfx", + "publicData": "MIICrjCCAZagAwI..." + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateCreate_MinimalCer.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateCreate_MinimalCer.json new file mode 100644 index 000000000000..72ebf221b8f9 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateCreate_MinimalCer.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid", + "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "parameters": { + "properties": { + "data": "MIICrjCCAZagAwI...", + "format": "Cer" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDD5118668F7\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "type": "Microsoft.Batch/batchAccounts/certificates", + "etag": "W/\"0x8D4EDD5118668F7\"", + "properties": { + "thumbprintAlgorithm": "sha1", + "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z", + "format": "Cer", + "publicData": "MIICrjCCAZagAwI..." + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateDelete.json new file mode 100644 index 000000000000..000c37203a5f --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "api-version": "2020-09-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Retry-After": "15", + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/certificateOperationResults/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e-8D4EDFF164A11C9?api-version=2020-09-01" + } + }, + "204": {} + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateGet.json new file mode 100644 index 000000000000..ada646b1975b --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDD5118668F7\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "type": "Microsoft.Batch/batchAccounts/certificates", + "etag": "W/\"0x8D4EDD5118668F7\"", + "properties": { + "thumbprintAlgorithm": "sha1", + "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z", + "format": "Pfx", + "publicData": "MIICrjCCAZagAwI..." + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateGetWithDeletionError.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateGetWithDeletionError.json new file mode 100644 index 000000000000..9ec5852cb349 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateGetWithDeletionError.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDD5118668F7\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "type": "Microsoft.Batch/batchAccounts/certificates", + "etag": "W/\"0x8D4EDD5118668F7\"", + "properties": { + "thumbprintAlgorithm": "sha1", + "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "provisioningState": "Failed", + "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z", + "previousProvisioningState": "Deleting", + "previousProvisioningStateTransitionTime": "2017-07-21T00:15:25.5625498Z", + "format": "Pfx", + "publicData": "MIICrjCCAZagAwI...", + "deleteCertificateError": { + "code": "NodesReferencingCertificate", + "message": "The specified certificate is being used by the below mentioned node(s)\nRequestId:2dc78afc-b15b-42d2-8c85-39cb61a0799e\nTime:2017-08-28T10:22:52.8633406Z", + "target": "BatchAccount", + "details": [ + { + "code": "Nodes", + "message": "node1, node3" + } + ] + } + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateList.json new file mode 100644 index 000000000000..951e5eb3f632 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "api-version": "2020-09-01", + "maxResults": "1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "type": "Microsoft.Batch/batchAccounts/certificates", + "etag": "W/\"0x8D4EDD5118668F7\"", + "properties": { + "thumbprintAlgorithm": "sha1", + "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z", + "format": "Pfx", + "publicData": "MIICrjCCAZagAwI..." + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates?api-version=2020-09-01&$skiptoken=NPK%3D28%3A2857p428pug%2022F53A7734C947B8NRK%3D45%3Asha1-c23dc7f22edc793856a7506fe66397ccb4a33b46SM%3D5%3AFalse" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateListWithFilter.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateListWithFilter.json new file mode 100644 index 000000000000..e1b16b5bb131 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateListWithFilter.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "api-version": "2020-09-01", + "$filter": "properties/provisioningStateTransitionTime gt '2017-05-01' or properties/provisioningState eq 'Failed'", + "$select": "properties/format,properties/provisioningState" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "type": "Microsoft.Batch/batchAccounts/certificates", + "etag": "W/\"0x8D4EDD5118668F7\"", + "properties": { + "provisioningState": "Failed", + "format": "Pfx" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-aeb228ffb0bf67a793d61dce263ebd16949f15a1", + "name": "sha1-aeb228ffb0bf67a793d61dce263ebd16949f15a1", + "type": "Microsoft.Batch/batchAccounts/certificates", + "etag": "W/\"0x8D4EDD5118572E0\"", + "properties": { + "provisioningState": "Failed", + "format": "Cer" + } + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateUpdate.json new file mode 100644 index 000000000000..51cbabcd15c2 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/CertificateUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid", + "certificateName": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "parameters": { + "properties": { + "data": "MIIJsgIBAzCCCW4GCSqGSIb3DQE...", + "password": "KG0UY40e..." + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDD5118668F7\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "name": "sha1-0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "type": "Microsoft.Batch/batchAccounts/certificates", + "etag": "W/\"0x8D4EDD5118668F7\"", + "properties": { + "thumbprintAlgorithm": "sha1", + "thumbprint": "0a0e4f50d51beadeac1d35afc5116098e7902e6e", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-07-21T01:47:38.4420202Z", + "format": "Pfx", + "publicData": "MIICrjCCAZagAwI..." + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/LocationCheckNameAvailability_AlreadyExists.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/LocationCheckNameAvailability_AlreadyExists.json new file mode 100644 index 000000000000..7e1fdb190047 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/LocationCheckNameAvailability_AlreadyExists.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid", + "locationName": "japaneast", + "parameters": { + "name": "existingaccountname", + "type": "Microsoft.Batch/batchAccounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "An account named 'existingaccountname' is already in use." + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/LocationCheckNameAvailability_Available.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/LocationCheckNameAvailability_Available.json new file mode 100644 index 000000000000..ef9e76d6a14d --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/LocationCheckNameAvailability_Available.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid", + "locationName": "japaneast", + "parameters": { + "name": "newaccountname", + "type": "Microsoft.Batch/batchAccounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/LocationGetQuotas.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/LocationGetQuotas.json new file mode 100644 index 000000000000..c81c5a8a984b --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/LocationGetQuotas.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "subid", + "locationName": "japaneast" + }, + "responses": { + "200": { + "body": { + "accountQuota": 1 + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_FullExample.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_FullExample.json new file mode 100644 index 000000000000..9e39e88a3411 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_FullExample.json @@ -0,0 +1,285 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2020-09-01", + "parameters": { + "properties": { + "displayName": "my-pool-name", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Enabled", + "taskSlotsPerNode": 13, + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "4", + "osVersion": "WA-GUEST-OS-4.45_201708-01" + } + }, + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "publicIPAddressConfiguration": { + "provision": "UserManaged", + "ipAddressIds": [ + "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135", + "/subscriptions/subid2/resourceGroups/rg24/providers/Microsoft.Network/publicIPAddresses/ip268" + ] + }, + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "protocol": "TCP", + "backendPort": 12001, + "frontendPortRangeStart": 15000, + "frontendPortRangeEnd": 15100, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "sourceAddressPrefix": "192.100.12.45", + "priority": 150, + "sourcePortRanges": [ + "*" + ] + }, + { + "access": "Deny", + "sourceAddressPrefix": "*", + "priority": 3500, + "sourcePortRanges": [ + "*" + ] + } + ] + } + ] + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28, + "resizeTimeout": "PT8M", + "nodeDeallocationOption": "TaskCompletion" + } + }, + "metadata": [ + { + "name": "metadata-1", + "value": "value-1" + }, + { + "name": "metadata-2", + "value": "value-2" + } + ], + "startTask": { + "commandLine": "cmd /c SET", + "resourceFiles": [ + { + "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file", + "filePath": "c:\\temp\\gohere", + "fileMode": "777" + } + ], + "environmentSettings": [ + { + "name": "MYSET", + "value": "1234" + } + ], + "userIdentity": { + "autoUser": { + "scope": "Pool", + "elevationLevel": "Admin" + } + }, + "maxTaskRetryCount": 6, + "waitForSuccess": true + }, + "userAccounts": [ + { + "name": "username1", + "password": "examplepassword", + "elevationLevel": "Admin", + "linuxUserConfiguration": { + "sshPrivateKey": "sshprivatekeyvalue", + "uid": 1234, + "gid": 4567 + } + } + ], + "applicationPackages": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234", + "version": "asdf" + } + ], + "certificates": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567", + "storeLocation": "LocalMachine", + "storeName": "MY", + "visibility": [ + "RemoteUser" + ] + } + ], + "applicationLicenses": [ + "app-license0", + "app-license1" + ] + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Enabled", + "taskSlotsPerNode": 13, + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "4", + "osVersion": "WA-GUEST-OS-4.45_201708-01" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28, + "resizeTimeout": "PT8M", + "nodeDeallocationOption": "TaskCompletion" + } + }, + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "publicIPAddressConfiguration": { + "provision": "UserManaged", + "ipAddressIds": [ + "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135", + "/subscriptions/subid2/resourceGroups/rg24/providers/Microsoft.Network/publicIPAddresses/ip268" + ] + }, + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "protocol": "TCP", + "backendPort": 12001, + "frontendPortRangeStart": 15000, + "frontendPortRangeEnd": 15100, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "sourceAddressPrefix": "192.100.12.45", + "priority": 150, + "sourcePortRanges": [ + "*" + ] + }, + { + "access": "Deny", + "sourceAddressPrefix": "*", + "priority": 3500, + "sourcePortRanges": [ + "*" + ] + } + ] + } + ] + } + }, + "metadata": [ + { + "name": "metadata-1", + "value": "value-1" + }, + { + "name": "metadata-2", + "value": "value-2" + } + ], + "startTask": { + "commandLine": "cmd /c SET", + "resourceFiles": [ + { + "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file", + "filePath": "c:\\temp\\gohere", + "fileMode": "777" + } + ], + "environmentSettings": [ + { + "name": "MYSET", + "value": "1234" + } + ], + "userIdentity": { + "autoUser": { + "scope": "Pool", + "elevationLevel": "Admin" + } + }, + "maxTaskRetryCount": 6, + "waitForSuccess": true + }, + "userAccounts": [ + { + "name": "username1", + "elevationLevel": "Admin", + "linuxUserConfiguration": { + "uid": 1234, + "gid": 4567 + } + } + ], + "applicationPackages": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234", + "version": "asdf" + } + ], + "certificates": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567", + "storeLocation": "LocalMachine", + "storeName": "MY", + "visibility": [ + "RemoteUser" + ] + } + ], + "applicationLicenses": [ + "app-license0", + "app-license1" + ], + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_MinimalCloudServiceConfiguration.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_MinimalCloudServiceConfiguration.json new file mode 100644 index 000000000000..17b557d1e4db --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_MinimalCloudServiceConfiguration.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2020-09-01", + "parameters": { + "properties": { + "vmSize": "STANDARD_D4", + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "5" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 3 + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "5", + "osVersion": "*" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "resizeOperationStatus": { + "startTime": "2017-08-28T10:22:55.9407275Z", + "targetDedicatedNodes": 3, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M" + } + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_MinimalVirtualMachineConfiguration.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_MinimalVirtualMachineConfiguration.json new file mode 100644 index 000000000000..923e04acfa53 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_MinimalVirtualMachineConfiguration.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2020-09-01", + "parameters": { + "properties": { + "vmSize": "STANDARD_D4", + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicatedNodes=1", + "evaluationInterval": "PT5M" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicatedNodes=1", + "evaluationInterval": "PT5M" + } + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_NoPublicIPAddresses.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_NoPublicIPAddresses.json new file mode 100644 index 000000000000..db0df277c332 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_NoPublicIPAddresses.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2020-09-01", + "parameters": { + "properties": { + "vmSize": "STANDARD_D4", + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "publicIPAddressConfiguration": { + "provision": "NoPublicIPAddresses" + } + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "publicIPAddressConfiguration": { + "provision": "NoPublicIPAddresses" + } + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0 + } + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_PublicIPs.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_PublicIPs.json new file mode 100644 index 000000000000..9ee19fa36fae --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_PublicIPs.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2020-09-01", + "parameters": { + "properties": { + "vmSize": "STANDARD_D4", + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "publicIPAddressConfiguration": { + "provision": "UserManaged", + "ipAddressIds": [ + "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135" + ] + } + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "publicIPAddressConfiguration": { + "provision": "UserManaged", + "ipAddressIds": [ + "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135" + ] + } + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0 + } + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_SharedImageGallery.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_SharedImageGallery.json new file mode 100644 index 000000000000..0ef1defe82af --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_SharedImageGallery.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2020-09-01", + "parameters": { + "properties": { + "vmSize": "STANDARD_D4", + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0 + } + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_VirtualMachineConfiguration.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_VirtualMachineConfiguration.json new file mode 100644 index 000000000000..21ac6ac44143 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolCreate_VirtualMachineConfiguration.json @@ -0,0 +1,189 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2020-09-01", + "parameters": { + "properties": { + "vmSize": "STANDARD_D4", + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "windowsConfiguration": { + "enableAutomaticUpdates": false + }, + "licenseType": "Windows_Server", + "dataDisks": [ + { + "lun": 0, + "caching": "ReadWrite", + "diskSizeGB": 30, + "storageAccountType": "Premium_LRS" + }, + { + "lun": 1, + "caching": "None", + "diskSizeGB": 200, + "storageAccountType": "Standard_LRS" + } + ], + "diskEncryptionConfiguration": { + "targets": [ + "OsDisk", + "TemporaryDisk" + ] + } + } + }, + "networkConfiguration": { + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "protocol": "TCP", + "backendPort": 12001, + "frontendPortRangeStart": 15000, + "frontendPortRangeEnd": 15100, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "sourceAddressPrefix": "192.100.12.45", + "priority": 150, + "sourcePortRanges": [ + "1", + "2" + ] + }, + { + "access": "Deny", + "sourceAddressPrefix": "*", + "priority": 3500, + "sourcePortRanges": [ + "*" + ] + } + ] + } + ] + } + }, + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicatedNodes=1", + "evaluationInterval": "PT5M" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "windowsConfiguration": { + "enableAutomaticUpdates": false + }, + "licenseType": "Windows_Server", + "dataDisks": [ + { + "lun": 0, + "caching": "ReadWrite", + "diskSizeGB": 30, + "storageAccountType": "Premium_LRS" + }, + { + "lun": 1, + "caching": "None", + "diskSizeGB": 200, + "storageAccountType": "Standard_LRS" + } + ], + "diskEncryptionConfiguration": { + "targets": [ + "OsDisk", + "TemporaryDisk" + ] + } + } + }, + "networkConfiguration": { + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "protocol": "TCP", + "backendPort": 12001, + "frontendPortRangeStart": 15000, + "frontendPortRangeEnd": 15100, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "sourceAddressPrefix": "192.100.12.45", + "priority": 150, + "sourcePortRanges": [ + "1", + "2" + ] + }, + { + "access": "Deny", + "sourceAddressPrefix": "*", + "priority": 3500, + "sourcePortRanges": [ + "*" + ] + } + ] + } + ] + } + }, + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicatedNodes=1", + "evaluationInterval": "PT5M" + } + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolDelete.json new file mode 100644 index 000000000000..dfb2985cdb22 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2020-09-01" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Retry-After": "15", + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/poolOperationResults/delete-testpool-8D4EDFF164A11C9?api-version=2020-09-01" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolDisableAutoScale.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolDisableAutoScale.json new file mode 100644 index 000000000000..54cab4d6b157 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolDisableAutoScale.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolGet.json new file mode 100644 index 000000000000..293739c4017e --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolGet.json @@ -0,0 +1,155 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Enabled", + "taskSlotsPerNode": 13, + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "4", + "osVersion": "WA-GUEST-OS-4.45_201708-01" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28, + "resizeTimeout": "PT8M" + } + }, + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "protocol": "TCP", + "backendPort": 12001, + "frontendPortRangeStart": 15000, + "frontendPortRangeEnd": 15100, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "sourceAddressPrefix": "192.100.12.45", + "priority": 150, + "sourcePortRanges": [ + "123", + "22" + ] + }, + { + "access": "Deny", + "sourceAddressPrefix": "*", + "priority": 3500, + "sourcePortRanges": [ + "*" + ] + } + ] + } + ] + } + }, + "metadata": [ + { + "name": "metadata-1", + "value": "value-1" + }, + { + "name": "metadata-2", + "value": "value-2" + } + ], + "startTask": { + "commandLine": "cmd /c SET", + "resourceFiles": [ + { + "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file", + "filePath": "c:\\temp\\gohere", + "fileMode": "777" + } + ], + "environmentSettings": [ + { + "name": "MYSET", + "value": "1234" + } + ], + "userIdentity": { + "autoUser": { + "scope": "Pool", + "elevationLevel": "Admin" + } + }, + "maxTaskRetryCount": 6, + "waitForSuccess": true + }, + "userAccounts": [ + { + "name": "username1", + "elevationLevel": "Admin", + "linuxUserConfiguration": { + "uid": 1234, + "gid": 4567 + } + } + ], + "applicationPackages": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234", + "version": "asdf" + } + ], + "certificates": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567", + "storeLocation": "LocalMachine", + "storeName": "MY", + "visibility": [ + "RemoteUser" + ] + } + ], + "applicationLicenses": [ + "app-license0", + "app-license1" + ], + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "resizeOperationStatus": { + "startTime": "2017-08-28T10:22:55.9407275Z", + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28, + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M" + } + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolList.json new file mode 100644 index 000000000000..a6f3b005dd85 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolList.json @@ -0,0 +1,161 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Enabled", + "taskSlotsPerNode": 13, + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "4", + "osVersion": "WA-GUEST-OS-4.45_201708-01" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28, + "resizeTimeout": "PT8M" + } + }, + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "protocol": "TCP", + "backendPort": 12001, + "frontendPortRangeStart": 15000, + "frontendPortRangeEnd": 15100, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "sourceAddressPrefix": "192.100.12.45", + "priority": 150, + "sourcePortRanges": [ + "*" + ] + }, + { + "access": "Deny", + "sourceAddressPrefix": "*", + "priority": 3500, + "sourcePortRanges": [ + "*" + ] + } + ] + } + ] + } + }, + "metadata": [ + { + "name": "metadata-1", + "value": "value-1" + }, + { + "name": "metadata-2", + "value": "value-2" + } + ], + "startTask": { + "commandLine": "cmd /c SET", + "resourceFiles": [ + { + "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file", + "filePath": "c:\\temp\\gohere", + "fileMode": "777" + } + ], + "environmentSettings": [ + { + "name": "MYSET", + "value": "1234" + } + ], + "userIdentity": { + "autoUser": { + "scope": "Pool", + "elevationLevel": "Admin" + } + }, + "maxTaskRetryCount": 6, + "waitForSuccess": true + }, + "userAccounts": [ + { + "name": "username1", + "elevationLevel": "Admin", + "linuxUserConfiguration": { + "uid": 1234, + "gid": 4567 + } + } + ], + "applicationPackages": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234", + "version": "asdf" + } + ], + "certificates": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567", + "storeLocation": "LocalMachine", + "storeName": "MY", + "visibility": [ + "RemoteUser" + ] + } + ], + "applicationLicenses": [ + "app-license0", + "app-license1" + ], + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "resizeOperationStatus": { + "startTime": "2017-08-28T10:22:55.9407275Z", + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28, + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M", + "errors": [ + { + "code": "AllocationTimedout", + "message": "Desired number of dedicated nodes could not be allocated as the resize timeout was reached" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolListWithFilter.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolListWithFilter.json new file mode 100644 index 000000000000..778c32c45df0 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolListWithFilter.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2020-09-01", + "$filter": "startswith(name, 'po') or (properties/allocationState eq 'Steady' and properties/provisioningStateTransitionTime lt datetime'2017-02-02')", + "$select": "properties/allocationState,properties/provisioningStateTransitionTime,properties/currentDedicatedNodes,properties/currentLowPriorityNodes", + "maxResults": "50" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Steady", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 2 + } + }, + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/pooltest", + "name": "pooltest", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "provisioningStateTransitionTime": "2017-08-26T10:22:55.9407275Z", + "allocationState": "Resizing", + "currentDedicatedNodes": 4, + "currentLowPriorityNodes": 0 + } + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolStopResize.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolStopResize.json new file mode 100644 index 000000000000..436f16ba43ac --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolStopResize.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "startTime": "2017-08-28T10:22:55.9407275Z", + "targetDedicatedNodes": 1, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT10M" + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolUpdate_EnableAutoScale.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolUpdate_EnableAutoScale.json new file mode 100644 index 000000000000..9bf3dbb6bf59 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolUpdate_EnableAutoScale.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2020-09-01", + "parameters": { + "properties": { + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicatedNodes=34" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-29T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "5", + "osVersion": "*" + } + }, + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicated=34", + "evaluationInterval": "PT15M" + } + }, + "autoScaleRun": { + "evaluationTime": "2017-08-29T10:22:55.9407275Z", + "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue" + }, + "currentDedicatedNodes": 12, + "currentLowPriorityNodes": 0, + "resizeOperationStatus": { + "startTime": "2017-08-29T10:22:55.9407275Z", + "targetDedicatedNodes": 34, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M" + } + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolUpdate_OtherProperties.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolUpdate_OtherProperties.json new file mode 100644 index 000000000000..ef414fb391d0 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolUpdate_OtherProperties.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2020-09-01", + "parameters": { + "properties": { + "metadata": [ + { + "name": "key1", + "value": "value1" + } + ], + "applicationPackages": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234" + }, + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_5678", + "version": "1.0" + } + ], + "certificates": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567", + "storeLocation": "LocalMachine", + "storeName": "MY" + } + ] + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-29T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "5", + "osVersion": "*" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT8M", + "nodeDeallocationOption": "TaskCompletion" + } + }, + "autoScaleRun": { + "evaluationTime": "2017-08-29T10:22:55.9407275Z", + "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue" + }, + "currentDedicatedNodes": 12, + "currentLowPriorityNodes": 0, + "resizeOperationStatus": { + "startTime": "2017-08-29T10:22:55.9407275Z", + "targetDedicatedNodes": 8, + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M" + }, + "metadata": [ + { + "name": "key1", + "value": "value1" + } + ], + "applicationPackages": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234" + }, + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_5678", + "version": "1.0" + } + ], + "certificates": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567", + "storeLocation": "LocalMachine", + "storeName": "MY", + "visibility": [ + "StartTask", + "Task", + "RemoteUser" + ] + } + ] + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolUpdate_RemoveStartTask.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolUpdate_RemoveStartTask.json new file mode 100644 index 000000000000..5db6199f7eef --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolUpdate_RemoveStartTask.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2020-09-01", + "parameters": { + "properties": { + "startTask": {} + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-29T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "5", + "osVersion": "*" + } + }, + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicated=34", + "evaluationInterval": "PT15M" + } + }, + "autoScaleRun": { + "evaluationTime": "2017-08-29T10:22:55.9407275Z", + "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue" + }, + "currentDedicatedNodes": 12, + "currentLowPriorityNodes": 0, + "resizeOperationStatus": { + "startTime": "2017-08-29T10:22:55.9407275Z", + "targetDedicatedNodes": 34, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M" + } + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolUpdate_ResizePool.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolUpdate_ResizePool.json new file mode 100644 index 000000000000..7e1684e024b3 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PoolUpdate_ResizePool.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2020-09-01", + "parameters": { + "properties": { + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT8M", + "nodeDeallocationOption": "TaskCompletion" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-29T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "5", + "osVersion": "*" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT8M", + "nodeDeallocationOption": "TaskCompletion" + } + }, + "autoScaleRun": { + "evaluationTime": "2017-08-29T10:22:55.9407275Z", + "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue" + }, + "currentDedicatedNodes": 12, + "currentLowPriorityNodes": 0, + "resizeOperationStatus": { + "startTime": "2017-08-29T10:22:55.9407275Z", + "targetDedicatedNodes": 8, + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M" + } + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateBatchAccountCreate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateBatchAccountCreate.json new file mode 100644 index 000000000000..716388d7893c --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateBatchAccountCreate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid", + "parameters": { + "location": "japaneast", + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "keyVaultReference": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample", + "url": "http://sample.vault.azure.net/" + }, + "publicNetworkAccess": "Disabled" + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "UserSubscription", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + }, + "keyVaultReference": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample", + "url": "http://sample.vault.azure.net/" + }, + "publicNetworkAccess": "Disabled" + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateBatchAccountGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateBatchAccountGet.json new file mode 100644 index 000000000000..1071b24004f3 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateBatchAccountGet.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2020-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "BatchService", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + }, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "name": "testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by xyz.abc@company.com" + } + } + } + ] + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateEndpointConnectionGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateEndpointConnectionGet.json new file mode 100644 index 000000000000..f17e8b69bf4e --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateEndpointConnectionGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "privateEndpointConnectionName": "testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "name": "testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by xyz.abc@company.com" + } + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateEndpointConnectionUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateEndpointConnectionUpdate.json new file mode 100644 index 000000000000..9809c2408861 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateEndpointConnectionUpdate.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "privateEndpointConnectionName": "testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "api-version": "2020-09-01", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by xyz.abc@company.com" + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "name": "testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by xyz.abc@company.com" + } + } + } + }, + "204": {}, + "202": { + "headers": { + "Retry-After": "15", + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnectionProxyResults/Updating$testprivateEndpointConnection5.24d6b4b5$e65c-4330-bbe9-3a290d62f8e0-8D4EDFF164A11C9?api-version=2020-09-01" + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateEndpointConnectionsList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateEndpointConnectionsList.json new file mode 100644 index 000000000000..708f8a563405 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateEndpointConnectionsList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "privateEndpointConnectionName": "testprivateEndpointConnection", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection", + "name": "testprivateEndpointConnection", + "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by xyz.abc@company.com" + } + } + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateLinkResourceGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateLinkResourceGet.json new file mode 100644 index 000000000000..f6176752cb4f --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateLinkResourceGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "privateLinkResourceName": "sampleacct", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateLinkResources/sampleacct", + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts/privateLinkResources", + "properties": { + "groupId": "batchAccount", + "requiredMembers": [ + "batchAccount" + ], + "requiredZoneNames": [ + "privatelink.japaneast.batch.azure.com" + ] + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateLinkResourcesList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateLinkResourcesList.json new file mode 100644 index 000000000000..79b710d45fb5 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-09-01/examples/PrivateLinkResourcesList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "privateLinkResourceName": "testprivateLinkResource", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateLinkResources/testprivateLinkResource", + "name": "testprivateLinkResource", + "type": "Microsoft.Batch/batchAccounts/privateLinkResources", + "properties": { + "groupId": "batchAccount", + "requiredMembers": [ + "batchAccount" + ], + "requiredZoneNames": [ + "privatelink.japaneast.batch.azure.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/batch/resource-manager/readme.azureresourceschema.md b/specification/batch/resource-manager/readme.azureresourceschema.md index 1bfc3c15500f..54f7626e5744 100644 --- a/specification/batch/resource-manager/readme.azureresourceschema.md +++ b/specification/batch/resource-manager/readme.azureresourceschema.md @@ -6,6 +6,7 @@ These settings apply only when `--azureresourceschema` is specified on the comma ``` yaml $(azureresourceschema) && $(multiapi) batch: + - tag: schema-batch-2020-09-01 - tag: schema-batch-2020-05-01 - tag: schema-batch-2020-03-01 - tag: schema-batch-2019-08-01 @@ -20,6 +21,17 @@ batch: Please also specify `--azureresourceschema-folder=`. +### Tag: schema-batch-2020-09-01 and azureresourceschema + +``` yaml $(tag) == 'schema-batch-2020-09-01' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.Batch/stable/2020-09-01/BatchManagement.json + +``` + ### Tag: schema-batch-2020-05-01 and azureresourceschema ``` yaml $(tag) == 'schema-batch-2020-05-01' && $(azureresourceschema) diff --git a/specification/batch/resource-manager/readme.go.md b/specification/batch/resource-manager/readme.go.md index 35692665cfa7..058ae96ce535 100644 --- a/specification/batch/resource-manager/readme.go.md +++ b/specification/batch/resource-manager/readme.go.md @@ -14,6 +14,8 @@ go: ### Go multi-api ``` yaml $(go) && $(multiapi) batch: + - tag: package-2020-09 + - tag: package-2020-05 - tag: package-2020-03 - tag: package-2019-08 - tag: package-2019-04 @@ -24,6 +26,24 @@ batch: - tag: package-2015-12 ``` +### Tag: package-2020-09 and go + +These settings apply only when `--tag=package-2020-09 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-09' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-09-01/$(namespace) +``` + +### Tag: package-2020-05 and go + +These settings apply only when `--tag=package-2020-05 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-05' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-05-01/$(namespace) +``` + ### Tag: package-2020-03 and go These settings apply only when `--tag=package-2020-03 --go` is specified on the command line. @@ -33,7 +53,6 @@ Please also specify `--go-sdk-folder= Date: Tue, 15 Sep 2020 14:32:09 -0700 Subject: [PATCH 063/164] Update keys.json (#10495) * Update keys.json * Update keyvault.json --- .../data-plane/Microsoft.KeyVault/stable/7.0/keyvault.json | 2 +- .../keyvault/data-plane/Microsoft.KeyVault/stable/7.1/keys.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/keyvault.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/keyvault.json index af96f3dada61..489c6be6402f 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/keyvault.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/keyvault.json @@ -3754,7 +3754,7 @@ }, { "value": "oct", - "description": "Octet sequence (used to represent symmetric keys)" + "description": "Not supported in this version. Octet sequence (used to represent symmetric keys)" } ] } diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.1/keys.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.1/keys.json index 6d4a85db9488..f0a3aa63cc26 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.1/keys.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.1/keys.json @@ -1013,7 +1013,7 @@ }, { "value": "oct", - "description": "Octet sequence (used to represent symmetric keys)" + "description": "Not supported in this version. Octet sequence (used to represent symmetric keys)" } ] } From 39466d240538fb7d679e23b180b79d6e9ed80627 Mon Sep 17 00:00:00 2001 From: giakas Date: Tue, 15 Sep 2020 14:51:18 -0700 Subject: [PATCH 064/164] Remove LiveVideoAnalytics Swagger and samples from Azure repo, as this should not be public, will recheckin this to a branch on azure-rest-api-specs-pr repo, and maintain it in that branch. (#10796) --- .../preview/1.0/LiveVideoAnalytics.json | 1317 ----------------- .../1.0/examples/GraphInstanceDelete.json | 16 - .../1.0/examples/GraphInstanceGet.json | 36 - .../1.0/examples/GraphInstanceList.json | 35 - .../1.0/examples/GraphInstanceSet.json | 62 - .../examples/GraphInstanceStateChange.json | 12 - .../1.0/examples/GraphTopologyDelete.json | 16 - .../1.0/examples/GraphTopologyGet.json | 70 - .../1.0/examples/GraphTopologyList.json | 69 - .../1.0/examples/GraphTopologySet.json | 173 --- .../mediaservices/data-plane/readme.md | 97 -- 11 files changed, 1903 deletions(-) delete mode 100644 specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/LiveVideoAnalytics.json delete mode 100644 specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceDelete.json delete mode 100644 specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceGet.json delete mode 100644 specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceList.json delete mode 100644 specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceSet.json delete mode 100644 specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceStateChange.json delete mode 100644 specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologyDelete.json delete mode 100644 specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologyGet.json delete mode 100644 specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologyList.json delete mode 100644 specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologySet.json delete mode 100644 specification/mediaservices/data-plane/readme.md diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/LiveVideoAnalytics.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/LiveVideoAnalytics.json deleted file mode 100644 index 25871e18d840..000000000000 --- a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/LiveVideoAnalytics.json +++ /dev/null @@ -1,1317 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "description": "Direct Methods for Live Video Analytics on IoT Edge.", - "version": "1.0", - "title": "Direct Methods for Live Video Analytics on IoT Edge", - "contact": { - "email": "amshelp@microsoft.com" - } - }, - "security": [ - { - "sharedAccessSignature": [] - } - ], - "paths": { - "/api/GraphTopology": { - "get": { - "summary": "Retrieves a list of graph topologies.", - "description": "Retrieves a list of graph topologies that have been added to the Live Video Analytics IoT Edge module.", - "operationId": "GraphTopologyList", - "produces": [ - "application/json" - ], - "parameters": [], - "responses": { - "200": { - "description": "Graph Topologies were successfully retrieved from the Live Video Analytics IoT Edge module.", - "schema": { - "$ref": "#/definitions/MediaGraphTopologyCollection" - } - } - }, - "x-ms-examples": { - "List all Graph Topologies": { - "$ref": "examples/GraphTopologyList.json" - } - } - }, - "put": { - "summary": "Creates or updates a graph topology.", - "description": "Creates a new topology or updates an existing one, with the given name. A topology is a blueprint defining what nodes are in a graph, and how they are interconnected.", - "operationId": "GraphTopologySet", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "topology", - "required": true, - "schema": { - "$ref": "#/definitions/MediaGraphTopology" - } - } - ], - "responses": { - "200": { - "description": "Existing graph topology updated.", - "schema": { - "$ref": "#/definitions/MediaGraphTopology" - } - }, - "201": { - "description": "New graph topology created.", - "schema": { - "$ref": "#/definitions/MediaGraphTopology" - } - } - }, - "x-ms-examples": { - "Create or Update a Graph Topology": { - "$ref": "examples/GraphTopologySet.json" - } - } - } - }, - "/api/GraphTopology/{name}": { - "get": { - "summary": "Gets a graph topology by name.", - "description": "Retrieves a graph topology by name. If a topology with that name has been previously set, then the call will return the JSON representation of that topology.", - "operationId": "GraphTopologyGet", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of the graph topology to be retrieved.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Graph topology retrieved successfully.", - "schema": { - "$ref": "#/definitions/MediaGraphTopology" - } - }, - "404": { - "description": "Graph topology was not found." - } - }, - "x-ms-examples": { - "Get a Graph Topology": { - "$ref": "examples/GraphTopologyGet.json" - } - } - }, - "delete": { - "summary": "Deletes a graph topology.", - "description": "Deletes a graph topology with the given name. This method should be called after all instances of the topology have been stopped and deleted.", - "operationId": "GraphTopologyDelete", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of the graph topology to be deleted.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Graph topology deleted successfully." - }, - "204": { - "description": "Graph topology not found." - } - }, - "x-ms-examples": { - "Delete a Graph Topology": { - "$ref": "examples/GraphTopologyDelete.json" - } - } - } - }, - "/api/GraphInstance": { - "get": { - "summary": "Retrieves a list of graph instances.", - "description": "Retrieves a list of graph instances, if any, that have been created in the Live Video Analytics IoT Edge module.", - "operationId": "GraphInstanceList", - "produces": [ - "application/json" - ], - "parameters": [], - "responses": { - "200": { - "description": "List of graph instances that were successfully retrieved.", - "schema": { - "$ref": "#/definitions/MediaGraphInstanceCollection" - } - } - }, - "x-ms-examples": { - "List all Graph Instances": { - "$ref": "examples/GraphInstanceList.json" - } - } - }, - "put": { - "summary": "Creates or updates a graph instance.", - "description": "Creates or updates a graph instance.", - "operationId": "GraphInstanceSet", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "instance", - "required": true, - "schema": { - "$ref": "#/definitions/MediaGraphInstance" - } - } - ], - "responses": { - "200": { - "description": "Graph instance updated.", - "schema": { - "$ref": "#/definitions/MediaGraphInstance" - } - }, - "201": { - "description": "New graph instance created.", - "schema": { - "$ref": "#/definitions/MediaGraphInstance" - } - } - }, - "x-ms-examples": { - "Create or Update a Graph Instance": { - "$ref": "examples/GraphInstanceSet.json" - } - } - } - }, - "/api/GraphInstance/{name}": { - "get": { - "summary": "Gets a graph instance by name.", - "description": "Retrieves a graph instance by name. If a graph instance with that name has been previously created, then the direct method call will return the JSON representation of that instance.", - "operationId": "GraphInstanceGet", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of the graph instance to be retrieved.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Graph instance retrieved successfully.", - "schema": { - "$ref": "#/definitions/MediaGraphInstance" - } - }, - "404": { - "description": "Graph instance not found." - } - }, - "x-ms-examples": { - "Get a Graph Instance": { - "$ref": "examples/GraphInstanceGet.json" - } - } - }, - "delete": { - "summary": "Deletes a graph instance.", - "description": "Deletes a graph instance.", - "operationId": "GraphInstanceDelete", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of the graph instance to be deleted.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Graph instance deleted successfully." - }, - "204": { - "description": "Graph instance not found." - } - }, - "x-ms-examples": { - "Delete a Graph Instance": { - "$ref": "examples/GraphInstanceDelete.json" - } - } - } - }, - "/api/GraphInstance/{name}/activate": { - "post": { - "summary": "Activate a given graph instance.", - "description": "Activates a graph instance with the name provided, if it exists.", - "operationId": "GraphInstanceActivate", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of the graph instance to be activated.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Graph instance activated successfully." - } - }, - "x-ms-examples": { - "Activate a Graph Instance": { - "$ref": "examples/GraphInstanceStateChange.json" - } - } - } - }, - "/api/GraphInstance/{name}/deactivate": { - "post": { - "summary": "Deactivate a graph instance.", - "description": "Deactivates a graph instance with the name provided, if it is active.", - "operationId": "GraphInstanceDeactivate", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of the graph instance to be deactivated.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Graph instance deactivated successfully." - } - }, - "x-ms-examples": { - "Deactivate a Graph Instance": { - "$ref": "examples/GraphInstanceStateChange.json" - } - } - } - } - }, - "securityDefinitions": { - "sharedAccessSignature": { - "type": "apiKey", - "name": "Authorization", - "in": "header" - } - }, - "definitions": { - "MediaGraphInstance": { - "type": "object", - "required": [ - "name" - ], - "properties": { - "name": { - "type": "string" - }, - "@apiVersion": { - "type": "string" - }, - "systemData": { - "$ref": "#/definitions/MediaGraphSystemData" - }, - "properties": { - "$ref": "#/definitions/MediaGraphInstanceProperties" - } - }, - "description": "Represents a Media Graph instance." - }, - "MediaGraphInstanceProperties": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "An optional description for the instance." - }, - "topologyName": { - "type": "string", - "description": "The name of the graph topology that this instance will run. A topology with this name should already have been set in the Edge module." - }, - "parameters": { - "type": "array", - "description": "List of one or more graph instance parameters.", - "items": { - "$ref": "#/definitions/MediaGraphParameterDefinition" - } - }, - "state": { - "type": "string", - "description": "Allowed states for a graph Instance.", - "enum": [ - "Inactive", - "Activating", - "Active", - "Deactivating" - ], - "x-ms-enum": { - "name": "MediaGraphInstanceState", - "values": [ - { - "value": "Inactive", - "description": "Inactive state." - }, - { - "value": "Activating", - "description": "Activating state." - }, - { - "value": "Active", - "description": "Active state." - }, - { - "value": "Deactivating", - "description": "Deactivating state." - } - ], - "modelAsString": false - } - } - }, - "description": "Properties of a Media Graph instance." - }, - "MediaGraphParameterDefinition": { - "type": "object", - "required": [ - "name", - "value" - ], - "properties": { - "name": { - "type": "string", - "description": "Name of parameter as defined in the graph topology." - }, - "value": { - "type": "string", - "description": "Value of parameter." - } - }, - "description": "A key, value pair. The graph topology can be authored with certain values with parameters. Then, during graph instance creation, the value for that parameters can be specified. This allows the same graph topology to be used as a blueprint for multiple graph instances with different values for the parameters." - }, - "MediaGraphInstanceCollection": { - "properties": { - "value": { - "type": "array", - "description": "Collection of graph instances.", - "items": { - "$ref": "#/definitions/MediaGraphInstance" - } - }, - "@continuationToken": { - "type": "string", - "description": "Continuation token to use in subsequent calls to enumerate through the graph instance collection (when the collection contains too many results to return in one response)." - } - }, - "description": "Collection of graph instances." - }, - "MediaGraphTopologyCollection": { - "properties": { - "value": { - "type": "array", - "description": "Collection of graph topologies.", - "items": { - "$ref": "#/definitions/MediaGraphTopology" - } - }, - "@continuationToken": { - "type": "string", - "description": "Continuation token to use in subsequent calls to enumerate through the graph topologies collection (when the collection contains too many results to return in one response)." - } - }, - "description": "Collection of graph topologies." - }, - "MediaGraphTopology": { - "type": "object", - "required": [ - "name" - ], - "properties": { - "name": { - "type": "string" - }, - "@apiVersion": { - "type": "string" - }, - "systemData": { - "$ref": "#/definitions/MediaGraphSystemData" - }, - "properties": { - "$ref": "#/definitions/MediaGraphTopologyProperties" - } - }, - "description": "Describes a graph topology." - }, - "MediaGraphTopologyProperties": { - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "parameters": { - "type": "array", - "items": { - "$ref": "#/definitions/MediaGraphParameterDeclaration" - } - }, - "sources": { - "type": "array", - "items": { - "$ref": "#/definitions/MediaGraphSource" - } - }, - "processors": { - "type": "array", - "items": { - "$ref": "#/definitions/MediaGraphProcessor" - } - }, - "sinks": { - "type": "array", - "items": { - "$ref": "#/definitions/MediaGraphSink" - } - } - }, - "description": "Describes the properties of a graph topology." - }, - "MediaGraphSystemData": { - "type": "object", - "properties": { - "createdAt": { - "type": "string", - "format": "date-time", - "description": "The timestamp of resource creation (UTC)." - }, - "lastModifiedAt": { - "type": "string", - "format": "date-time", - "description": "The timestamp of resource last modification (UTC)." - } - }, - "description": "Graph system data." - }, - "MediaGraphParameterDeclaration": { - "type": "object", - "required": [ - "name", - "type" - ], - "properties": { - "name": { - "type": "string", - "description": "The name of the parameter.", - "maxLength": 64 - }, - "type": { - "type": "string", - "enum": [ - "String", - "SecretString", - "Int", - "Double", - "Bool" - ], - "x-ms-enum": { - "name": "MediaGraphParameterType", - "values": [ - { - "value": "String", - "description": "A string parameter value." - }, - { - "value": "SecretString", - "description": "A string to hold sensitive information as parameter value." - }, - { - "value": "Int", - "description": "A 32-bit signed integer as parameter value." - }, - { - "value": "Double", - "description": "A 64-bit double-precision floating point type as parameter value." - }, - { - "value": "Bool", - "description": "A boolean value that is either true or false." - } - ], - "modelAsString": false - } - }, - "description": { - "type": "string", - "description": "Description of the parameter." - }, - "default": { - "type": "string", - "description": "The default value for the parameter, to be used if the graph instance does not specify a value." - } - }, - "description": "The declaration of a parameter in the graph topology. A graph topology can be authored with parameters. Then, during graph instance creation, the value for those parameters can be specified. This allows the same graph topology to be used as a blueprint for multiple graph instances with different values for the parameters." - }, - "MediaGraphSource": { - "type": "object", - "required": [ - "@type", - "name" - ], - "discriminator": "@type", - "properties": { - "@type": { - "type": "string", - "description": "The type of the source node. The discriminator for derived types." - }, - "name": { - "type": "string", - "description": "The name to be used for this source node." - } - }, - "description": "Media graph source." - }, - "MediaGraphRtspSource": { - "properties": { - "transport": { - "type": "string", - "description": "Underlying RTSP transport. This is used to enable or disable HTTP tunneling.", - "enum": [ - "Http", - "Tcp" - ], - "x-ms-enum": { - "name": "MediaGraphRtspTransport", - "values": [ - { - "value": "Http", - "description": "HTTP/HTTPS transport. This should be used when HTTP tunneling is desired." - }, - { - "value": "Tcp", - "description": "TCP transport. This should be used when HTTP tunneling is NOT desired." - } - ], - "modelAsString": true - } - }, - "endpoint": { - "description": "RTSP endpoint of the stream that is being connected to.", - "$ref": "#/definitions/MediaGraphEndpoint" - } - }, - "required": [ - "endpoint" - ], - "allOf": [ - { - "$ref": "#/definitions/MediaGraphSource" - }, - {} - ], - "description": "Enables a graph to capture media from a RTSP server.", - "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphRtspSource" - }, - "MediaGraphIoTHubMessageSource": { - "properties": { - "hubInputName": { - "type": "string", - "description": "Name of the input path where messages can be routed to (via routes declared in the IoT Edge deployment manifest)." - } - }, - "allOf": [ - { - "$ref": "#/definitions/MediaGraphSource" - }, - {} - ], - "description": "Enables a graph to receive messages via routes declared in the IoT Edge deployment manifest.", - "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphIoTHubMessageSource" - }, - "MediaGraphIoTHubMessageSink": { - "properties": { - "hubOutputName": { - "type": "string", - "description": "Name of the output path to which the graph will publish message. These messages can then be delivered to desired destinations by declaring routes referencing the output path in the IoT Edge deployment manifest." - } - }, - "allOf": [ - { - "$ref": "#/definitions/MediaGraphSink" - }, - {} - ], - "description": "Enables a graph to publish messages that can be delivered via routes declared in the IoT Edge deployment manifest.", - "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphIoTHubMessageSink" - }, - "MediaGraphEndpoint": { - "type": "object", - "required": [ - "@type", - "url" - ], - "discriminator": "@type", - "properties": { - "@type": { - "type": "string", - "description": "The discriminator for derived types." - }, - "credentials": { - "description": "Polymorphic credentials to be presented to the endpoint.", - "$ref": "#/definitions/MediaGraphCredentials" - }, - "url": { - "type": "string", - "description": "Url for the endpoint." - } - }, - "description": "Base class for endpoints." - }, - "MediaGraphCredentials": { - "type": "object", - "required": [ - "@type" - ], - "discriminator": "@type", - "properties": { - "@type": { - "type": "string", - "description": "The discriminator for derived types." - } - }, - "description": "Credentials to present during authentication." - }, - "MediaGraphUsernamePasswordCredentials": { - "properties": { - "username": { - "type": "string", - "description": "Username for a username/password pair." - }, - "password": { - "type": "string", - "description": "Password for a username/password pair." - } - }, - "required": [ - "username" - ], - "allOf": [ - { - "$ref": "#/definitions/MediaGraphCredentials" - }, - {} - ], - "description": "Username/password credential pair.", - "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphUsernamePasswordCredentials" - }, - "MediaGraphHttpHeaderCredentials": { - "properties": { - "headerName": { - "type": "string", - "description": "HTTP header name." - }, - "headerValue": { - "type": "string", - "description": "HTTP header value." - } - }, - "required": [ - "headerName", - "headerValue" - ], - "allOf": [ - { - "$ref": "#/definitions/MediaGraphCredentials" - }, - {} - ], - "description": "Http header service credentials.", - "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphHttpHeaderCredentials" - }, - "MediaGraphUnsecuredEndpoint": { - "allOf": [ - { - "$ref": "#/definitions/MediaGraphEndpoint" - }, - {} - ], - "description": "An endpoint that the media graph can connect to, with no encryption in transit.", - "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphUnsecuredEndpoint" - }, - "MediaGraphTlsEndpoint": { - "properties": { - "trustedCertificates": { - "description": "Trusted certificates when authenticating a TLS connection. Null designates that Azure Media Service's source of trust should be used.", - "$ref": "#/definitions/MediaGraphCertificateSource" - }, - "validationOptions": { - "description": "Validation options to use when authenticating a TLS connection. By default, strict validation is used.", - "$ref": "#/definitions/MediaGraphTlsValidationOptions" - } - }, - "allOf": [ - { - "$ref": "#/definitions/MediaGraphEndpoint" - }, - {} - ], - "description": "An endpoint that the graph can connect to, which must be connected over TLS/SSL.", - "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphTlsEndpoint" - }, - "MediaGraphCertificateSource": { - "type": "object", - "required": [ - "@type" - ], - "discriminator": "@type", - "properties": { - "@type": { - "type": "string", - "description": "The discriminator for derived types." - } - }, - "description": "Base class for certificate sources." - }, - "MediaGraphTlsValidationOptions": { - "type": "object", - "properties": { - "ignoreHostname": { - "type": "string", - "description": "Boolean value ignoring the host name (common name) during validation." - }, - "ignoreSignature": { - "type": "string", - "description": "Boolean value ignoring the integrity of the certificate chain at the current time." - } - }, - "description": "Options for controlling the authentication of TLS endpoints." - }, - "MediaGraphPemCertificateList": { - "properties": { - "certificates": { - "type": "array", - "description": "PEM formatted public certificates one per entry.", - "items": { - "type": "string" - } - } - }, - "required": [ - "certificates" - ], - "allOf": [ - { - "$ref": "#/definitions/MediaGraphCertificateSource" - }, - {} - ], - "description": "A list of PEM formatted certificates.", - "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphPemCertificateList" - }, - "MediaGraphSink": { - "type": "object", - "required": [ - "@type", - "inputs", - "name" - ], - "discriminator": "@type", - "properties": { - "@type": { - "type": "string", - "description": "The discriminator for derived types." - }, - "name": { - "type": "string", - "description": "Name to be used for the media graph sink." - }, - "inputs": { - "type": "array", - "description": "An array of the names of the other nodes in the media graph, the outputs of which are used as input for this sink node.", - "items": { - "$ref": "#/definitions/MediaGraphNodeInput" - } - } - }, - "description": "Enables a media graph to write media data to a destination outside of the Live Video Analytics IoT Edge module." - }, - "MediaGraphNodeInput": { - "type": "object", - "properties": { - "nodeName": { - "type": "string", - "description": "The name of another node in the media graph, the output of which is used as input to this node." - }, - "outputSelectors": { - "type": "array", - "description": "Allows for the selection of particular streams from another node.", - "items": { - "$ref": "#/definitions/MediaGraphOutputSelector" - } - } - }, - "description": "Represents the input to any node in a media graph." - }, - "MediaGraphOutputSelector": { - "properties": { - "property": { - "type": "string", - "description": "The stream property to compare with.", - "enum": [ - "mediaType" - ], - "x-ms-enum": { - "name": "MediaGraphOutputSelectorProperty", - "values": [ - { - "value": "mediaType", - "description": "The stream's MIME type or subtype." - } - ], - "modelAsString": false - } - }, - "operator": { - "type": "string", - "description": "The operator to compare streams by.", - "enum": [ - "is", - "isNot" - ], - "x-ms-enum": { - "name": "MediaGraphOutputSelectorOperator", - "values": [ - { - "value": "is", - "description": "A media type is the same type or a subtype." - }, - { - "value": "isNot", - "description": "A media type is not the same type or a subtype." - } - ], - "modelAsString": false - } - }, - "value": { - "type": "string", - "description": "Value to compare against." - } - }, - "description": "Allows for the selection of particular streams from another node." - }, - "MediaGraphFileSink": { - "properties": { - "filePathPattern": { - "type": "string", - "description": "Absolute file path pattern for creating new files on the Edge device.", - "minLength": 1 - } - }, - "required": [ - "filePathPattern" - ], - "allOf": [ - { - "$ref": "#/definitions/MediaGraphSink" - }, - {} - ], - "description": "Enables a media graph to write/store media (video and audio) to a file on the Edge device.", - "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphFileSink" - }, - "MediaGraphAssetSink": { - "properties": { - "assetNamePattern": { - "type": "string", - "description": "A name pattern when creating new assets." - }, - "segmentLength": { - "type": "string", - "format": "duration", - "example": "PT30S", - "description": "When writing media to an asset, wait until at least this duration of media has been accumulated on the Edge. Expressed in increments of 30 seconds, with a minimum of 30 seconds and a recommended maximum of 5 minutes." - }, - "localMediaCachePath": { - "type": "string", - "description": "Path to a local file system directory for temporary caching of media, before writing to an Asset. Used when the Edge device is temporarily disconnected from Azure." - }, - "localMediaCacheMaximumSizeMiB": { - "type": "string", - "description": "Maximum amount of disk space that can be used for temporary caching of media." - } - }, - "allOf": [ - { - "$ref": "#/definitions/MediaGraphSink" - }, - {} - ], - "description": "Enables a graph to record media to an Azure Media Services asset, for subsequent playback.", - "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphAssetSink" - }, - "MediaGraphProcessor": { - "type": "object", - "required": [ - "@type", - "inputs", - "name" - ], - "discriminator": "@type", - "properties": { - "@type": { - "type": "string", - "description": "The discriminator for derived types." - }, - "name": { - "type": "string", - "description": "The name for this processor node." - }, - "inputs": { - "type": "array", - "description": "An array of the names of the other nodes in the media graph, the outputs of which are used as input for this processor node.", - "items": { - "$ref": "#/definitions/MediaGraphNodeInput" - } - } - }, - "description": "A node that represents the desired processing of media in a graph. Takes media and/or events as inputs, and emits media and/or event as output." - }, - "MediaGraphMotionDetectionProcessor": { - "properties": { - "sensitivity": { - "type": "string", - "description": "Enumeration that specifies the sensitivity of the motion detection processor.", - "enum": [ - "Low", - "Medium", - "High" - ], - "x-ms-enum": { - "name": "MediaGraphMotionDetectionSensitivity", - "values": [ - { - "value": "Low", - "description": "Low Sensitivity." - }, - { - "value": "Medium", - "description": "Medium Sensitivity." - }, - { - "value": "High", - "description": "High Sensitivity." - } - ], - "modelAsString": true - } - }, - "outputMotionRegion": { - "type": "boolean", - "description": "Indicates whether the processor should detect and output the regions, within the video frame, where motion was detected. Default is true." - } - }, - "allOf": [ - { - "$ref": "#/definitions/MediaGraphProcessor" - }, - {} - ], - "description": "A node that accepts raw video as input, and detects if there are moving objects present. If so, then it emits an event, and allows frames where motion was detected to pass through. Other frames are blocked/dropped.", - "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphMotionDetectionProcessor" - }, - "MediaGraphExtensionProcessorBase": { - "properties": { - "endpoint": { - "description": "Endpoint to which this processor should connect.", - "$ref": "#/definitions/MediaGraphEndpoint" - }, - "image": { - "description": "Describes the parameters of the image that is sent as input to the endpoint.", - "$ref": "#/definitions/MediaGraphImage" - } - }, - "allOf": [ - { - "$ref": "#/definitions/MediaGraphProcessor" - }, - {} - ], - "description": "Processor that allows for extensions, outside of the Live Video Analytics Edge module, to be integrated into the graph. It is the base class for various different kinds of extension processor types.", - "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphExtensionProcessorBase" - }, - "MediaGraphHttpExtension": { - "allOf": [ - { - "$ref": "#/definitions/MediaGraphExtensionProcessorBase" - }, - {} - ], - "description": "A processor that allows the media graph to send video frames (mostly at low frame rates e.g. <5 fps) to external inference container by leveraging HTTP based RESTful API. It then retrieves the inference results and relays them downstream to the next node.", - "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphHttpExtension" - }, - "MediaGraphImage": { - "type": "object", - "properties": { - "scale": { - "$ref": "#/definitions/MediaGraphImageScale" - }, - "format": { - "$ref": "#/definitions/MediaGraphImageFormat" - } - }, - "description": "Describes the properties of an image frame." - }, - "MediaGraphImageScale": { - "type": "object", - "properties": { - "mode": { - "type": "string", - "description": "Describes the modes for scaling an input video frame into an image, before it is sent to an inference engine.", - "enum": [ - "PreserveAspectRatio", - "Pad", - "Stretch" - ], - "x-ms-enum": { - "name": "MediaGraphImageScaleMode", - "values": [ - { - "value": "PreserveAspectRatio", - "description": "Use the same aspect ratio as the input frame." - }, - { - "value": "Pad", - "description": "Center pad the input frame to match the given dimensions." - }, - { - "value": "Stretch", - "description": "Stretch input frame to match given dimensions." - } - ], - "modelAsString": true - } - }, - "width": { - "type": "string", - "description": "The desired output width of the image." - }, - "height": { - "type": "string", - "description": "The desired output height of the image." - } - }, - "description": "The scaling mode for the image." - }, - "MediaGraphImageFormat": { - "required": [ - "@type" - ], - "type": "object", - "discriminator": "@type", - "properties": { - "@type": { - "type": "string", - "description": "The discriminator for derived types." - } - }, - "description": "Encoding settings for an image.", - "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphImageFormat" - }, - "MediaGraphImageFormatRaw": { - "properties": { - "pixelFormat": { - "type": "string", - "enum": [ - "Yuv420p", - "Rgb565be", - "Rgb565le", - "Rgb555be", - "Rgb555le", - "Rgb24", - "Bgr24", - "Argb", - "Rgba", - "Abgr", - "Bgra" - ], - "x-ms-enum": { - "name": "MediaGraphImageFormatRawPixelFormat", - "values": [ - { - "value": "Yuv420p", - "description": "Planar YUV 4:2:0, 12bpp, (1 Cr and Cb sample per 2x2 Y samples)." - }, - { - "value": "Rgb565be", - "description": "Packed RGB 5:6:5, 16bpp, (msb) 5R 6G 5B(lsb), big-endian." - }, - { - "value": "Rgb565le", - "description": "Packed RGB 5:6:5, 16bpp, (msb) 5R 6G 5B(lsb), little-endian." - }, - { - "value": "Rgb555be", - "description": "Packed RGB 5:5:5, 16bpp, (msb)1X 5R 5G 5B(lsb), big-endian , X=unused/undefined." - }, - { - "value": "Rgb555le", - "description": "Packed RGB 5:5:5, 16bpp, (msb)1X 5R 5G 5B(lsb), little-endian, X=unused/undefined." - }, - { - "value": "Rgb24", - "description": "Packed RGB 8:8:8, 24bpp, RGBRGB." - }, - { - "value": "Bgr24", - "description": "Packed RGB 8:8:8, 24bpp, BGRBGR." - }, - { - "value": "Argb", - "description": "Packed ARGB 8:8:8:8, 32bpp, ARGBARGB." - }, - { - "value": "Rgba", - "description": "Packed RGBA 8:8:8:8, 32bpp, RGBARGBA." - }, - { - "value": "Abgr", - "description": "Packed ABGR 8:8:8:8, 32bpp, ABGRABGR." - }, - { - "value": "Bgra", - "description": "Packed BGRA 8:8:8:8, 32bpp, BGRABGRA." - } - ], - "modelAsString": true - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/MediaGraphImageFormat" - }, - {} - ], - "description": "Encoding settings for raw images.", - "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphImageFormatRaw" - }, - "MediaGraphImageFormatEncoded": { - "properties": { - "encoding": { - "type": "string", - "description": "The different encoding formats that can be used for the image.", - "default": "Jpeg", - "enum": [ - "Jpeg", - "Bmp", - "Png" - ], - "x-ms-enum": { - "name": "MediaGraphImageEncodingFormat", - "values": [ - { - "value": "Jpeg", - "description": "JPEG image format." - }, - { - "value": "Bmp", - "description": "BMP image format." - }, - { - "value": "Png", - "description": "PNG image format." - } - ], - "modelAsString": true - } - }, - "quality": { - "type": "string", - "description": "The image quality (used for JPEG only). Value must be between 0 to 100 (best quality)." - } - }, - "allOf": [ - { - "$ref": "#/definitions/MediaGraphImageFormat" - }, - {} - ], - "description": "Allowed formats for the image.", - "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphImageFormatEncoded" - }, - "MediaGraphSignalGateProcessor": { - "properties": { - "activationEvaluationWindow": { - "type": "string", - "example": "PT1.0S", - "description": "The period of time over which the gate gathers input events, before evaluating them." - }, - "activationSignalOffset": { - "type": "string", - "example": "-PT1.0S", - "description": "Signal offset once the gate is activated (can be negative). It is an offset between the time the event is received, and the timestamp of the first media sample (eg. video frame) that is allowed through by the gate." - }, - "minimumActivationTime": { - "type": "string", - "example": "PT1S", - "description": "The minimum period for which the gate remains open, in the absence of subsequent triggers (events)." - }, - "maximumActivationTime": { - "type": "string", - "example": "PT2S", - "description": "The maximum period for which the gate remains open, in the presence of subsequent events." - } - }, - "allOf": [ - { - "$ref": "#/definitions/MediaGraphProcessor" - }, - {} - ], - "description": "A signal gate determines when to block (gate) incoming media, and when to allow it through. It gathers input events over the activationEvaluationWindow, and determines whether to open or close the gate.", - "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphSignalGateProcessor" - }, - "MediaGraphFrameRateFilterProcessor": { - "properties": { - "maximumFps": { - "type": "string", - "description": "Ensures that the frame rate of the video leaving this processor does not exceed this limit." - } - }, - "allOf": [ - { - "$ref": "#/definitions/MediaGraphProcessor" - }, - {} - ], - "description": "Limits the frame rate on the input video stream based on the maximumFps property.", - "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphFrameRateFilterProcessor" - } - } -} diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceDelete.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceDelete.json deleted file mode 100644 index 76af8f4992db..000000000000 --- a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceDelete.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "name": "IngestAndRecordGraphInstance", - "@apiVersion": "1.0" - }, - "responses": { - "200": { - "payload": null, - "status": 200 - }, - "204": { - "payload": null, - "status": 204 - } - } -} diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceGet.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceGet.json deleted file mode 100644 index a83368fb92d1..000000000000 --- a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceGet.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "name": "IngestAndRecordGraphInstance", - "@apiVersion": "1.0" - }, - "responses": { - "200": { - "body": { - "name": "IngestAndRecordGraphInstance", - "properties": { - "description": "An updated description of the instance of the IngestAndRecordGraphTopology", - "parameters": [ - { - "name": "rtspUsername", - "value": "testusername" - }, - { - "name": "rtspPassword", - "value": "testpassword" - } - ], - "state": "Inactive", - "topologyName": "IngestAndRecordGraphTopology" - }, - "systemData": { - "createdAt": "2020-06-10T19:17:58.812Z", - "lastModifiedAt": "2020-06-10T19:19:07.960Z" - } - } - }, - "404": { - "payload": null, - "status": 404 - } - } -} diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceList.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceList.json deleted file mode 100644 index 24829a459c28..000000000000 --- a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceList.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "@apiVersion": "1.0" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "IngestAndRecordGraphInstance", - "properties": { - "description": "An updated description of the instance of the IngestAndRecordGraphTopology", - "parameters": [ - { - "name": "rtspUsername", - "value": "testusername" - }, - { - "name": "rtspPassword", - "value": "testpassword" - } - ], - "state": "Inactive", - "topologyName": "IngestAndRecordGraphTopology" - }, - "systemData": { - "createdAt": "2020-06-10T19:17:58.812Z", - "lastModifiedAt": "2020-06-10T19:19:07.960Z" - } - } - ] - } - } - } -} diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceSet.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceSet.json deleted file mode 100644 index 7798068fd654..000000000000 --- a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceSet.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "parameters": { - "instance": { - "@apiVersion": "1.0", - "name": "IngestAndRecordGraphInstance", - "properties": { - "topologyName": "IngestAndRecorGraphTopology", - "description": "An instance of the IngestAndRecordGraphTopology" - } - } - }, - "responses": { - "200": { - "body": { - "name": "IngestAndRecordGraphInstance", - "properties": { - "description": "An updated description of the instance of the IngestAndRecordGraphTopology", - "parameters": [ - { - "name": "rtspUsername", - "value": "testusername" - }, - { - "name": "rtspPassword", - "value": "testpassword" - } - ], - "state": "Inactive", - "topologyName": "IngestAndRecorGraphTopology" - }, - "systemData": { - "createdAt": "2020-06-10T19:17:58.812Z", - "lastModifiedAt": "2020-06-10T19:19:07.960Z" - } - } - }, - "201": { - "body": { - "name": "IngestAndRecordGraphInstance", - "properties": { - "description": "An instance of the IngestAndRecordGraphTopology", - "parameters": [ - { - "name": "rtspUsername", - "value": "testusername" - }, - { - "name": "rtspPassword", - "value": "testpassword" - } - ], - "state": "Inactive", - "topologyName": "IngestAndRecordGraphTopology" - }, - "systemData": { - "createdAt": "2020-06-10T19:17:58.812Z", - "lastModifiedAt": "2020-06-10T19:17:58.812Z" - } - } - } - } -} diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceStateChange.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceStateChange.json deleted file mode 100644 index ac22ba64c121..000000000000 --- a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceStateChange.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "name": "IngestAndRecordGraphInstance", - "@apiVersion": "1.0" - }, - "responses": { - "200": { - "payload": null, - "status": 200 - } - } -} diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologyDelete.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologyDelete.json deleted file mode 100644 index 3efef8901cc8..000000000000 --- a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologyDelete.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "name": "IngestAndRecordGraphTopology", - "@apiVersion": "1.0" - }, - "responses": { - "200": { - "payload": null, - "status": 200 - }, - "204": { - "payload": null, - "status": 204 - } - } -} diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologyGet.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologyGet.json deleted file mode 100644 index 02bcd4422f27..000000000000 --- a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologyGet.json +++ /dev/null @@ -1,70 +0,0 @@ -{ - "parameters": { - "name": "IngestAndRecordGraphTopology", - "@apiVersion": "1.0" - }, - "responses": { - "200": { - "body": { - "name": "IngestAndRecordGraphTopology", - "properties": { - "description": "Simple ingest and record graph definition.", - "parameters": [ - { - "default": "dummyUsername", - "description": "RTSP source username", - "name": "rtspUsername", - "type": "String" - }, - { - "default": "dummyPassword", - "description": "RTSP source password", - "name": "rtspPassword", - "type": "String" - } - ], - "processors": [], - "sinks": [ - { - "@type": "#Microsoft.Media.MediaGraphAssetSink", - "assetNamePattern": "assetSinkTest", - "inputs": [ - { - "nodeName": "rtspSource", - "outputSelectors": [] - } - ], - "localMediaCacheMaximumSizeMiB": "1024", - "localMediaCachePath": "/tmp/test", - "name": "assetSink", - "segmentLength": "PT30S" - } - ], - "sources": [ - { - "@type": "#Microsoft.Media.MediaGraphRtspSource", - "endpoint": { - "@type": "#Microsoft.Media.MediaGraphUnsecuredEndpoint", - "credentials": { - "@type": "#Microsoft.Media.MediaGraphUsernamePasswordCredentials", - "username": "${rtspUsername}" - }, - "url": "rtsp://testurl.com" - }, - "name": "rtspSource", - "transport": "Tcp" - } - ] - }, - "systemData": { - "createdAt": "2020-06-10T18:54:33.421Z", - "lastModifiedAt": "2020-06-10T18:55:43.901Z" - } - } - }, - "404": { - "payload": null, - "status": 404 - } - } -} diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologyList.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologyList.json deleted file mode 100644 index 54f6b1eaa64c..000000000000 --- a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologyList.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "parameters": { - "@apiVersion": "1.0" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "IngestAndRecordGraphTopology", - "properties": { - "description": "Simple ingest and record graph definition.", - "parameters": [ - { - "default": "dummyUsername", - "description": "RTSP source username", - "name": "rtspUsername", - "type": "String" - }, - { - "default": "dummyPassword", - "description": "RTSP source password", - "name": "rtspPassword", - "type": "String" - } - ], - "processors": [], - "sinks": [ - { - "@type": "#Microsoft.Media.MediaGraphAssetSink", - "assetNamePattern": "assetSinkTest", - "inputs": [ - { - "nodeName": "rtspSource", - "outputSelectors": [] - } - ], - "localMediaCacheMaximumSizeMiB": "1024", - "localMediaCachePath": "/tmp/test", - "name": "assetSink", - "segmentLength": "PT30S" - } - ], - "sources": [ - { - "@type": "#Microsoft.Media.MediaGraphRtspSource", - "endpoint": { - "@type": "#Microsoft.Media.MediaGraphUnsecuredEndpoint", - "credentials": { - "@type": "#Microsoft.Media.MediaGraphUsernamePasswordCredentials", - "username": "${rtspUsername}" - }, - "url": "rtsp://testurl.com" - }, - "name": "rtspSource", - "transport": "Tcp" - } - ] - }, - "systemData": { - "createdAt": "2020-06-10T18:54:33.421Z", - "lastModifiedAt": "2020-06-10T18:55:43.901Z" - } - } - ] - } - } - } -} diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologySet.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologySet.json deleted file mode 100644 index 97792c0e29c8..000000000000 --- a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologySet.json +++ /dev/null @@ -1,173 +0,0 @@ -{ - "parameters": { - "topology": { - "name": "IngestAndRecordGraphTopology", - "@apiVersion": "1.0", - "properties": { - "description": "Simple ingest and record graph definition.", - "parameters": [ - { - "default": "dummyUsername", - "description": "RTSP source username", - "name": "rtspUsername", - "type": "String" - }, - { - "default": "dummyPassword", - "description": "RTSP source password", - "name": "rtspPassword", - "type": "String" - } - ], - "sources": [ - { - "@type": "#Microsoft.Media.MediaGraphRtspSource", - "name": "rtspSource", - "endpoint": { - "@type": "#Microsoft.Media.MediaGraphUnsecuredEndpoint", - "url": "rtsp://testurl.com", - "credentials": { - "@type": "#Microsoft.Media.MediaGraphUsernamePasswordCredentials", - "username": "${rtspUsername}", - "password": "${rtspPassword}" - } - } - } - ], - "sinks": [ - { - "@type": "#Microsoft.Media.MediaGraphAssetSink", - "name": "assetSink", - "assetNamePattern": "assetSinkTest", - "inputs": [ - { - "nodeName": "rtspSource" - } - ], - "localMediaCachePath": "/tmp", - "localMediaCacheMaximumSizeMiB": "1024", - "segmentLength": "PT30S" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "name": "IngestAndRecordGraphTopology", - "properties": { - "description": "Simple ingest and record graph definition.", - "parameters": [ - { - "default": "dummyUsername", - "description": "RTSP source username", - "name": "rtspUsername", - "type": "String" - }, - { - "default": "dummyPassword", - "description": "RTSP source password", - "name": "rtspPassword", - "type": "String" - } - ], - "processors": [], - "sinks": [ - { - "@type": "#Microsoft.Media.MediaGraphAssetSink", - "assetNamePattern": "assetSinkTest", - "inputs": [ - { - "nodeName": "rtspSource", - "outputSelectors": [] - } - ], - "localMediaCacheMaximumSizeMiB": "1024", - "localMediaCachePath": "/tmp", - "name": "assetSink", - "segmentLength": "PT30S" - } - ], - "sources": [ - { - "@type": "#Microsoft.Media.MediaGraphRtspSource", - "endpoint": { - "@type": "#Microsoft.Media.MediaGraphUnsecuredEndpoint", - "credentials": { - "@type": "#Microsoft.Media.MediaGraphUsernamePasswordCredentials", - "username": "${rtspUsername}" - }, - "url": "rtsp://testurl.com" - }, - "name": "rtspSource", - "transport": "Tcp" - } - ] - }, - "systemData": { - "createdAt": "2020-06-10T18:54:33.421Z", - "lastModifiedAt": "2020-06-10T18:54:33.421Z" - } - } - }, - "201": { - "body": { - "name": "IngestAndRecordGraphTopology", - "properties": { - "description": "Simple ingest and record graph definition.", - "parameters": [ - { - "default": "dummyUsername", - "description": "RTSP source username", - "name": "rtspUsername", - "type": "String" - }, - { - "default": "dummyPassword", - "description": "RTSP source password", - "name": "rtspPassword", - "type": "String" - } - ], - "processors": [], - "sinks": [ - { - "@type": "#Microsoft.Media.MediaGraphAssetSink", - "assetNamePattern": "assetSinkTest", - "inputs": [ - { - "nodeName": "rtspSource", - "outputSelectors": [] - } - ], - "localMediaCacheMaximumSizeMiB": "1024", - "localMediaCachePath": "/tmp/test", - "name": "assetSink", - "segmentLength": "PT30S" - } - ], - "sources": [ - { - "@type": "#Microsoft.Media.MediaGraphRtspSource", - "endpoint": { - "@type": "#Microsoft.Media.MediaGraphUnsecuredEndpoint", - "credentials": { - "@type": "#Microsoft.Media.MediaGraphUsernamePasswordCredentials", - "username": "${rtspUsername}" - }, - "url": "rtsp://testurl.com" - }, - "name": "rtspSource", - "transport": "Tcp" - } - ] - }, - "systemData": { - "createdAt": "2020-06-10T18:54:33.421Z", - "lastModifiedAt": "2020-06-10T18:55:43.901Z" - } - } - } - } -} diff --git a/specification/mediaservices/data-plane/readme.md b/specification/mediaservices/data-plane/readme.md deleted file mode 100644 index 20ae5783b3b2..000000000000 --- a/specification/mediaservices/data-plane/readme.md +++ /dev/null @@ -1,97 +0,0 @@ -# MediaServices - Live Video Analytics Edge - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Live video analytics edge. - ---- - -## Getting Started - -To build the SDK for Live video analytics edge, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` - ---- - -## Configuration - -### Basic Information - -These are the global settings for the Live video analytics API. - -``` yaml -openapi-type: data-plane -tag: package-lva-1-0-preview -``` - -### Tag: package-2018-07 - -These settings apply only when `--tag=package-lva-1-0-preview` is specified on the command line. - -``` yaml $(tag) == 'package-lva-1-0-preview' -input-file: - - LiveVideoAnalytics.Edge/preview/1.0/LiveVideoAnalytics.json -``` - ---- - -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-net - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_media_lva_edge'] -``` - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: false - payload-flattening-threshold: 2 - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Media.LiveVideoAnalytics.Edge - output-folder: $(csharp-sdks-folder)/mediaservices/Microsoft.Azure.Media.LiveVideoAnalytics.Edge/src/Generated - clear-output-folder: true - use-internal-constructors: true - override-client-name: LiveVideoAnalyticsEdgeClient - use-datetimeoffset: true -``` -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/LiveVideoAnalytics.Edge/preview/1.0/LiveVideoAnalytics.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - From 560c55145410cf2146e8e58ca18584feb66c3b66 Mon Sep 17 00:00:00 2001 From: Yang Yuan Date: Tue, 15 Sep 2020 18:10:20 -0700 Subject: [PATCH 065/164] Add Metrics Advisor API Properties. (#10722) --- .../stable/2017-04-18/cognitiveservices.json | 20 +++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json index b342758b1f81..4413c8ecc9ef 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json @@ -1051,6 +1051,26 @@ "description": "(Personalization Only) The storage account connection string.", "pattern": "^(( *)DefaultEndpointsProtocol=(http|https)( *);( *))?AccountName=(.*)AccountKey=(.*)EndpointSuffix=(.*)$", "maxLength": 1000 + }, + "aadClientId": { + "type": "string", + "description": "(Metrics Advisor Only) The Azure AD Client Id (Application Id).", + "maxLength": 500 + }, + "aadTenantId": { + "type": "string", + "description": "(Metrics Advisor Only) The Azure AD Tenant Id.", + "maxLength": 500 + }, + "superUser": { + "type": "string", + "description": "(Metrics Advisor Only) The super user of Metrics Advisor.", + "maxLength": 500 + }, + "websiteName": { + "type": "string", + "description": "(Metrics Advisor Only) The website name of Metrics Advisor.", + "maxLength": 500 } }, "description": "The api properties for special APIs." From 8f7f2ce3ae768c0aa914fec8b65dbd80634420e4 Mon Sep 17 00:00:00 2001 From: Alexander Zaslonov Date: Tue, 15 Sep 2020 18:53:23 -0700 Subject: [PATCH 066/164] [Microsoft.ApiManagement][2019-12-01] Content management resources: Collapsed the reference to metadata. (#10755) --- .../2019-12-01/examples/ApiManagementGetContentType.json | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/examples/ApiManagementGetContentType.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/examples/ApiManagementGetContentType.json index 236c09de813f..fe3b604cd40c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/examples/ApiManagementGetContentType.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/examples/ApiManagementGetContentType.json @@ -18,12 +18,6 @@ "schema": { "properties": { "en_us": { - "$ref": "#/definitions/metadata" - } - }, - "additionalProperties": false, - "definitions": { - "metadata": { "type": "object", "properties": { "title": { @@ -63,7 +57,8 @@ "documentId" ] } - } + }, + "additionalProperties": false }, "version": "1.0.0" } From 988270d53d4f62f229bcbebde7c00da3175cc3a9 Mon Sep 17 00:00:00 2001 From: Abhinav Ghai Date: Tue, 15 Sep 2020 19:12:33 -0700 Subject: [PATCH 067/164] Update provisioningStatus field name for assignment (#10754) * Add list and get software to GuestConfiguration * Use newer API version for software * Revert software Swagger spec since these are private preview only * Add Automanage resource provider * Address validation tool errors * spelling add antimalware * Address lint errors * Fix error response * Fix newline * Fix Operations API Lint * Fix operations example * Fix prettier and lint * Address lint and prettier errors * Use common definitions and correct pref enum * Fix parameter * Address comments * Fix update examples * Prettier fix * Fix python md * Change provisioningStatus field name * Fix config profile name in examples * resolve conflict * Address conflict Co-authored-by: Abhinav Ghai Co-authored-by: Feng Zhou <55177366+fengzhou-msft@users.noreply.github.com> --- .../preview/2020-06-30-preview/automanage.json | 4 ++-- .../createOrUpdateConfigurationProfileAssignment.json | 10 +++++----- .../examples/getConfigurationProfileAssignment.json | 4 ++-- .../examples/listConfigurationProfileAssignments.json | 8 ++++---- ...tConfigurationProfileAssignmentsBySubscription.json | 8 ++++---- 5 files changed, 17 insertions(+), 17 deletions(-) diff --git a/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/automanage.json b/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/automanage.json index d82d8023bd7f..3f181fed7963 100644 --- a/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/automanage.json +++ b/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/automanage.json @@ -1107,12 +1107,12 @@ "x-nullable": true, "description": "The configuration profile custom preferences ARM resource URI" }, - "provisioningStatus": { + "provisioningState": { "type": "string", "readOnly": true, "description": "The state of onboarding, which only appears in the response.", "x-ms-enum": { - "name": "provisioningStatus", + "name": "provisioningState", "modelAsString": true }, "enum": [ diff --git a/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/createOrUpdateConfigurationProfileAssignment.json b/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/createOrUpdateConfigurationProfileAssignment.json index e481e11c5b6e..dd5bc5c6af8e 100644 --- a/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/createOrUpdateConfigurationProfileAssignment.json +++ b/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/createOrUpdateConfigurationProfileAssignment.json @@ -7,7 +7,7 @@ "api-version": "2020-06-30-preview", "parameters": { "properties": { - "configurationProfile": "Azure Best Practices - Prod", + "configurationProfile": "Azure virtual machine best practices – Production", "accountId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automanage/accounts/AutomanageAccount", "configurationProfilePreferenceId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Automanage/configurationProfilePreferences/defaultProfilePreference" } @@ -21,13 +21,13 @@ "name": "default", "properties": { "targetId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines", - "configurationProfile": "Azure Best Practices - Prod", + "configurationProfile": "Azure virtual machine best practices – Production", "accountId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automanage/AutomanageAccounts/AutomanageAccount", "configurationProfilePreferenceId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Automanage/configurationProfilePreferences/defaultProfilePreference", "compliance": { "updateStatus": "Created" }, - "provisioningStatus": "Created" + "provisioningState": "Created" } } }, @@ -38,13 +38,13 @@ "name": "default", "properties": { "targetId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines", - "configurationProfile": "Azure Best Practices - Prod", + "configurationProfile": "Azure virtual machine best practices – Production", "accountId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automanage/AutomanageAccounts/AutomanageAccount", "configurationProfilePreferenceId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Automanage/configurationProfilePreferences/defaultProfilePreference", "compliance": { "updateStatus": "Succeeded" }, - "provisioningStatus": "Succeeded" + "provisioningState": "Succeeded" } } } diff --git a/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/getConfigurationProfileAssignment.json b/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/getConfigurationProfileAssignment.json index e0f622172f59..a526f23ecbac 100644 --- a/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/getConfigurationProfileAssignment.json +++ b/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/getConfigurationProfileAssignment.json @@ -15,13 +15,13 @@ "type": "Microsoft.Automanage/ConfigurationProfileAssignments", "properties": { "targetId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines", - "configurationProfile": "Azure Best Practices - Prod", + "configurationProfile": "Azure virtual machine best practices – Production", "accountId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automanage/accounts/automanageAccount", "configurationProfilePreferenceId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Automanage/configurationProfilePreferences/defaultProfilePreference", "compliance": { "updateStatus": "Succeeded" }, - "provisioningStatus": "Succeeded" + "provisioningState": "Succeeded" } } } diff --git a/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/listConfigurationProfileAssignments.json b/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/listConfigurationProfileAssignments.json index 4a5703b7f0ff..6761b5da71d9 100644 --- a/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/listConfigurationProfileAssignments.json +++ b/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/listConfigurationProfileAssignments.json @@ -15,13 +15,13 @@ "type": "Microsoft.Automanage/ConfigurationProfileAssignments", "properties": { "targetId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm", - "configurationProfile": "Azure Best Practices - Prod", + "configurationProfile": "Azure virtual machine best practices – Production", "accountId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automanage/accounts/automanageAccount", "configurationProfilePreferenceId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Automanage/configurationProfilePreferences/defaultProfilePreference", "compliance": { "updateStatus": "Succeeded" }, - "provisioningStatus": "Succeeded" + "provisioningState": "Succeeded" } }, { @@ -30,13 +30,13 @@ "type": "Microsoft.Automanage/ConfigurationProfileAssignments", "properties": { "targetId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm2", - "configurationProfile": "Azure Best Practices - Prod", + "configurationProfile": "Azure virtual machine best practices – Production", "accountId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automanage/accounts/automanageAccount", "configurationProfilePreferenceId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Automanage/configurationProfilePreferences/defaultProfilePreference", "compliance": { "updateStatus": "Succeeded" }, - "provisioningStatus": "Succeeded" + "provisioningState": "Succeeded" } } ] diff --git a/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/listConfigurationProfileAssignmentsBySubscription.json b/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/listConfigurationProfileAssignmentsBySubscription.json index f9b259b3cf6c..8a696d3e500c 100644 --- a/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/listConfigurationProfileAssignmentsBySubscription.json +++ b/specification/automanage/resource-manager/Microsoft.Automanage/preview/2020-06-30-preview/examples/listConfigurationProfileAssignmentsBySubscription.json @@ -14,13 +14,13 @@ "name": "default", "properties": { "targetId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm", - "configurationProfile": "Azure Best Practices - Prod", + "configurationProfile": "Azure virtual machine best practices – Production", "accountId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automanage/accounts/automanageAccount", "configurationProfilePreferenceId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Automanage/configurationProfilePreferences/defaultProfilePreference", "compliance": { "updateStatus": "Succeeded" }, - "provisioningStatus": "Succeeded" + "provisioningState": "Succeeded" } }, { @@ -28,13 +28,13 @@ "name": "default", "properties": { "targetId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm2", - "configurationProfile": "Azure Best Practices - Prod", + "configurationProfile": "Azure virtual machine best practices – Production", "accountId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automanage/accounts/automanageAccount", "configurationProfilePreferenceId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Automanage/configurationProfilePreferences/defaultProfilePreference", "compliance": { "updateStatus": "Succeeded" }, - "provisioningStatus": "Succeeded" + "provisioningState": "Succeeded" } } ] From 7cf01c8c93b42316b7a5b6b65e0eb9218a2bdfc5 Mon Sep 17 00:00:00 2001 From: Shashwat Aggarwal Date: Wed, 16 Sep 2020 08:31:44 +0530 Subject: [PATCH 068/164] [ASR][V2A-RCM] Add new properties and provider specific models for V2A RCM. (#10487) * Update swagger spec with latest V2A-Rcm changes * Fix spell check --- custom-words.txt | 3 + .../stable/2018-07-10/service.json | 1890 ++++++++++++++++- 2 files changed, 1867 insertions(+), 26 deletions(-) diff --git a/custom-words.txt b/custom-words.txt index 58407c721c65..70a0bbe84d4e 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -477,6 +477,7 @@ discoverbackup diskmigrationjobs diskoperations Distcp +Distro DMTS Dnat dnsname @@ -486,6 +487,8 @@ Domainful domainname domainservices DOTALL +dras +DRAs DRMs dsmax DTDL diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-07-10/service.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-07-10/service.json index 7f53155a6a2e..b0a4baffd3a6 100644 --- a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-07-10/service.json +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-07-10/service.json @@ -8294,6 +8294,46 @@ }, "x-ms-discriminator-value": "A2A" }, + "A2ATestFailoverInput": { + "description": "A2A provider specific input for test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + }, + "cloudServiceCreationOption": { + "description": "A value indicating whether to use recovery cloud service for TFO or not.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, + "A2AUnplannedFailoverInput": { + "description": "A2A provider specific input for unplanned failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + }, + "cloudServiceCreationOption": { + "description": "A value indicating whether to use recovery cloud service for failover or not.", + "type": "string" + } + }, + "x-ms-discriminator-value": "A2A" + }, "A2AUnprotectedDiskDetails": { "description": "A2A unprotected disk details.", "type": "object", @@ -8515,6 +8555,10 @@ "description": "The name of the machine where the provider is getting added.", "type": "string" }, + "machineId": { + "description": "The Id of the machine where the provider is getting added.", + "type": "string" + }, "authenticationIdentityInput": { "$ref": "#/definitions/IdentityProviderInput", "description": "The identity provider input for DRA authentication." @@ -8522,6 +8566,10 @@ "resourceAccessIdentityInput": { "$ref": "#/definitions/IdentityProviderInput", "description": "The identity provider input for resource access." + }, + "dataPlaneAuthenticationIdentityInput": { + "$ref": "#/definitions/IdentityProviderInput", + "description": "The identity provider input for data plane authentication." } } }, @@ -8561,6 +8609,73 @@ } } }, + "AgentDetails": { + "description": "Agent details.", + "type": "object", + "properties": { + "agentId": { + "description": "The Id of the agent running on the server.", + "type": "string", + "readOnly": true + }, + "machineId": { + "description": "The Id of the machine to which the agent is registered.", + "type": "string", + "readOnly": true + }, + "biosId": { + "description": "The machine BIOS Id.", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "The machine FQDN.", + "type": "string", + "readOnly": true + }, + "disks": { + "description": "The details of agent disks.", + "type": "array", + "items": { + "$ref": "#/definitions/AgentDiskDetails" + }, + "readOnly": true + } + } + }, + "AgentDiskDetails": { + "description": "Agent disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string", + "readOnly": true + }, + "diskName": { + "description": "The disk name.", + "type": "string", + "readOnly": true + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string", + "readOnly": true + }, + "capacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer", + "readOnly": true + }, + "lunId": { + "format": "int32", + "description": "The lun of disk.", + "type": "integer", + "readOnly": true + } + } + }, "Alert": { "description": "Implements the Alert class.", "type": "object", @@ -9335,11 +9450,11 @@ "type": "object", "properties": { "secretIdentifier": { - "description": "The secret url / identifier.", + "description": "The secret URL / identifier.", "type": "string" }, "keyVaultResourceArmId": { - "description": "The KeyVault resource ARM id for secret.", + "description": "The KeyVault resource ARM Id for secret.", "type": "string" } } @@ -9380,6 +9495,56 @@ } } }, + "DraDetails": { + "description": "DRA details.", + "type": "object", + "properties": { + "id": { + "description": "The DRA Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The DRA name.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The DRA version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the DRA.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the DRA.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, "EnableMigrationInput": { "description": "Enable migration input.", "required": [ @@ -10539,6 +10704,62 @@ }, "x-ms-discriminator-value": "HyperVReplicaAzure" }, + "HyperVReplicaAzureTestFailoverInput": { + "description": "HvrA provider specific input for test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "vaultLocation": { + "description": "Location of the vault.", + "type": "string" + }, + "primaryKekCertificatePfx": { + "description": "Primary kek certificate pfx.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "Secondary kek certificate pfx.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, + "HyperVReplicaAzureUnplannedFailoverInput": { + "description": "HvrA provider specific input for unplanned failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "vaultLocation": { + "description": "Location of the vault.", + "type": "string" + }, + "primaryKekCertificatePfx": { + "description": "Primary kek certificate pfx.", + "type": "string" + }, + "secondaryKekCertificatePfx": { + "description": "Secondary kek certificate pfx.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "HyperVReplicaAzure" + }, "HyperVReplicaAzureUpdateReplicationProtectedItemInput": { "description": "HyperV replica Azure input to update replication protected item.", "type": "object", @@ -11990,6 +12211,46 @@ }, "x-ms-discriminator-value": "InMageAzureV2" }, + "InMageAzureV2TestFailoverInput": { + "description": "InMageAzureV2 provider specific input for test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "vaultLocation": { + "description": "Location of the vault.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, + "InMageAzureV2UnplannedFailoverInput": { + "description": "InMageAzureV2 provider specific input for unplanned failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "vaultLocation": { + "description": "Location of the vault.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageAzureV2" + }, "InMageAzureV2UpdateReplicationProtectedItemInput": { "description": "InMage Azure V2 input to update replication protected item.", "type": "object", @@ -12371,17 +12632,1153 @@ } } }, - "InMageReplicationDetails": { - "description": "InMage provider specific settings", + "InMageRcmAgentUpgradeBlockingErrorDetails": { + "description": "InMageRcm source agent upgrade blocking error details.", + "type": "object", + "properties": { + "errorCode": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "possibleCauses": { + "description": "The possible causes.", + "type": "string", + "readOnly": true + }, + "recommendedAction": { + "description": "The recommended action.", + "type": "string", + "readOnly": true + }, + "errorMessageParameters": { + "description": "The error message parameters.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "errorTags": { + "description": "The error tags.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "InMageRcmApplyRecoveryPointInput": { + "description": "ApplyRecoveryPoint input specific to InMageRcm provider.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ReplicationProviderSpecificSettings" + "$ref": "#/definitions/ApplyRecoveryPointProviderSpecificInput" } ], "properties": { - "activeSiteType": { - "description": "The active location of the VM. If the VM is being protected from Azure, this field will take values from { Azure, OnPrem }. If the VM is being protected between two data-centers, this field will be OnPrem always.", + "recoveryPointId": { + "description": "The recovery point Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmDiskInput": { + "description": "InMageRcm disk input.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string" + }, + "diskType": { + "description": "The disk type.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "diskEncryptionSetId": { + "description": "The disk encryption set ARM Id.", + "type": "string" + } + } + }, + "InMageRcmDisksDefaultInput": { + "description": "InMageRcm disk input.", + "type": "object", + "properties": { + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string" + }, + "diskType": { + "description": "The disk type.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + }, + "diskEncryptionSetId": { + "description": "The disk encryption set ARM Id.", + "type": "string" + } + } + }, + "InMageRcmEnableProtectionInput": { + "description": "InMageRcm specific enable protection input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableProtectionProviderSpecificInput" + } + ], + "properties": { + "fabricDiscoveryMachineId": { + "description": "The ARM Id of discovered machine.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmDiskInput" + } + }, + "disksDefault": { + "$ref": "#/definitions/InMageRcmDisksDefaultInput", + "description": "The default disk input." + }, + "targetResourceGroupId": { + "description": "The target resource group ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The selected target network ARM Id.", + "type": "string" + }, + "testNetworkId": { + "description": "The selected test network ARM Id.", + "type": "string" + }, + "targetSubnetName": { + "description": "The selected target subnet name.", + "type": "string" + }, + "testSubnetName": { + "description": "The selected test subnet name.", + "type": "string" + }, + "targetVmName": { + "description": "The target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "licenseType": { + "description": "The license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "runAsAccountId": { + "description": "The run-as account Id.", + "type": "string" + }, + "processServerId": { + "description": "The process server Id.", + "type": "string" + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmEventDetails": { + "description": "Event details for InMageRcm provider.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventProviderSpecificDetails" + } + ], + "properties": { + "protectedItemName": { + "description": "The protected item name.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmFabricCreationInput": { + "description": "InMageRcm fabric provider specific settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificCreationInput" + } + ], + "properties": { + "vmwareSiteId": { + "description": "The ARM Id of the VMware site.", + "type": "string" + }, + "physicalSiteId": { + "description": "The ARM Id of the physical site.", + "type": "string" + }, + "sourceAgentIdentity": { + "$ref": "#/definitions/IdentityProviderInput", + "description": "The identity provider input for source agent authentication." + }, + "authCertificate": { + "description": "The certificate to be used for AAD authentication.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmFabricSpecificDetails": { + "description": "InMageRcm fabric specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FabricSpecificDetails" + } + ], + "properties": { + "vmwareSiteId": { + "description": "The ARM Id of the VMware site.", + "type": "string", + "readOnly": true + }, + "physicalSiteId": { + "description": "The ARM Id of the physical site.", + "type": "string", + "readOnly": true + }, + "serviceEndpoint": { + "description": "The service endpoint.", + "type": "string", + "readOnly": true + }, + "serviceResourceId": { + "description": "The service resource Id.", + "type": "string", + "readOnly": true + }, + "serviceContainerId": { + "description": "The service container Id.", + "type": "string", + "readOnly": true + }, + "dataPlaneUri": { + "description": "The data plane Uri.", + "type": "string", + "readOnly": true + }, + "controlPlaneUri": { + "description": "The control plane Uri.", + "type": "string", + "readOnly": true + }, + "processServers": { + "description": "The list of process servers.", + "type": "array", + "items": { + "$ref": "#/definitions/ProcessServerDetails" + }, + "readOnly": true + }, + "rcmProxies": { + "description": "The list of RCM proxies.", + "type": "array", + "items": { + "$ref": "#/definitions/RcmProxyDetails" + }, + "readOnly": true + }, + "pushInstallers": { + "description": "The list of push installers.", + "type": "array", + "items": { + "$ref": "#/definitions/PushInstallerDetails" + }, + "readOnly": true + }, + "replicationAgents": { + "description": "The list of replication agents.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicationAgentDetails" + }, + "readOnly": true + }, + "reprotectAgents": { + "description": "The list of reprotect agents.", + "type": "array", + "items": { + "$ref": "#/definitions/ReprotectAgentDetails" + }, + "readOnly": true + }, + "dras": { + "description": "The list of DRAs.", + "type": "array", + "items": { + "$ref": "#/definitions/DraDetails" + }, + "readOnly": true + }, + "agentDetails": { + "description": "The list of agent details.", + "type": "array", + "items": { + "$ref": "#/definitions/AgentDetails" + }, + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmLastAgentUpgradeErrorDetails": { + "description": "InMageRcm last source agent upgrade error details.", + "type": "object", + "properties": { + "errorCode": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "possibleCauses": { + "description": "The possible causes.", + "type": "string", + "readOnly": true + }, + "recommendedAction": { + "description": "The recommended action.", + "type": "string", + "readOnly": true + }, + "errorMessageParameters": { + "description": "The error message parameters.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "errorTags": { + "description": "The error tags.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "InMageRcmMobilityAgentDetails": { + "description": "InMageRcm mobility agent details.", + "type": "object", + "properties": { + "version": { + "description": "The agent version.", + "type": "string", + "readOnly": true + }, + "latestVersion": { + "description": "The latest agent version available.", + "type": "string", + "readOnly": true + }, + "driverVersion": { + "description": "The driver version.", + "type": "string", + "readOnly": true + }, + "latestUpgradableVersionWithoutReboot": { + "description": "The latest upgradeable version available without reboot.", + "type": "string", + "readOnly": true + }, + "agentVersionExpiryDate": { + "format": "date-time", + "description": "The agent version expiry date.", + "type": "string", + "readOnly": true + }, + "driverVersionExpiryDate": { + "format": "date-time", + "description": "The driver version expiry date.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The time of the last heartbeat received from the agent.", + "type": "string", + "readOnly": true + }, + "reasonsBlockingUpgrade": { + "description": "The whether update is possible or not.", + "type": "array", + "items": { + "enum": [ + "AlreadyOnLatestVersion", + "RebootRequired", + "AgentNoHeartbeat", + "RcmProxyNoHeartbeat", + "ProcessServerNoHeartbeat", + "IncompatibleApplianceVersion", + "NotProtected", + "UnsupportedProtectionScenario", + "DistroIsNotReported", + "DistroNotSupportedForUpgrade", + "MissingUpgradePath", + "InvalidAgentVersion", + "InvalidDriverVersion", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "name": "AgentUpgradeBlockedReason", + "modelAsString": true + } + }, + "readOnly": true + }, + "isUpgradeable": { + "description": "A value indicating whether agent is upgradeable or not.", + "type": "string", + "readOnly": true + } + } + }, + "InMageRcmNicDetails": { + "description": "InMageRcm NIC details.", + "type": "object", + "properties": { + "nicId": { + "description": "The NIC Id.", + "type": "string", + "readOnly": true + }, + "isPrimaryNic": { + "description": "A value indicating whether this is the primary NIC.", + "type": "string", + "readOnly": true + }, + "isSelectedForFailover": { + "description": "A value indicating whether this NIC is selected for failover.", + "type": "string", + "readOnly": true + }, + "sourceIPAddress": { + "description": "The source IP address.", + "type": "string", + "readOnly": true + }, + "sourceIPAddressType": { + "description": "The source IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "sourceNetworkId": { + "description": "Source network Id.", + "type": "string", + "readOnly": true + }, + "sourceSubnetName": { + "description": "Source subnet name.", + "type": "string", + "readOnly": true + }, + "targetIPAddress": { + "description": "The target IP address.", + "type": "string", + "readOnly": true + }, + "targetIPAddressType": { + "description": "The target IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "targetSubnetName": { + "description": "Target subnet name.", + "type": "string", + "readOnly": true + }, + "testSubnetName": { + "description": "Test subnet name.", + "type": "string", + "readOnly": true + }, + "testIPAddress": { + "description": "The test IP address.", + "type": "string", + "readOnly": true + }, + "testIPAddressType": { + "description": "The test IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + } + } + }, + "InMageRcmNicInput": { + "description": "InMageRcm NIC input.", + "type": "object", + "properties": { + "nicId": { + "description": "The NIC Id.", + "type": "string" + }, + "isPrimaryNic": { + "description": "A value indicating whether this is the primary NIC.", + "type": "string" + }, + "isSelectedForFailover": { + "description": "A value indicating whether this NIC is selected for failover.", + "type": "string" + }, + "targetSubnetName": { + "description": "Target subnet name.", + "type": "string" + }, + "targetStaticIPAddress": { + "description": "The target static IP address.", + "type": "string" + }, + "testSubnetName": { + "description": "The test subnet name.", + "type": "string" + }, + "testStaticIPAddress": { + "description": "The test static IP address.", + "type": "string" + } + } + }, + "InMageRcmPolicyCreationInput": { + "description": "InMageRcm policy creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificInput" + } + ], + "properties": { + "recoveryPointHistoryInMinutes": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer" + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency (in minutes).", + "type": "integer" + }, + "enableMultiVmSync": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmPolicyDetails": { + "description": "InMageRcm specific policy details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PolicyProviderSpecificDetails" + } + ], + "properties": { + "recoveryPointHistoryInMinutes": { + "format": "int32", + "description": "The duration in minutes until which the recovery points need to be stored.", + "type": "integer", + "readOnly": true + }, + "appConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The app consistent snapshot frequency in minutes.", + "type": "integer", + "readOnly": true + }, + "crashConsistentFrequencyInMinutes": { + "format": "int32", + "description": "The crash consistent snapshot frequency in minutes.", + "type": "integer", + "readOnly": true + }, + "enableMultiVmSync": { + "description": "A value indicating whether multi-VM sync has to be enabled.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmProtectedDiskDetails": { + "description": "InMageRcm protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string", + "readOnly": true + }, + "diskName": { + "description": "The disk name.", + "type": "string", + "readOnly": true + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string", + "readOnly": true + }, + "capacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer", + "readOnly": true + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string", + "readOnly": true + }, + "diskEncryptionSetId": { + "description": "The disk encryption set ARM Id.", + "type": "string", + "readOnly": true + }, + "seedManagedDiskId": { + "description": "The ARM Id of the seed managed disk.", + "type": "string", + "readOnly": true + }, + "targetManagedDiskId": { + "description": "The ARM Id of the target managed disk.", + "type": "string", + "readOnly": true + }, + "diskType": { + "description": "The disk type.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + } + } + }, + "InMageRcmRecoveryPointDetails": { + "description": "InMageRcm provider specific recovery point details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProviderSpecificRecoveryPointDetails" + } + ], + "properties": { + "isMultiVmSyncPoint": { + "description": "A value indicating whether the recovery point is multi VM consistent.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmReplicationDetails": { + "description": "InMageRcm provider specific details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "internalIdentifier": { + "description": "The virtual machine internal identifier.", + "type": "string", + "readOnly": true + }, + "fabricDiscoveryMachineId": { + "description": "The ARM Id of the discovered VM.", + "type": "string", + "readOnly": true + }, + "multiVmGroupName": { + "description": "The multi VM group name.", + "type": "string", + "readOnly": true + }, + "discoveryType": { + "description": "The type of the discovered VM.", + "type": "string", + "readOnly": true + }, + "processServerId": { + "description": "The process server Id.", + "type": "string", + "readOnly": true + }, + "processorCoreCount": { + "format": "int32", + "description": "The processor core count.", + "type": "integer", + "readOnly": true + }, + "allocatedMemoryInMB": { + "format": "double", + "description": "The allocated memory in MB.", + "type": "number", + "readOnly": true + }, + "processServerName": { + "description": "The process server name.", + "type": "string", + "readOnly": true + }, + "runAsAccountId": { + "description": "The run-as account Id.", + "type": "string", + "readOnly": true + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string", + "readOnly": true + }, + "firmwareType": { + "description": "The firmware type.", + "type": "string", + "readOnly": true + }, + "targetGeneration": { + "description": "The target generation.", + "type": "string", + "readOnly": true + }, + "licenseType": { + "description": "License Type of the VM to be used.", + "type": "string", + "readOnly": true + }, + "targetVmName": { + "description": "Target VM name.", + "type": "string", + "readOnly": true + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string", + "readOnly": true + }, + "targetResourceGroupId": { + "description": "The target resource group Id.", + "type": "string", + "readOnly": true + }, + "targetAvailabilitySetId": { + "description": "The target availability set Id.", + "type": "string", + "readOnly": true + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string", + "readOnly": true + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string", + "readOnly": true + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string", + "readOnly": true + }, + "targetNetworkId": { + "description": "The target network Id.", + "type": "string", + "readOnly": true + }, + "testNetworkId": { + "description": "The test network Id.", + "type": "string", + "readOnly": true + }, + "failoverRecoveryPointId": { + "description": "The recovery point Id to which the VM was failed over.", + "type": "string", + "readOnly": true + }, + "lastRecoveryPointReceived": { + "format": "date-time", + "description": "The last recovery point received time.", + "type": "string", + "readOnly": true + }, + "lastRpoInSeconds": { + "format": "int64", + "description": "The last recovery point objective value.", + "type": "integer", + "readOnly": true + }, + "lastRpoCalculatedTime": { + "format": "date-time", + "description": "The last recovery point objective calculated time.", + "type": "string", + "readOnly": true + }, + "lastRecoveryPointId": { + "description": "The last recovery point Id.", + "type": "string", + "readOnly": true + }, + "initialReplicationProgressPercentage": { + "format": "int32", + "description": "The initial replication progress percentage. This is calculated based on total bytes processed for all disks in the source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationProcessedBytes": { + "format": "int64", + "description": "The initial replication processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", + "type": "integer", + "readOnly": true + }, + "initialReplicationTransferredBytes": { + "format": "int64", + "description": "The initial replication transferred bytes from source VM to azure for all selected disks on source VM.", + "type": "integer", + "readOnly": true + }, + "resyncProgressPercentage": { + "format": "int32", + "description": "The resync progress percentage. This is calculated based on total bytes processed for all disks in the source VM.", + "type": "integer", + "readOnly": true + }, + "resyncProcessedBytes": { + "format": "int64", + "description": "The resync processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM.", + "type": "integer", + "readOnly": true + }, + "resyncTransferredBytes": { + "format": "int64", + "description": "The resync transferred bytes from source VM to azure for all selected disks on source VM.", + "type": "integer", + "readOnly": true + }, + "resyncRequired": { + "description": "A value indicating whether resync is required.", + "type": "string", + "readOnly": true + }, + "resyncState": { + "description": "The resync state.", + "enum": [ + "None", + "PreparedForResynchronization", + "StartedResynchronization" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ResyncState", + "modelAsString": true + } + }, + "agentUpgradeState": { + "description": "The agent auto upgrade state.", + "enum": [ + "None", + "Started", + "Completed", + "Commit" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MobilityAgentUpgradeState", + "modelAsString": true + } + }, + "lastAgentUpgradeType": { + "description": "The last agent upgrade type.", + "type": "string", + "readOnly": true + }, + "lastAgentUpgradeFailedJobId": { + "description": "The last agent upgrade failed or cancelled job Id.", + "type": "string", + "readOnly": true + }, + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/InMageRcmProtectedDiskDetails" + } + }, + "isLastUpgradeSuccessful": { + "description": "A value indicating whether last agent upgrade was successful or not.", + "type": "string", + "readOnly": true + }, + "mobilityAgentDetails": { + "$ref": "#/definitions/InMageRcmMobilityAgentDetails", + "description": "The mobility agent information.", + "readOnly": true + }, + "lastAgentUpgradeErrorDetails": { + "description": "The last agent upgrade error information.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/InMageRcmLastAgentUpgradeErrorDetails" + } + }, + "agentUpgradeBlockingErrorDetails": { + "description": "The agent upgrade blocking error information.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/InMageRcmAgentUpgradeBlockingErrorDetails" + } + }, + "vmNics": { + "description": "The network details.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/InMageRcmNicDetails" + } + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmTestFailoverInput": { + "description": "InMageRcm provider specific input for test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "networkId": { + "description": "The test network Id.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmUnplannedFailoverInput": { + "description": "InMageRcm provider specific input for unplanned failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "performShutdown": { + "description": "A value indicating whether VM is to be shutdown.", + "type": "string" + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageRcmUpdateReplicationProtectedItemInput": { + "description": "InMageRcm provider specific input to update replication protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateReplicationProtectedItemProviderInput" + } + ], + "properties": { + "targetVmName": { + "description": "The target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetResourceGroupId": { + "description": "The target resource group ARM Id.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The target network ARM Id.", + "type": "string" + }, + "testNetworkId": { + "description": "The test network ARM Id.", + "type": "string" + }, + "vmNics": { + "description": "The list of NIC details.", + "minLength": 1, + "type": "array", + "items": { + "$ref": "#/definitions/InMageRcmNicInput" + } + }, + "licenseType": { + "description": "The license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, + "InMageReplicationDetails": { + "description": "InMage provider specific settings", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificSettings" + } + ], + "properties": { + "activeSiteType": { + "description": "The active location of the VM. If the VM is being protected from Azure, this field will take values from { Azure, OnPrem }. If the VM is being protected between two data-centers, this field will be OnPrem always.", "type": "string" }, "sourceVmCpuCount": { @@ -12610,6 +14007,64 @@ }, "x-ms-discriminator-value": "InMage" }, + "InMageTestFailoverInput": { + "description": "Provider specific input for InMage test failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type. Values from LatestTime, LatestTag or Custom. In the case of custom, the recovery point provided by RecoveryPointId will be used. In the other two cases, recovery point id will be ignored.", + "enum": [ + "LatestTime", + "LatestTag", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointType", + "modelAsString": true + } + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to test failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, + "InMageUnplannedFailoverInput": { + "description": "Provider specific input for InMage unplanned failover.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type. Values from LatestTime, LatestTag or Custom. In the case of custom, the recovery point provided by RecoveryPointId will be used. In the other two cases, recovery point id will be ignored.", + "enum": [ + "LatestTime", + "LatestTag", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointType", + "modelAsString": true + } + }, + "recoveryPointId": { + "description": "The recovery point id to be passed to failover to a particular recovery point. In case of latest recovery point, null should be passed.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMage" + }, "InMageVolumeExclusionOptions": { "description": "Guest disk signature based disk exclusion option when doing enable protection of virtual machine in InMage provider.", "type": "object", @@ -12980,11 +14435,11 @@ "type": "object", "properties": { "keyIdentifier": { - "description": "The key url / identifier.", + "description": "The key URL / identifier.", "type": "string" }, "keyVaultResourceArmId": { - "description": "The KeyVault resource ARM id for key.", + "description": "The KeyVault resource ARM Id for key.", "type": "string" } } @@ -13965,20 +15420,151 @@ "type": "integer", "readOnly": true }, - "throughputStatus": { - "description": "The throughput status.", - "type": "string", + "throughputStatus": { + "description": "The throughput status.", + "type": "string", + "readOnly": true + }, + "marsCommunicationStatus": { + "description": "The MARS communication status.", + "type": "string", + "readOnly": true + }, + "marsRegistrationStatus": { + "description": "The MARS registration status.", + "type": "string", + "readOnly": true + } + } + }, + "ProcessServerDetails": { + "description": "Process server details.", + "type": "object", + "properties": { + "id": { + "description": "The process server Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The process server name.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The process server version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the process server.", + "type": "string", + "readOnly": true + }, + "totalMemoryInBytes": { + "format": "int64", + "description": "The total memory.", + "type": "integer", + "readOnly": true + }, + "availableMemoryInBytes": { + "format": "int64", + "description": "The available memory.", + "type": "integer", + "readOnly": true + }, + "usedMemoryInBytes": { + "format": "int64", + "description": "The used memory.", + "type": "integer", + "readOnly": true + }, + "memoryUsagePercentage": { + "format": "double", + "description": "The memory usage percentage.", + "type": "number", + "readOnly": true + }, + "totalSpaceInBytes": { + "format": "int64", + "description": "The total disk space.", + "type": "integer", + "readOnly": true + }, + "availableSpaceInBytes": { + "format": "int64", + "description": "The available disk space.", + "type": "integer", + "readOnly": true + }, + "usedSpaceInBytes": { + "format": "int64", + "description": "The used disk space.", + "type": "integer", + "readOnly": true + }, + "freeSpacePercentage": { + "format": "double", + "description": "The free disk space percentage.", + "type": "number", + "readOnly": true + }, + "throughputUploadPendingDataInBytes": { + "format": "int64", + "description": "The uploading pending data in bytes.", + "type": "integer", + "readOnly": true + }, + "throughputInBytes": { + "format": "int64", + "description": "The throughput in bytes.", + "type": "integer", + "readOnly": true + }, + "processorUsagePercentage": { + "format": "double", + "description": "The processor usage percentage.", + "type": "number", "readOnly": true }, - "marsCommunicationStatus": { - "description": "The MARS communication status.", + "health": { + "description": "The health of the process server.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, "readOnly": true }, - "marsRegistrationStatus": { - "description": "The MARS registration status.", + "historicHealth": { + "description": "The historic health of the process server based on the health in last 24 hours.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], "type": "string", - "readOnly": true + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } } } }, @@ -14367,6 +15953,106 @@ }, "x-ms-discriminator-value": "RcmAzureMigration" }, + "PushInstallerDetails": { + "description": "Push installer details.", + "type": "object", + "properties": { + "id": { + "description": "The push installer Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The push installer name.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The push installer version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the push installer.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the push installer.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, + "RcmProxyDetails": { + "description": "RCM proxy details.", + "type": "object", + "properties": { + "id": { + "description": "The RCM proxy Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The RCM proxy name.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The RCM proxy version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the RCM proxy.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the RCM proxy.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, "RecoveryPlan": { "description": "Recovery plan details.", "type": "object", @@ -14802,6 +16488,36 @@ }, "x-ms-discriminator-value": "InMage" }, + "RecoveryPlanInMageRcmFailoverInput": { + "description": "Recovery plan InMageRcm failover input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPlanProviderSpecificFailoverInput" + } + ], + "properties": { + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "Latest", + "LatestApplicationConsistent", + "LatestCrashConsistent", + "LatestProcessed" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPlanPointType", + "modelAsString": true + } + }, + "useMultiVmSyncPoint": { + "description": "A value indicating whether multi VM sync enabled VMs should use multi VM sync points for failover.", + "type": "string" + } + }, + "x-ms-discriminator-value": "InMageRcm" + }, "RecoveryPlanManualActionDetails": { "description": "Recovery plan manual action details.", "type": "object", @@ -15418,6 +17134,56 @@ } } }, + "ReplicationAgentDetails": { + "description": "Replication agent details.", + "type": "object", + "properties": { + "id": { + "description": "The replication agent Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The replication agent name.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The replication agent version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the replication agent.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the replication agent.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, "ReplicationEligibilityResults": { "description": "Replication eligibility results response model.", "type": "object", @@ -15728,6 +17494,56 @@ }, "discriminator": "instanceType" }, + "ReprotectAgentDetails": { + "description": "Reprotect agent details.", + "type": "object", + "properties": { + "id": { + "description": "The reprotect agent Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The reprotect agent name.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version.", + "type": "string", + "readOnly": true + }, + "lastHeartbeatUtc": { + "format": "date-time", + "description": "The last heartbeat received from the reprotect agent.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The health of the reprotect agent.", + "enum": [ + "None", + "Normal", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProtectionHealth", + "modelAsString": true + } + }, + "healthErrors": { + "description": "The health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + } + } + }, "ResolveHealthError": { "description": "Resolve health errors input properties.", "type": "object", @@ -16365,21 +18181,21 @@ } }, "TestFailoverInput": { - "description": "Input definition for planned failover.", + "description": "Input definition for test failover.", "type": "object", "properties": { "properties": { "$ref": "#/definitions/TestFailoverInputProperties", - "description": "Planned failover input properties" + "description": "test failover input properties" } } }, "TestFailoverInputProperties": { - "description": "Input definition for planned failover input properties.", + "description": "Input definition for test failover input properties.", "type": "object", "properties": { "failoverDirection": { - "description": "Failover direction.", + "description": "Test failover direction.", "type": "string" }, "networkType": { @@ -16395,7 +18211,7 @@ "type": "string" }, "providerSpecificDetails": { - "$ref": "#/definitions/ProviderSpecificFailoverInput", + "$ref": "#/definitions/TestFailoverProviderSpecificInput", "description": "Provider specific settings" } } @@ -16439,6 +18255,17 @@ }, "x-ms-discriminator-value": "TestFailoverJobDetails" }, + "TestFailoverProviderSpecificInput": { + "description": "Provider specific test failover input.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, "TestMigrateCleanupInput": { "description": "Input for test migrate cleanup.", "required": [ @@ -16503,17 +18330,17 @@ "discriminator": "instanceType" }, "UnplannedFailoverInput": { - "description": "Input definition for planned failover.", + "description": "Input definition for unplanned failover.", "type": "object", "properties": { "properties": { "$ref": "#/definitions/UnplannedFailoverInputProperties", - "description": "Planned failover input properties" + "description": "Unplanned failover input properties." } } }, "UnplannedFailoverInputProperties": { - "description": "Input definition for planned failover input properties.", + "description": "Input definition for unplanned failover input properties.", "type": "object", "properties": { "failoverDirection": { @@ -16525,11 +18352,22 @@ "type": "string" }, "providerSpecificDetails": { - "$ref": "#/definitions/ProviderSpecificFailoverInput", + "$ref": "#/definitions/UnplannedFailoverProviderSpecificInput", "description": "Provider specific settings" } } }, + "UnplannedFailoverProviderSpecificInput": { + "description": "Provider specific unplanned failover input.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, "UpdateMigrationItemInput": { "description": "Update migration item input.", "type": "object", From 1b98adc8dfe2ae3b6dd31c46104008f7923b7440 Mon Sep 17 00:00:00 2001 From: paornela <70660621+paornela@users.noreply.github.com> Date: Tue, 15 Sep 2020 20:20:50 -0700 Subject: [PATCH 069/164] [Hub Generated] Review request for Microsoft.CostManagement to add version stable/2019-11-01 (#10699) * Created Separate Swagger for Exports * add exports swagger to readme.md --- .../2019-11-01/costmanagement.exports.json | 951 ++++++++++++++++++ .../stable/2019-11-01/costmanagement.json | 602 ----------- .../resource-manager/readme.md | 1 + 3 files changed, 952 insertions(+), 602 deletions(-) create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/costmanagement.exports.json diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/costmanagement.exports.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/costmanagement.exports.json new file mode 100644 index 000000000000..00b0485fcc45 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/costmanagement.exports.json @@ -0,0 +1,951 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-11-01", + "title": "CostManagementClient" + }, + "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": { + "/{scope}/providers/Microsoft.CostManagement/exports": { + "get": { + "tags": [ + "Exports" + ], + "operationId": "Exports_List", + "description": "The operation to list all exports at the given scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionExportList": { + "$ref": "./examples/ExportListBySubscription.json" + }, + "ResourceGroupExportList": { + "$ref": "./examples/ExportListByResourceGroup.json" + }, + "BillingAccountExportList": { + "$ref": "./examples/ExportListByBillingAccount.json" + }, + "DepartmentExportList": { + "$ref": "./examples/ExportListByDepartment.json" + }, + "EnrollmentAccountExportList": { + "$ref": "./examples/ExportListByEnrollmentAccount.json" + }, + "ManagementGroupExportList": { + "$ref": "./examples/ExportListByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ExportListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}": { + "get": { + "tags": [ + "Exports" + ], + "operationId": "Exports_Get", + "description": "The operation to get the export for the defined scope by export name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionExport": { + "$ref": "./examples/ExportBySubscription.json" + }, + "ResourceGroupExport": { + "$ref": "./examples/ExportByResourceGroup.json" + }, + "BillingAccountExport": { + "$ref": "./examples/ExportByBillingAccount.json" + }, + "DepartmentExport": { + "$ref": "./examples/ExportByDepartment.json" + }, + "EnrollmentAccountExport": { + "$ref": "./examples/ExportByEnrollmentAccount.json" + }, + "ManagementGroupExport": { + "$ref": "./examples/ExportByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Export" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Exports" + ], + "operationId": "Exports_CreateOrUpdate", + "description": "The operation to create or update a export. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionCreateOrUpdateExport": { + "$ref": "./examples/ExportCreateOrUpdateBySubscription.json" + }, + "ResourceGroupCreateOrUpdateExport": { + "$ref": "./examples/ExportCreateOrUpdateByResourceGroup.json" + }, + "BillingAccountCreateOrUpdateExport": { + "$ref": "./examples/ExportCreateOrUpdateByBillingAccount.json" + }, + "DepartmentCreateOrUpdateExport": { + "$ref": "./examples/ExportCreateOrUpdateByDepartment.json" + }, + "EnrollmentAccountCreateOrUpdateExport": { + "$ref": "./examples/ExportCreateOrUpdateByEnrollmentAccount.json" + }, + "ManagementGroupCreateOrUpdateExport": { + "$ref": "./examples/ExportCreateOrUpdateByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Export" + }, + "description": "Parameters supplied to the CreateOrUpdate Export operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Export" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/Export" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Exports" + ], + "operationId": "Exports_Delete", + "description": "The operation to delete a export.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionDeleteExport": { + "$ref": "./examples/ExportDeleteBySubscription.json" + }, + "ResourceGroupDeleteExport": { + "$ref": "./examples/ExportDeleteByResourceGroup.json" + }, + "BillingAccountDeleteExport": { + "$ref": "./examples/ExportDeleteByBillingAccount.json" + }, + "EnrollmentAccountDeleteExport": { + "$ref": "./examples/ExportDeleteByEnrollmentAccount.json" + }, + "DepartmentDeleteExport": { + "$ref": "./examples/ExportDeleteByDepartment.json" + }, + "ManagementGroupDeleteExport": { + "$ref": "./examples/ExportDeleteByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run": { + "post": { + "tags": [ + "Exports" + ], + "operationId": "Exports_Execute", + "description": "The operation to execute a export.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionExecuteExport": { + "$ref": "./examples/ExportExecutionBySubscription.json" + }, + "ResourceGroupExecuteExport": { + "$ref": "./examples/ExportExecutionByResourceGroup.json" + }, + "BillingAccountExecuteExport": { + "$ref": "./examples/ExportExecutionByBillingAccount.json" + }, + "DepartmentExecuteExport": { + "$ref": "./examples/ExportExecutionByDepartment.json" + }, + "EnrollmentAccountExecuteExport": { + "$ref": "./examples/ExportExecutionByEnrollmentAccount.json" + }, + "ManagementGroupExecuteExport": { + "$ref": "./examples/ExportExecutionByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory": { + "get": { + "tags": [ + "Exports" + ], + "operationId": "Exports_GetExecutionHistory", + "description": "The operation to get the execution history of an export for the defined scope by export name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionExecutionHistoryExport": { + "$ref": "./examples/ExportExecutionListBySubscription.json" + }, + "ResourceGroupExecutionHistoryExport": { + "$ref": "./examples/ExportExecutionListByResourceGroup.json" + }, + "BillingAccountExecutionHistoryExport": { + "$ref": "./examples/ExportExecutionListByBillingAccount.json" + }, + "DepartmentExecutionHistoryExport": { + "$ref": "./examples/ExportExecutionListByDepartment.json" + }, + "EnrollmentAccountExecutionHistoryExport": { + "$ref": "./examples/ExportExecutionListByEnrollmentAccount.json" + }, + "ManagementGroupExecutionHistoryExport": { + "$ref": "./examples/ExportExecutionListByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ExportExecutionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ErrorDetails": { + "description": "The details of the error.", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + } + } + }, + "ErrorResponse": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. \n\nSome Error responses: \n\n * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the \"x-ms-ratelimit-microsoft.consumption-retry-after\" header. \n\n * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the \"Retry-After\" header.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "Resource": { + "description": "The Resource model definition.", + "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." + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "x-ms-azure-resource": true + }, + "QueryDefinition": { + "description": "The definition of a query.", + "properties": { + "type": { + "description": "The type of the query.", + "type": "string", + "enum": [ + "Usage", + "ActualCost", + "AmortizedCost" + ], + "x-ms-enum": { + "name": "ExportType", + "modelAsString": true + } + }, + "timeframe": { + "description": "The time frame for pulling data for the query. If custom, then a specific time period must be provided.", + "type": "string", + "enum": [ + "MonthToDate", + "BillingMonthToDate", + "TheLastMonth", + "TheLastBillingMonth", + "WeekToDate", + "Custom" + ], + "x-ms-enum": { + "name": "TimeframeType", + "modelAsString": true + } + }, + "timePeriod": { + "description": "Has time period for pulling data for the query.", + "$ref": "#/definitions/QueryTimePeriod" + }, + "dataset": { + "description": "Has definition for data in this query.", + "$ref": "#/definitions/QueryDataset" + } + }, + "required": [ + "type", + "timeframe" + ] + }, + "QueryTimePeriod": { + "description": "The start and end date for pulling data for the query.", + "properties": { + "from": { + "description": "The start date to pull data from.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date to pull data to.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from", + "to" + ] + }, + "QueryDataset": { + "description": "The definition of data present in the query.", + "properties": { + "granularity": { + "description": "The granularity of rows in the query.", + "type": "string", + "enum": [ + "Daily" + ], + "x-ms-enum": { + "name": "GranularityType", + "modelAsString": true + } + }, + "configuration": { + "description": "Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided.", + "$ref": "#/definitions/QueryDatasetConfiguration" + }, + "aggregation": { + "type": "object", + "description": "Dictionary of aggregation expression to use in the query. The key of each item in the dictionary is the alias for the aggregated column. Query can have up to 2 aggregation clauses.", + "additionalProperties": { + "type": "object", + "$ref": "#/definitions/QueryAggregation" + }, + "maxItems": 2 + }, + "grouping": { + "description": "Array of group by expression to use in the query. Query can have up to 2 group by clauses.", + "type": "array", + "items": { + "$ref": "#/definitions/QueryGrouping" + }, + "maxItems": 2 + }, + "filter": { + "type": "object", + "description": "Has filter expression to use in the query.", + "$ref": "#/definitions/QueryFilter" + } + } + }, + "QueryDatasetConfiguration": { + "description": "The configuration of dataset in the query.", + "properties": { + "columns": { + "description": "Array of column names to be included in the query. Any valid query column name is allowed. If not provided, then query includes all columns.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "QueryAggregation": { + "description": "The aggregation expression to be used in the query.", + "properties": { + "name": { + "description": "The name of the column to aggregate.", + "type": "string" + }, + "function": { + "description": "The name of the aggregation function to use.", + "type": "string", + "enum": [ + "Sum" + ], + "x-ms-enum": { + "name": "FunctionType", + "modelAsString": true + } + } + }, + "required": [ + "name", + "function" + ] + }, + "QueryGrouping": { + "description": "The group by expression to be used in the query.", + "properties": { + "type": { + "description": "Has type of the column to group.", + "$ref": "#/definitions/QueryColumnType" + }, + "name": { + "description": "The name of the column to group.", + "type": "string" + } + }, + "required": [ + "type", + "name" + ] + }, + "QueryFilter": { + "description": "The filter expression to be used in the export.", + "properties": { + "and": { + "description": "The logical \"AND\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/QueryFilter" + }, + "minItems": 2 + }, + "or": { + "description": "The logical \"OR\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/QueryFilter" + }, + "minItems": 2 + }, + "not": { + "description": "The logical \"NOT\" expression.", + "$ref": "#/definitions/QueryFilter" + }, + "dimension": { + "description": "Has comparison expression for a dimension", + "$ref": "#/definitions/QueryComparisonExpression" + }, + "tag": { + "description": "Has comparison expression for a tag", + "$ref": "#/definitions/QueryComparisonExpression" + } + } + }, + "QueryColumnType": { + "description": "The type of the column in the export.", + "type": "string", + "enum": [ + "Tag", + "Dimension" + ], + "x-ms-enum": { + "name": "QueryColumnType", + "modelAsString": true + } + }, + "QueryComparisonExpression": { + "description": "The comparison expression to be used in the query.", + "properties": { + "name": { + "description": "The name of the column to use in comparison.", + "type": "string" + }, + "operator": { + "description": "The operator to use for comparison.", + "type": "string", + "enum": [ + "In" + ], + "x-ms-enum": { + "name": "OperatorType", + "modelAsString": true + } + }, + "values": { + "description": "Array of values to use for comparison", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "name", + "operator", + "values" + ] + }, + "ExportListResult": { + "description": "Result of listing exports. It contains a list of available exports in the scope provided.", + "properties": { + "value": { + "description": "The list of exports.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Export" + } + } + } + }, + "Export": { + "description": "A export resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExportProperties", + "title": "Export properties" + } + } + }, + "ExportProperties": { + "description": "The properties of the export.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CommonExportProperties" + } + ], + "properties": { + "schedule": { + "description": "Has schedule information for the export.", + "$ref": "#/definitions/ExportSchedule" + } + } + }, + "CommonExportProperties": { + "description": "The common properties of the export.", + "properties": { + "format": { + "description": "The format of the export being delivered.", + "type": "string", + "enum": [ + "Csv" + ], + "x-ms-enum": { + "name": "FormatType", + "modelAsString": true + } + }, + "deliveryInfo": { + "description": "Has delivery information for the export.", + "$ref": "#/definitions/ExportDeliveryInfo" + }, + "definition": { + "description": "Has definition for the export.", + "$ref": "#/definitions/QueryDefinition" + } + }, + "required": [ + "deliveryInfo", + "definition" + ] + }, + "ExportSchedule": { + "description": "The schedule associated with a export.", + "properties": { + "status": { + "description": "The status of the schedule. Whether active or not. If inactive, the export's scheduled execution is paused.", + "type": "string", + "enum": [ + "Active", + "Inactive" + ], + "x-ms-enum": { + "name": "StatusType", + "modelAsString": true + } + }, + "recurrence": { + "description": "The schedule recurrence.", + "type": "string", + "enum": [ + "Daily", + "Weekly", + "Monthly", + "Annually" + ], + "x-ms-enum": { + "name": "RecurrenceType", + "modelAsString": true + } + }, + "recurrencePeriod": { + "description": "Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date.", + "$ref": "#/definitions/ExportRecurrencePeriod" + } + }, + "required": [ + "recurrence" + ] + }, + "ExportDeliveryInfo": { + "description": "The delivery information associated with a export.", + "properties": { + "destination": { + "description": "Has destination for the export being delivered.", + "$ref": "#/definitions/ExportDeliveryDestination" + } + }, + "required": [ + "destination" + ] + }, + "ExportRecurrencePeriod": { + "description": "The start and end date for recurrence schedule.", + "properties": { + "from": { + "description": "The start date of recurrence.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date of recurrence.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from" + ] + }, + "ExportDeliveryDestination": { + "description": "The destination information for the delivery of the export. To allow access to a storage account, you must register the account's subscription with the Microsoft.CostManagementExports resource provider. This is required once per subscription. When creating an export in the Azure portal, it is done automatically, however API users need to register the subscription. For more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services .", + "properties": { + "resourceId": { + "description": "The resource id of the storage account where exports will be delivered.", + "type": "string" + }, + "container": { + "description": "The name of the container where exports will be uploaded.", + "type": "string" + }, + "rootFolderPath": { + "description": "The name of the directory where exports will be uploaded.", + "type": "string" + } + }, + "required": [ + "resourceId", + "container" + ] + }, + "ExportExecutionListResult": { + "description": "Result of listing exports execution history of a export by name", + "properties": { + "value": { + "description": "The list of export executions.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ExportExecution" + } + } + } + }, + "ExportExecution": { + "description": "A export execution.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExportExecutionProperties", + "title": "Export execution properties" + } + } + }, + "ExportExecutionProperties": { + "description": "The properties of the export execution.", + "properties": { + "executionType": { + "description": "The type of the export execution.", + "type": "string", + "enum": [ + "OnDemand", + "Scheduled" + ], + "x-ms-enum": { + "name": "ExecutionType", + "modelAsString": true + } + }, + "status": { + "description": "The status of the export execution.", + "type": "string", + "enum": [ + "Queued", + "InProgress", + "Completed", + "Failed", + "Timeout", + "NewDataNotAvailable", + "DataNotAvailable" + ], + "x-ms-enum": { + "name": "ExecutionStatus", + "modelAsString": true + } + }, + "submittedBy": { + "description": "The identifier for the entity that executed the export. For OnDemand executions, it is the email id. For Scheduled executions, it is the constant value - System.", + "type": "string" + }, + "submittedTime": { + "description": "The time when export was queued to be executed.", + "type": "string", + "format": "date-time" + }, + "processingStartTime": { + "description": "The time when export was picked up to be executed.", + "type": "string", + "format": "date-time" + }, + "processingEndTime": { + "description": "The time when export execution finished.", + "type": "string", + "format": "date-time" + }, + "fileName": { + "description": "The name of the file export got written to.", + "type": "string" + }, + "runSettings": { + "$ref": "#/definitions/CommonExportProperties" + } + } + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. The current version is 2019-11-01." + }, + "exportNameParameter": { + "name": "exportName", + "in": "path", + "description": "Export Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "scopeQueryParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with query and export operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/costmanagement.json index 2f0fc9a8dc97..16f9d8c22663 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/costmanagement.json @@ -1098,350 +1098,6 @@ } } }, - "/{scope}/providers/Microsoft.CostManagement/exports": { - "get": { - "tags": [ - "Exports" - ], - "operationId": "Exports_List", - "description": "The operation to list all exports at the given scope.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "SubscriptionExportList": { - "$ref": "./examples/ExportListBySubscription.json" - }, - "ResourceGroupExportList": { - "$ref": "./examples/ExportListByResourceGroup.json" - }, - "BillingAccountExportList": { - "$ref": "./examples/ExportListByBillingAccount.json" - }, - "DepartmentExportList": { - "$ref": "./examples/ExportListByDepartment.json" - }, - "EnrollmentAccountExportList": { - "$ref": "./examples/ExportListByEnrollmentAccount.json" - }, - "ManagementGroupExportList": { - "$ref": "./examples/ExportListByManagementGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeQueryParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/ExportListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}": { - "get": { - "tags": [ - "Exports" - ], - "operationId": "Exports_Get", - "description": "The operation to get the export for the defined scope by export name.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "SubscriptionExport": { - "$ref": "./examples/ExportBySubscription.json" - }, - "ResourceGroupExport": { - "$ref": "./examples/ExportByResourceGroup.json" - }, - "BillingAccountExport": { - "$ref": "./examples/ExportByBillingAccount.json" - }, - "DepartmentExport": { - "$ref": "./examples/ExportByDepartment.json" - }, - "EnrollmentAccountExport": { - "$ref": "./examples/ExportByEnrollmentAccount.json" - }, - "ManagementGroupExport": { - "$ref": "./examples/ExportByManagementGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeQueryParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/exportNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/Export" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Exports" - ], - "operationId": "Exports_CreateOrUpdate", - "description": "The operation to create or update a export. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "SubscriptionCreateOrUpdateExport": { - "$ref": "./examples/ExportCreateOrUpdateBySubscription.json" - }, - "ResourceGroupCreateOrUpdateExport": { - "$ref": "./examples/ExportCreateOrUpdateByResourceGroup.json" - }, - "BillingAccountCreateOrUpdateExport": { - "$ref": "./examples/ExportCreateOrUpdateByBillingAccount.json" - }, - "DepartmentCreateOrUpdateExport": { - "$ref": "./examples/ExportCreateOrUpdateByDepartment.json" - }, - "EnrollmentAccountCreateOrUpdateExport": { - "$ref": "./examples/ExportCreateOrUpdateByEnrollmentAccount.json" - }, - "ManagementGroupCreateOrUpdateExport": { - "$ref": "./examples/ExportCreateOrUpdateByManagementGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeQueryParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/exportNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Export" - }, - "description": "Parameters supplied to the CreateOrUpdate Export operation." - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/Export" - } - }, - "201": { - "description": "Created.", - "schema": { - "$ref": "#/definitions/Export" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Exports" - ], - "operationId": "Exports_Delete", - "description": "The operation to delete a export.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "SubscriptionDeleteExport": { - "$ref": "./examples/ExportDeleteBySubscription.json" - }, - "ResourceGroupDeleteExport": { - "$ref": "./examples/ExportDeleteByResourceGroup.json" - }, - "BillingAccountDeleteExport": { - "$ref": "./examples/ExportDeleteByBillingAccount.json" - }, - "EnrollmentAccountDeleteExport": { - "$ref": "./examples/ExportDeleteByEnrollmentAccount.json" - }, - "DepartmentDeleteExport": { - "$ref": "./examples/ExportDeleteByDepartment.json" - }, - "ManagementGroupDeleteExport": { - "$ref": "./examples/ExportDeleteByManagementGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeQueryParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/exportNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run": { - "post": { - "tags": [ - "Exports" - ], - "operationId": "Exports_Execute", - "description": "The operation to execute a export.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "SubscriptionExecuteExport": { - "$ref": "./examples/ExportExecutionBySubscription.json" - }, - "ResourceGroupExecuteExport": { - "$ref": "./examples/ExportExecutionByResourceGroup.json" - }, - "BillingAccountExecuteExport": { - "$ref": "./examples/ExportExecutionByBillingAccount.json" - }, - "DepartmentExecuteExport": { - "$ref": "./examples/ExportExecutionByDepartment.json" - }, - "EnrollmentAccountExecuteExport": { - "$ref": "./examples/ExportExecutionByEnrollmentAccount.json" - }, - "ManagementGroupExecuteExport": { - "$ref": "./examples/ExportExecutionByManagementGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeQueryParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/exportNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory": { - "get": { - "tags": [ - "Exports" - ], - "operationId": "Exports_GetExecutionHistory", - "description": "The operation to get the execution history of an export for the defined scope by export name.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "SubscriptionExecutionHistoryExport": { - "$ref": "./examples/ExportExecutionListBySubscription.json" - }, - "ResourceGroupExecutionHistoryExport": { - "$ref": "./examples/ExportExecutionListByResourceGroup.json" - }, - "BillingAccountExecutionHistoryExport": { - "$ref": "./examples/ExportExecutionListByBillingAccount.json" - }, - "DepartmentExecutionHistoryExport": { - "$ref": "./examples/ExportExecutionListByDepartment.json" - }, - "EnrollmentAccountExecutionHistoryExport": { - "$ref": "./examples/ExportExecutionListByEnrollmentAccount.json" - }, - "ManagementGroupExecutionHistoryExport": { - "$ref": "./examples/ExportExecutionListByManagementGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeQueryParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/exportNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/ExportExecutionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, "/providers/Microsoft.CostManagement/operations": { "get": { "tags": [ @@ -2741,256 +2397,6 @@ "operator", "values" ] - }, - "ExportListResult": { - "description": "Result of listing exports. It contains a list of available exports in the scope provided.", - "properties": { - "value": { - "description": "The list of exports.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Export" - } - } - } - }, - "Export": { - "description": "A export resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ExportProperties", - "title": "Export properties" - } - } - }, - "ExportProperties": { - "description": "The properties of the export.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CommonExportProperties" - } - ], - "properties": { - "schedule": { - "description": "Has schedule information for the export.", - "$ref": "#/definitions/ExportSchedule" - } - } - }, - "CommonExportProperties": { - "description": "The common properties of the export.", - "properties": { - "format": { - "description": "The format of the export being delivered.", - "type": "string", - "enum": [ - "Csv" - ], - "x-ms-enum": { - "name": "FormatType", - "modelAsString": true - } - }, - "deliveryInfo": { - "description": "Has delivery information for the export.", - "$ref": "#/definitions/ExportDeliveryInfo" - }, - "definition": { - "description": "Has definition for the export.", - "$ref": "#/definitions/QueryDefinition" - } - }, - "required": [ - "deliveryInfo", - "definition" - ] - }, - "ExportSchedule": { - "description": "The schedule associated with a export.", - "properties": { - "status": { - "description": "The status of the schedule. Whether active or not. If inactive, the export's scheduled execution is paused.", - "type": "string", - "enum": [ - "Active", - "Inactive" - ], - "x-ms-enum": { - "name": "StatusType", - "modelAsString": true - } - }, - "recurrence": { - "description": "The schedule recurrence.", - "type": "string", - "enum": [ - "Daily", - "Weekly", - "Monthly", - "Annually" - ], - "x-ms-enum": { - "name": "RecurrenceType", - "modelAsString": true - } - }, - "recurrencePeriod": { - "description": "Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date.", - "$ref": "#/definitions/ExportRecurrencePeriod" - } - }, - "required": [ - "recurrence" - ] - }, - "ExportDeliveryInfo": { - "description": "The delivery information associated with a export.", - "properties": { - "destination": { - "description": "Has destination for the export being delivered.", - "$ref": "#/definitions/ExportDeliveryDestination" - } - }, - "required": [ - "destination" - ] - }, - "ExportRecurrencePeriod": { - "description": "The start and end date for recurrence schedule.", - "properties": { - "from": { - "description": "The start date of recurrence.", - "type": "string", - "format": "date-time" - }, - "to": { - "description": "The end date of recurrence.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "from" - ] - }, - "ExportDeliveryDestination": { - "description": "The destination information for the delivery of the export. To allow access to a storage account, you must register the account's subscription with the Microsoft.CostManagementExports resource provider. This is required once per subscription. When creating an export in the Azure portal, it is done automatically, however API users need to register the subscription. For more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services .", - "properties": { - "resourceId": { - "description": "The resource id of the storage account where exports will be delivered.", - "type": "string" - }, - "container": { - "description": "The name of the container where exports will be uploaded.", - "type": "string" - }, - "rootFolderPath": { - "description": "The name of the directory where exports will be uploaded.", - "type": "string" - } - }, - "required": [ - "resourceId", - "container" - ] - }, - "ExportExecutionListResult": { - "description": "Result of listing exports execution history of a export by name", - "properties": { - "value": { - "description": "The list of export executions.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ExportExecution" - } - } - } - }, - "ExportExecution": { - "description": "A export execution.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ExportExecutionProperties", - "title": "Export execution properties" - } - } - }, - "ExportExecutionProperties": { - "description": "The properties of the export execution.", - "properties": { - "executionType": { - "description": "The type of the export execution.", - "type": "string", - "enum": [ - "OnDemand", - "Scheduled" - ], - "x-ms-enum": { - "name": "ExecutionType", - "modelAsString": true - } - }, - "status": { - "description": "The status of the export execution.", - "type": "string", - "enum": [ - "Queued", - "InProgress", - "Completed", - "Failed", - "Timeout", - "NewDataNotAvailable", - "DataNotAvailable" - ], - "x-ms-enum": { - "name": "ExecutionStatus", - "modelAsString": true - } - }, - "submittedBy": { - "description": "The identifier for the entity that executed the export. For OnDemand executions, it is the email id. For Scheduled executions, it is the constant value - System.", - "type": "string" - }, - "submittedTime": { - "description": "The time when export was queued to be executed.", - "type": "string", - "format": "date-time" - }, - "processingStartTime": { - "description": "The time when export was picked up to be executed.", - "type": "string", - "format": "date-time" - }, - "processingEndTime": { - "description": "The time when export execution finished.", - "type": "string", - "format": "date-time" - }, - "fileName": { - "description": "The name of the file export got written to.", - "type": "string" - }, - "runSettings": { - "$ref": "#/definitions/CommonExportProperties" - } - } } }, "parameters": { @@ -3100,14 +2506,6 @@ "type": "string", "x-ms-parameter-location": "method" }, - "exportNameParameter": { - "name": "exportName", - "in": "path", - "description": "Export Name.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, "externalCloudProviderTypeParameter": { "name": "externalCloudProviderType", "in": "path", diff --git a/specification/cost-management/resource-manager/readme.md b/specification/cost-management/resource-manager/readme.md index 26eb8c98ebb2..66b5c5f7d127 100644 --- a/specification/cost-management/resource-manager/readme.md +++ b/specification/cost-management/resource-manager/readme.md @@ -60,6 +60,7 @@ These settings apply only when `--tag=package-2019-11` is specified on the comma ``` yaml $(tag) == 'package-2019-11' input-file: - Microsoft.CostManagement/stable/2019-11-01/costmanagement.json + - Microsoft.CostManagement/stable/2019-11-01/costmanagement.exports.json ``` ### Tag: package-2019-10 From a79f3b3510ae030976aa1820dfb0b3e63472c769 Mon Sep 17 00:00:00 2001 From: Jorge Baca <58745759+jorgbaca@users.noreply.github.com> Date: Tue, 15 Sep 2020 22:02:34 -0700 Subject: [PATCH 070/164] Bump up version number for "old" preview api (#10768) * WIP: Updating Microsoft.AzureData * Minor changes * Adding new SystemData property to examples * Fixed formatting * Update azuredata.json Fixed systemData. * Update azuredata.json Fixed identitytype case. * Fixed formatting * Removing changes from this PR (suggested by ARM). Will send a different PR to rename properties. * Added optional properties to sqlManagedInstances. Removed optional properties from dataControllers. Marked some properties required for dataControllers. * Ran prettier check * Adding missing parameter * Added new definition for data controller patch model * Fixed parameter * Copying 2019 api to 2020 * Removing EOS examples (and list operation which is not supported) * Remvoing EOS stuff from azuredata.json. Removing operation resource as well * Update postgres details * Update postgres example * Updating api-version in examples * Adding last uploaded date and k8sRaw * Update descriptions * Fix paramters * Add missing bracket * Update readme --- .../preview/2020-09-08-preview/azuredata.json | 1890 +++++++++++++++++ .../CreateOrUpdateDataController.json | 74 + .../CreateOrUpdatePostgresInstance.json | 133 ++ .../CreateOrUpdateSqlManagedInstance.json | 72 + .../CreateOrUpdateSqlServerInstance.json | 79 + .../examples/DeleteDataController.json | 12 + .../examples/DeletePostgresInstance.json | 12 + .../examples/DeleteSqlManagedInstance.json | 12 + .../examples/DeleteSqlServerInstance.json | 12 + .../examples/GetDataController.json | 36 + .../examples/GetPostgresInstance.json | 30 + .../examples/GetSqlManagedInstance.json | 35 + .../examples/GetSqlServerInstance.json | 38 + .../ListByResourceGroupDataController.json | 63 + .../ListByResourceGroupPostgresInstance.json | 51 + ...ListByResourceGroupSqlManagedInstance.json | 61 + .../ListByResourceGroupSqlServerInstance.json | 67 + .../ListSubscriptionDataController.json | 62 + .../ListSubscriptionPostgresInstance.json | 50 + .../ListSubscriptionSqlManagedInstance.json | 60 + .../ListSubscriptionSqlServerInstance.json | 66 + .../examples/UpdateDataController.json | 41 + .../examples/UpdatePostgresInstance.json | 35 + .../examples/UpdateSqlManagedInstance.json | 37 + .../examples/UpdateSqlServerInstance.json | 40 + .../azuredata/resource-manager/readme.md | 8 + 26 files changed, 3076 insertions(+) create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/azuredata.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/CreateOrUpdateDataController.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/CreateOrUpdatePostgresInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/CreateOrUpdateSqlManagedInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/CreateOrUpdateSqlServerInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/DeleteDataController.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/DeletePostgresInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/DeleteSqlManagedInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/DeleteSqlServerInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/GetDataController.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/GetPostgresInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/GetSqlManagedInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/GetSqlServerInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListByResourceGroupDataController.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListByResourceGroupPostgresInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListByResourceGroupSqlManagedInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListByResourceGroupSqlServerInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListSubscriptionDataController.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListSubscriptionPostgresInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListSubscriptionSqlManagedInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListSubscriptionSqlServerInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/UpdateDataController.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/UpdatePostgresInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/UpdateSqlManagedInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/UpdateSqlServerInstance.json diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/azuredata.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/azuredata.json new file mode 100644 index 000000000000..ab1d98d88c50 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/azuredata.json @@ -0,0 +1,1890 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-09-08-preview", + "title": "AzureDataManagementClient", + "description": "The AzureData management API provides a RESTful set of web APIs to manage Azure Data Resources." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureData/sqlManagedInstances": { + "get": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_List", + "summary": "List sqlManagedInstance resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlManagedInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Instance in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/sqlManagedInstances": { + "get": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_ListByResourceGroup", + "description": "Gets all sqlManagedInstances in a resource group.", + "summary": "List sqlManagedInstance resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlManagedInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Instance in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/sqlManagedInstances/{sqlManagedInstanceName}": { + "get": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Get", + "description": "Retrieves a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlManagedInstanceName", + "description": "Name of SQL Managed Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Updates a SQL Instance tags.": { + "$ref": "./examples/GetSqlManagedInstance.json" + } + } + }, + "put": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Create", + "description": "Creates or replaces a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlManagedInstanceName", + "description": "The name of SQL Managed Instances", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "sqlManagedInstance", + "in": "body", + "description": "The SQL Managed Instance to be created or updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlManagedInstance" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlManagedInstance" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SqlManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or update a SQL Managed Instance": { + "$ref": "./examples/CreateOrUpdateSqlManagedInstance.json" + } + } + }, + "delete": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Delete", + "description": "Deletes a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlManagedInstanceName", + "description": "The name of Sql Managed Instances", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL Managed Instance." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "204": { + "description": "The specified SQL Managed Instance does not exist." + } + }, + "x-ms-examples": { + "Delete a SQL Instance.": { + "$ref": "./examples/DeleteSqlManagedInstance.json" + } + } + }, + "patch": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Update", + "description": "Updates a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlManagedInstanceName", + "description": "Name of sqlManagedInstance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL Managed Instance.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlManagedInstanceUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Updates a sql Instance tags.": { + "$ref": "./examples/UpdateSqlManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureData/sqlServerInstances": { + "get": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_List", + "summary": "List sqlServerInstance resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server Instance in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/sqlServerInstances": { + "get": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_ListByResourceGroup", + "description": "Gets all sqlServerInstances in a resource group.", + "summary": "List sqlServerInstance resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server Instance in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/sqlServerInstances/{sqlServerInstanceName}": { + "get": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Get", + "description": "Retrieves a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlServerInstanceName", + "description": "Name of SQL Server Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server Instance tags.": { + "$ref": "./examples/GetSqlServerInstance.json" + } + } + }, + "put": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Create", + "description": "Creates or replaces a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlServerInstanceName", + "description": "The name of SQL Server Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "sqlServerInstance", + "in": "body", + "description": "The SQL Server Instance to be created or updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlServerInstance" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerInstance" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SqlServerInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server Instance tags.": { + "$ref": "./examples/CreateOrUpdateSqlServerInstance.json" + } + } + }, + "delete": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Delete", + "description": "Deletes a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlServerInstanceName", + "description": "The name of SQL Server Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL Server Instance." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "204": { + "description": "The specified SQL Server Instance does not exist." + } + }, + "x-ms-examples": { + "Delete a SQL Server Instance.": { + "$ref": "./examples/DeleteSqlServerInstance.json" + } + } + }, + "patch": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Update", + "description": "Updates a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlServerInstanceName", + "description": "Name of sqlServerInstance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL Server Instance.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlServerInstanceUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server Instance tags.": { + "$ref": "./examples/UpdateSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureData/postgresInstances": { + "get": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_List", + "summary": "List postgres Instance resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PostgresInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all Postgres Instance in a subscription.": { + "$ref": "./examples/ListSubscriptionPostgresInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/postgresInstances": { + "get": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_ListByResourceGroup", + "description": "Get a postgres Instances list by Resource group name.", + "summary": "List postgres Instance resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PostgresInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all postgres Instances in a resource group.": { + "$ref": "./examples/ListByResourceGroupPostgresInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/postgresInstances/{postgresInstanceName}": { + "get": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_Get", + "description": "Retrieves a postgres Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "postgresInstanceName", + "description": "Name of Postgres Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PostgresInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets a postgres Instances.": { + "$ref": "./examples/GetPostgresInstance.json" + } + } + }, + "put": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_Create", + "description": "Creates or replaces a postgres Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "postgresInstanceName", + "description": "Name of PostgresInstance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "name": "resource", + "description": "The postgres instance", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/PostgresInstance" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PostgresInstance" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PostgresInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or update a Postgres Instance.": { + "$ref": "./examples/CreateOrUpdatePostgresInstance.json" + } + } + }, + "delete": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_Delete", + "description": "Deletes a postgres Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "postgresInstanceName", + "description": "Name of Postgres Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the Postgres Instance." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "204": { + "description": "The specified Postgres Instance does not exist." + } + }, + "x-ms-examples": { + "Deletes a PostgresInstances.": { + "$ref": "./examples/DeletePostgresInstance.json" + } + } + }, + "patch": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_Update", + "description": "Updates a postgres Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "postgresInstanceName", + "description": "Name of Postgres Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "in": "body", + "description": "The Postgres Instance.", + "required": true, + "schema": { + "$ref": "#/definitions/PostgresInstanceUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PostgresInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Updates a postgres Instances tags.": { + "$ref": "./examples/UpdatePostgresInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureData/dataControllers": { + "get": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_ListInSubscription", + "summary": "List dataController resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PageOfDataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all dataControllers in a subscription.": { + "$ref": "./examples/ListSubscriptionDataController.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/dataControllers": { + "get": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_ListInGroup", + "summary": "List dataController resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PageOfDataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all dataControllers in a resource group.": { + "$ref": "./examples/ListByResourceGroupDataController.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/dataControllers/{dataControllerName}": { + "put": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_PutDataController", + "description": "Creates or replaces a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "dataControllerResource", + "description": "desc", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/DataControllerResource" + } + }, + { + "name": "dataControllerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataControllerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or update a Data Controller.": { + "$ref": "./examples/CreateOrUpdateDataController.json" + } + } + }, + "delete": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_DeleteDataController", + "description": "Deletes a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "dataControllerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the DataController." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "204": { + "description": "The specified DataController does not exist." + } + }, + "x-ms-examples": { + "Delete a dataController.": { + "$ref": "./examples/DeleteDataController.json" + } + } + }, + "get": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_GetDataController", + "description": "Retrieves a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "dataControllerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a data controller.": { + "$ref": "./examples/GetDataController.json" + } + } + }, + "patch": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_PatchDataController", + "description": "Updates a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "dataControllerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "name": "dataControllerResource", + "description": "The update data controller resource", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/DataControllerUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Updates a dataController tags.": { + "$ref": "./examples/UpdateDataController.json" + } + } + } + } + }, + "definitions": { + "Sku": { + "description": "The resource model definition representing SKU", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU. Ex - P3. It is typically a letter+number code" + }, + "tier": { + "type": "string", + "enum": [ + "Free", + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": false + }, + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT." + }, + "size": { + "type": "string", + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " + }, + "family": { + "type": "string", + "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here." + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." + } + }, + "required": [ + "name" + ] + }, + "Identity": { + "description": "Identity for the resource.", + "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" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + } + } + }, + "Plan": { + "properties": { + "name": { + "type": "string", + "description": "A user defined name of the 3rd Party Artifact that is being procured." + }, + "publisher": { + "type": "string", + "description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic" + }, + "product": { + "type": "string", + "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. " + }, + "promotionCode": { + "type": "string", + "description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact." + }, + "version": { + "type": "string", + "description": "The version of the desired product/artifact." + } + }, + "description": "Plan for the resource.", + "required": [ + "name", + "publisher", + "product" + ] + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts." + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "systemData": { + "$ref": "#/definitions/SystemData", + "readOnly": true + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "PageOfDataControllerResource": { + "type": "object", + "properties": { + "value": { + "items": { + "$ref": "#/definitions/DataControllerResource" + }, + "type": "array" + }, + "nextLink": { + "type": "string", + "description": "Link to retrieve next page of results." + } + } + }, + "DataControllerResource": { + "description": "Data controller resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DataControllerProperties", + "description": "The data controller's properties", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ] + }, + "DataControllerUpdate": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "Used for updating a data controller resource." + }, + "SystemData": { + "description": "Read only system data", + "type": "object", + "properties": { + "createdBy": { + "type": "string", + "description": "An identifier for the identity that created the resource" + }, + "createdByType": { + "$ref": "#/definitions/IdentityType", + "description": "The type of identity that created the resource" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)" + }, + "lastModifiedBy": { + "type": "string", + "description": "An identifier for the identity that last modified the resource" + }, + "lastModifiedByType": { + "$ref": "#/definitions/IdentityType", + "description": "The type of identity that last modified the resource" + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)" + } + } + }, + "IdentityType": { + "description": "The type of identity that creates/modifies resources", + "type": "string", + "enum": [ + "user", + "application", + "managedIdentity", + "key" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true + } + }, + "ResourceSku": { + "type": "object", + "properties": { + "capacity": { + "type": "integer", + "format": "int32" + }, + "family": { + "type": "string" + }, + "name": { + "type": "string" + }, + "size": { + "type": "string" + }, + "tier": { + "type": "string" + } + } + }, + "DataControllerProperties": { + "description": "The data controller properties.", + "type": "object", + "properties": { + "onPremiseProperty": { + "$ref": "#/definitions/OnPremiseProperty" + }, + "k8sRaw": { + "type": "object", + "description": "The raw kubernetes information" + }, + "lastUploadedDate": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date from on premise cluster. Defaults to current date time" + } + }, + "required": [ + "onPremiseProperty" + ] + }, + "OnPremiseProperty": { + "description": "Properties from the on premise data controller", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "A globally unique ID identifying the associated on premise cluster" + }, + "publicSigningKey": { + "type": "string", + "description": "Certificate that contains the on premise cluster public key used to verify signing" + }, + "signingCertificateThumbprint": { + "type": "string", + "description": "Unique thumbprint returned to customer to verify the certificate being uploaded" + } + }, + "required": [ + "id", + "publicSigningKey" + ] + }, + "PostgresInstanceProperties": { + "description": "Postgres Instance properties.", + "type": "object", + "properties": { + "dataControllerId": { + "type": "string", + "description": "The data controller id" + }, + "admin": { + "type": "string", + "description": "The instance admin" + }, + "k8sRaw": { + "type": "object", + "description": "The raw kubernetes information" + }, + "lastUploadedDate": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date from on premise cluster. Defaults to current date time" + } + } + }, + "PostgresInstance": { + "description": "A Postgres Instance.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource", + "description": "null" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PostgresInstanceProperties", + "x-ms-client-flatten": true, + "description": "null" + } + } + }, + "PostgresInstanceUpdate": { + "description": "An update to a Postgres Instance.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/PostgresInstanceProperties" + } + } + }, + "PostgresInstanceListResult": { + "description": "A list of PostgresInstance.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/PostgresInstance" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlManagedInstanceProperties": { + "description": "Properties of sqlManagedInstance.", + "type": "object", + "properties": { + "dataControllerId": { + "type": "string", + "description": "null" + }, + "instanceEndpoint": { + "type": "string", + "description": "The on premise instance endpoint" + }, + "admin": { + "type": "string", + "description": "The instance admin user" + }, + "startTime": { + "type": "string", + "description": "The instance start time" + }, + "endTime": { + "type": "string", + "description": "The instance end time" + }, + "vCore": { + "type": "string", + "description": "The instance vCore" + }, + "k8sRaw": { + "type": "object", + "description": "The raw kubernetes information" + }, + "lastUploadedDate": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date from on premise cluster. Defaults to current date time" + } + } + }, + "SqlManagedInstance": { + "description": "A SqlManagedInstance.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlManagedInstanceProperties", + "description": "null", + "x-ms-client-flatten": true + } + } + }, + "SqlManagedInstanceUpdate": { + "description": "An update to a SQL Managed Instance.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SqlManagedInstanceListResult": { + "description": "A list of SqlManagedInstance.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlManagedInstance" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlServerInstanceProperties": { + "description": "Properties of SqlServerInstance.", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "SQL Server version." + }, + "edition": { + "type": "string", + "description": "SQL Server edition." + }, + "containerResourceId": { + "type": "string", + "description": "ARM Resource id of the container resource (Azure Arc for Servers)" + }, + "createTime": { + "type": "string", + "description": "The time when the resource was created.", + "readOnly": true + }, + "updateTime": { + "type": "string", + "description": "The time when the resource was last updated.", + "readOnly": true + }, + "vCore": { + "type": "string", + "description": "The number of logical processors used by the SQL Server instance." + }, + "status": { + "type": "string", + "description": "The cloud connectivity status." + } + }, + "required": [ + "version", + "edition", + "containerResourceId", + "vCore", + "status" + ] + }, + "SqlServerInstance": { + "description": "A SqlServerInstance.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerInstanceProperties", + "description": "null", + "x-ms-client-flatten": true + } + } + }, + "SqlServerInstanceUpdate": { + "description": "An update to a SQL Server Instance.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SqlServerInstanceListResult": { + "description": "A list of SqlServerInstance.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerInstance" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "null" + } + }, + "description": "An error response from the Azure Data service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Batch service." + }, + "ODataError": { + "properties": { + "code": { + "type": "string", + "description": "A language-independent error name." + }, + "message": { + "type": "string", + "description": "The error message." + }, + "target": { + "type": "string", + "description": "The target of the error (for example, the name of the property in error)." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + }, + "description": "The error details." + } + }, + "type": "object", + "description": "Information about an error." + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Azure subscription" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group", + "x-ms-parameter-location": "method" + }, + "location": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure region to use for the request", + "x-ms-parameter-location": "method" + }, + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request" + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API version to use for the request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "PostgresInstanceNameParameter": { + "in": "path", + "name": "postgresInstanceName", + "description": "The name of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlManagedInstanceNameParameter": { + "in": "path", + "name": "sqlManagedInstanceName", + "description": "The name of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlServerInstanceNameParameter": { + "in": "path", + "name": "sqlServerInstanceName", + "description": "The name of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/CreateOrUpdateDataController.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/CreateOrUpdateDataController.json new file mode 100644 index 000000000000..7e6f05d3d656 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/CreateOrUpdateDataController.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "api-version": "2019-09-08-preview", + "dataControllerResource": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate being uploaded" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/dataControllers/testdataController", + "name": "testdataController", + "type": "Microsoft.AzureData/dataControllers" + } + }, + "201": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate being uploaded" + } + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/dataControllers/testdataController", + "name": "testdataController", + "type": "Microsoft.AzureData/dataControllers" + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/CreateOrUpdatePostgresInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/CreateOrUpdatePostgresInstance.json new file mode 100644 index 000000000000..814c5952a8a0 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/CreateOrUpdatePostgresInstance.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "postgresInstanceName": "testpostgresInstance", + "api-version": "2019-09-08-preview", + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "resource": { + "location": "eastus", + "properties": { + "dataControllerId": "dataControllerId", + "admin": "admin", + "k8sRaw": { + "apiVersion": "apiVersion", + "kind": "postgresql-12", + "metadata": { + "creationTimestamp": "2020-08-25T14:55:10Z", + "generation": 1, + "name": "pg1", + "namespace": "test", + "resourceVersion": "527780", + "selfLink": "/apis/arcdata.microsoft.com/v1alpha1/namespaces/test/postgresql-12s/pg1", + "uid": "1111aaaa-ffff-ffff-ffff-99999aaaaaaa" + }, + "spec": { + "backups": { + "deltaMinutes": 3, + "fullMinutes": 10, + "tiers": [ + { + "retention": { + "maximums": [ + "6", + "512MB" + ], + "minimums": [ + "3" + ] + }, + "storage": { + "volumeSize": "1Gi" + } + } + ] + }, + "engine": { + "extensions": [ + { + "name": "citus" + } + ] + }, + "scale": { + "shards": 3 + }, + "scheduling": { + "default": { + "resources": { + "requests": { + "memory": "256Mi" + } + } + } + }, + "service": { + "type": "NodePort" + }, + "storage": { + "data": { + "className": "local-storage", + "size": "5Gi" + }, + "logs": { + "className": "local-storage", + "size": "5Gi" + } + } + }, + "status": { + "externalEndpoint": null, + "readyPods": "4/4", + "state": "Ready" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": {}, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/PostgresInstance/testpostgresInstance", + "name": "testpostgresInstance", + "type": "Microsoft.AzureData/PostgresInstance" + } + }, + "201": { + "body": { + "properties": {}, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/PostgresInstance/testpostgresInstance", + "name": "testsqlregistration", + "type": "Microsoft.AzureData/PostgresInstance" + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/CreateOrUpdateSqlManagedInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/CreateOrUpdateSqlManagedInstance.json new file mode 100644 index 000000000000..ada9ad6f92d1 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/CreateOrUpdateSqlManagedInstance.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2019-09-08-preview", + "sqlManagedInstance": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "properties": { + "instanceEndpoint": "The on premise instance endpoint", + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "instanceEndpoint": "The on premise instance endpoint", + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureData/sqlManagedInstances" + } + }, + "201": { + "body": { + "properties": { + "instanceEndpoint": "The on premise instance endpoint", + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureData/sqlManagedInstances" + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/CreateOrUpdateSqlServerInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/CreateOrUpdateSqlServerInstance.json new file mode 100644 index 000000000000..d518665361be --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/CreateOrUpdateSqlServerInstance.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2019-09-08-preview", + "sqlServerInstance": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "vCore": "4", + "status": "Connected" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "updateTime": "01/01/2020 01:01:01", + "vCore": "4", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureData/SqlServerInstances" + } + }, + "201": { + "body": { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "updateTime": "01/01/2020 01:01:01", + "vCore": "4", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureData/SqlServerInstances" + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/DeleteDataController.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/DeleteDataController.json new file mode 100644 index 000000000000..ab58c52a18e2 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/DeleteDataController.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "api-version": "2019-09-08-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/DeletePostgresInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/DeletePostgresInstance.json new file mode 100644 index 000000000000..9281c59efd2b --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/DeletePostgresInstance.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "postgresInstanceName": "testpostgresInstance", + "api-version": "2019-09-08-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/DeleteSqlManagedInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/DeleteSqlManagedInstance.json new file mode 100644 index 000000000000..f07d23d4e1b0 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/DeleteSqlManagedInstance.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2019-09-08-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/DeleteSqlServerInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/DeleteSqlServerInstance.json new file mode 100644 index 000000000000..1574521ae769 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/DeleteSqlServerInstance.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2019-09-08-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/GetDataController.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/GetDataController.json new file mode 100644 index 000000000000..9f532d270068 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/GetDataController.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "api-version": "2019-09-08-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + } + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/dataControllers/testdataController", + "name": "testdataController", + "type": "Microsoft.AzureData/dataControllers" + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/GetPostgresInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/GetPostgresInstance.json new file mode 100644 index 000000000000..2a13138b39da --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/GetPostgresInstance.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "postgresInstanceName": "testpostgresInstances", + "api-version": "2019-09-08-preview" + }, + "responses": { + "200": { + "body": { + "properties": {}, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/PostgresInstances/testpostgresInstances", + "name": "testpostgresInstances", + "type": "Microsoft.AzureData/PostgresInstances" + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/GetSqlManagedInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/GetSqlManagedInstance.json new file mode 100644 index 000000000000..c580ac6dd1d3 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/GetSqlManagedInstance.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2019-09-08-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "instanceEndpoint": "The on premise instance endpoint", + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureData/sqlManagedInstance" + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/GetSqlServerInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/GetSqlServerInstance.json new file mode 100644 index 000000000000..053724bea5db --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/GetSqlServerInstance.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2019-09-08-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "updateTime": "01/01/2020 01:01:01", + "vCore": "4", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureData/SqlServerInstances" + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListByResourceGroupDataController.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListByResourceGroupDataController.json new file mode 100644 index 000000000000..5328e05743ba --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListByResourceGroupDataController.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2019-09-08-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + } + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/dataControllers/testdataController1", + "name": "testdataController1", + "type": "Microsoft.AzureData/dataControllers" + }, + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + } + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/dataControllers/testdataController2", + "name": "testdataController2", + "type": "Microsoft.AzureData/dataControllers" + } + ] + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListByResourceGroupPostgresInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListByResourceGroupPostgresInstance.json new file mode 100644 index 000000000000..765965efa0b1 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListByResourceGroupPostgresInstance.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2019-09-08-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": {}, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/PostgresInstances/testpostgresInstances1", + "name": "testpostgresInstances1", + "type": "Microsoft.AzureData/PostgresInstances" + }, + { + "properties": {}, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/PostgresInstances/testpostgresInstances2", + "name": "testpostgresInstances2", + "type": "Microsoft.AzureData/PostgresInstances" + } + ] + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListByResourceGroupSqlManagedInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListByResourceGroupSqlManagedInstance.json new file mode 100644 index 000000000000..24ec32460103 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListByResourceGroupSqlManagedInstance.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2019-09-08-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "instanceEndpoint": "The on premise instance endpoint", + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/sqlManagedInstances/sqlManagedInstance1", + "name": "sqlManagedInstances1", + "type": "Microsoft.AzureData/sqlManagedInstances" + }, + { + "properties": { + "instanceEndpoint": "The on premise instance endpoint", + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/sqlManagedInstances/sqlManagedInstance2", + "name": "sqlManagedInstances2", + "type": "Microsoft.AzureData/sqlManagedInstances" + } + ] + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListByResourceGroupSqlServerInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListByResourceGroupSqlServerInstance.json new file mode 100644 index 000000000000..fe367c20dab3 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListByResourceGroupSqlServerInstance.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2019-09-08-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "updateTime": "01/01/2020 01:01:01", + "vCore": "4", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlServerInstances/sqlServerInstance1", + "name": "sqlServerInstance1", + "type": "Microsoft.AzureData/SqlServerInstances" + }, + { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "updateTime": "01/01/2020 01:01:01", + "vCore": "4", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlServerInstances/sqlServerInstance2", + "name": "sqlServerInstance2", + "type": "Microsoft.AzureData/SqlServerInstances" + } + ] + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListSubscriptionDataController.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListSubscriptionDataController.json new file mode 100644 index 000000000000..c5d30225fcf7 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListSubscriptionDataController.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2019-09-08-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + } + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/dataControllers/testdataController1", + "name": "testdataController1", + "type": "Microsoft.AzureData/dataControllers" + }, + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + } + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/dataControllers/testdataController2", + "name": "testdataController2", + "type": "Microsoft.AzureData/dataControllers" + } + ] + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListSubscriptionPostgresInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListSubscriptionPostgresInstance.json new file mode 100644 index 000000000000..cf0d38b56205 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListSubscriptionPostgresInstance.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2019-09-08-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": {}, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/PostgresInstances/testpostgresInstances1", + "name": "testpostgresInstances1", + "type": "Microsoft.AzureData/PostgresInstances" + }, + { + "properties": {}, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/PostgresInstances/testpostgresInstances2", + "name": "testpostgresInstances2", + "type": "Microsoft.AzureData/PostgresInstances" + } + ] + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListSubscriptionSqlManagedInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListSubscriptionSqlManagedInstance.json new file mode 100644 index 000000000000..3efaf7439792 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListSubscriptionSqlManagedInstance.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2019-09-08-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "instanceEndpoint": "The on premise instance endpoint", + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlManagedInstances/sqlManagedInstance1", + "name": "sqlManagedInstances1", + "type": "Microsoft.AzureData/sqlManagedInstances" + }, + { + "properties": { + "instanceEndpoint": "The on premise instance endpoint", + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlManagedInstances/sqlManagedInstance2", + "name": "sqlManagedInstances2", + "type": "Microsoft.AzureData/sqlManagedInstances" + } + ] + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListSubscriptionSqlServerInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListSubscriptionSqlServerInstance.json new file mode 100644 index 000000000000..60074dcbba5b --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/ListSubscriptionSqlServerInstance.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2019-09-08-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "updateTime": "01/01/2020 01:01:01", + "vCore": "4", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlServerInstances/sqlServerInstance1", + "name": "sqlServerInstance1", + "type": "Microsoft.AzureData/SqlServerInstances" + }, + { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "updateTime": "01/01/2020 01:01:01", + "vCore": "4", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlServerInstances/sqlServerInstance2", + "name": "sqlServerInstance2", + "type": "Microsoft.AzureData/SqlServerInstances" + } + ] + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/UpdateDataController.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/UpdateDataController.json new file mode 100644 index 000000000000..f7f27e678d4a --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/UpdateDataController.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController1", + "api-version": "2019-09-08-preview", + "dataControllerResource": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + } + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/dataControllers/testdataController1", + "name": "testdataController1", + "type": "Microsoft.AzureData/dataControllers" + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/UpdatePostgresInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/UpdatePostgresInstance.json new file mode 100644 index 000000000000..f8164922b7d2 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/UpdatePostgresInstance.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "postgresInstanceName": "testpostgresInstance", + "api-version": "2019-09-08-preview", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": {}, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/PostgresInstance/testpostgresInstance", + "name": "testpostgresInstance", + "type": "Microsoft.AzureData/PostgresInstance" + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/UpdateSqlManagedInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/UpdateSqlManagedInstance.json new file mode 100644 index 000000000000..37b42b02040e --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/UpdateSqlManagedInstance.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2019-09-08-preview", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "instanceEndpoint": "The on premise instance endpoint", + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureData/sqlManagedInstances" + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/UpdateSqlServerInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/UpdateSqlServerInstance.json new file mode 100644 index 000000000000..5545f368b407 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2020-09-08-preview/examples/UpdateSqlServerInstance.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2019-09-08-preview", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "updateTime": "01/01/2020 01:01:01", + "vCore": "4", + "status": "Connected" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "user", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "user", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureData/SqlServerInstances" + } + } + } +} diff --git a/specification/azuredata/resource-manager/readme.md b/specification/azuredata/resource-manager/readme.md index 457d75830ec9..be936d04b9ea 100644 --- a/specification/azuredata/resource-manager/readme.md +++ b/specification/azuredata/resource-manager/readme.md @@ -29,6 +29,14 @@ openapi-type: arm tag: package-preview-2019-07 ``` +### Tag: package-preview-2020-09-08 + +These settings apply only when `--tag=package-preview-2020-09-08` is specified on the command line. + +```yaml $(tag) == 'package-preview-2020-09-08' +input-file: + - Microsoft.AzureData/preview/2020-09-08-preview/azuredata.json +``` ### Tag: package-preview-2019-07 From d199ce15b2716c2167aa2b30949640159cfa8d51 Mon Sep 17 00:00:00 2001 From: tamilmani1989 Date: Tue, 15 Sep 2020 22:27:17 -0700 Subject: [PATCH 071/164] updated apispec (#10719) * updated apispec * spell error fix * removed dncappid from response * updated apispec * Added appid and endpoint in response --- .../2020-08-08-preview/DelegatedNetwork.json | 153 +++++++++--------- .../delegatedNetworkControllerListByRG.json | 6 +- .../delegatedNetworkControllerListBySub.json | 5 +- .../examples/delegatedSubnetListByRG.json | 3 +- .../examples/delegatedSubnetListBySub.json | 3 +- .../examples/deleteDelegatedSubnet.json | 2 +- .../examples/getController.json | 6 +- .../examples/getDelegatedSubnet.json | 3 +- .../examples/patchController.json | 23 ++- .../examples/patchDelegatedSubnet.json | 5 +- .../examples/putController.json | 23 ++- .../examples/putDelegatedSubnet.json | 5 +- 12 files changed, 114 insertions(+), 123 deletions(-) diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/DelegatedNetwork.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/DelegatedNetwork.json index 765caf2e42c3..8d03de36a68f 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/DelegatedNetwork.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/DelegatedNetwork.json @@ -744,42 +744,6 @@ }, "x-ms-azure-resource": true }, - "DelegatedSubnetResource": { - "description": "Represents an instance of a DelegatedSubnet resource.", - "type": "object", - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "An identifier that represents the DelegatedSubnet resource." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "The name of the DelegatedSubnet resource." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "The type of the DelegatedSubnet resource.(Microsoft.DelegatedNetwork/delegatedSubnet)" - }, - "location": { - "type": "string", - "description": "Location of the DelegatedSubnet resource." - } - }, - "x-ms-azure-resource": true - }, - "DelegatedSubnetParameters": { - "description": "DelegatedSubnet Parameters", - "type": "object", - "properties": { - "controllerID": { - "type": "string", - "description": "Delegated Network Controller ID" - } - } - }, "DelegatedControllers": { "description": "An array of Delegated controller resources.", "type": "object", @@ -796,36 +760,25 @@ "value" ] }, - "DelegatedSubnetList": { - "description": "An array of Delegated subnets resources.", - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DelegatedSubnet" - }, - "description": "An array of Delegated subnets resources." - } - }, - "required": [ - "value" - ] - }, "ControllerTypeParameters": { "description": "Details of controller type.", "type": "object", "properties": { "controllerType": { "type": "string", - "description": "Type of Delegated controller." - }, - "kubernetesProperties": { - "type": "array", - "description": "properties of kubernetes clusters", - "items": { - "$ref": "#/definitions/KubernetesProperties" + "description": "Type of controller", + "enum": [ + "Kubernetes" + ], + "x-ms-enum": { + "name": "ControllerType", + "modelAsString": true } + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Controller properties", + "$ref": "#/definitions/ControllerInstanceProperties" } } }, @@ -835,7 +788,7 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ControllerProperties", + "$ref": "#/definitions/ControllerResponseProperties", "description": "Properties of the provision operation request." } }, @@ -845,7 +798,7 @@ } ] }, - "ControllerProperties": { + "ControllerResponseProperties": { "description": "Properties of Delegated controller resource.", "type": "object", "properties": { @@ -864,26 +817,18 @@ "readOnly": true, "description": "The current state of dnc controller resource." }, - "type": { - "type": "string", - "description": "Type of dnc controller." - }, - "resourceGuid": { + "dncAppId": { "type": "string", - "description": "Gets or sets resource GUID property of the controller resource." - }, - "dncAppID": { - "type": "string", - "description": "Get controller AAD ID." + "description": "The current state of dnc controller resource." }, "dncEndpoint": { "type": "string", - "description": "Dnc Endpoint url." + "description": "dnc endpoint url that customers can use to connect to" } } }, - "KubernetesProperties": { - "description": "Properties of kubernetes cluster", + "ControllerInstanceProperties": { + "description": "Properties of orchestrator", "type": "object", "properties": { "serverAppID": { @@ -904,13 +849,65 @@ } } }, + "DelegatedSubnetResource": { + "description": "Represents an instance of a DelegatedSubnet resource.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "An identifier that represents the DelegatedSubnet resource." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the DelegatedSubnet resource." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The type of the DelegatedSubnet resource.(Microsoft.DelegatedNetwork/delegatedSubnet)" + }, + "location": { + "type": "string", + "description": "Location of the DelegatedSubnet resource." + } + }, + "x-ms-azure-resource": true + }, + "DelegatedSubnetParameters": { + "description": "DelegatedSubnet Parameters", + "type": "object", + "properties": { + "controllerID": { + "type": "string", + "description": "Delegated Network Controller ARM resource ID" + } + } + }, + "DelegatedSubnetList": { + "description": "An array of Delegated subnets resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DelegatedSubnet" + }, + "description": "An array of Delegated subnets resources." + } + }, + "required": [ + "value" + ] + }, "DelegatedSubnet": { "description": "Delegated subnet details", "type": "object", "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/DelegatedSubnetProperties", + "$ref": "#/definitions/DelegatedSubnetResponseProperties", "description": "Properties of the delegated subnet request" } }, @@ -920,7 +917,7 @@ } ] }, - "DelegatedSubnetProperties": { + "DelegatedSubnetResponseProperties": { "description": "Properties of delegated subnet resource.", "type": "object", "properties": { @@ -938,6 +935,10 @@ }, "readOnly": true, "description": "The current state of delegated subnet resource." + }, + "resourceGuid": { + "type": "string", + "description": "Guid for the resource(delegatedSubnet) created" } } }, diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkControllerListByRG.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkControllerListByRG.json index d3a54ef39f49..4ef9119e545b 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkControllerListByRG.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkControllerListByRG.json @@ -16,10 +16,8 @@ "type": "Microsoft.DelegatedNetwork/controller", "properties": { "state": "Succeeded", - "type": "Kubernetes", - "resourceGuid": "a182cbcf-e8ea-4175-ac2b-ad36a73f9801", - "dncAppID": "ac6192d7-503f-477a-9cfe-4efc3ee2b645", - "dncEndpoint": "https://uscentral.dnc.azure.com/" + "dncAppId": "ac1192d7-503f-477a-9cfe-4efc3ee2bd60", + "dncEndpoint": "https://orch.useast.dnc.azure.com" } } ] diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkControllerListBySub.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkControllerListBySub.json index 05746dacf340..1ea3ec7ab0c8 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkControllerListBySub.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkControllerListBySub.json @@ -15,9 +15,8 @@ "type": "Microsoft.DelegatedNetwork/controller", "properties": { "state": "Succeeded", - "type": "Kubernetes", - "resourceGuid": "a182cbcf-e8ea-4175-ac2b-ad36a73f9801", - "dncAppID": "ac6192d7-503f-477a-9cfe-4efc3ee2b645" + "dncAppId": "ac1192d7-503f-477a-9cfe-4efc3ee2bd60", + "dncEndpoint": "https://orch.useast.dnc.azure.com" } } ] diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListByRG.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListByRG.json index 59125195bac0..3118b8b5b991 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListByRG.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListByRG.json @@ -15,7 +15,8 @@ "name": "delegated1", "type": "Microsoft.DelegatedNetwork/delegatedSubnets", "properties": { - "state": "Succeeded" + "state": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801" } } ] diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListBySub.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListBySub.json index f3f1eca8d07a..eac3db04c096 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListBySub.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListBySub.json @@ -14,7 +14,8 @@ "name": "delegated1", "type": "Microsoft.DelegatedNetwork/delegatedSubnets", "properties": { - "state": "Succeeded" + "state": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801" } } ] diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteDelegatedSubnet.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteDelegatedSubnet.json index df1bd55b9c1a..b1e8c5f1c8bb 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteDelegatedSubnet.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteDelegatedSubnet.json @@ -7,7 +7,7 @@ "resourceName": "delegated1", "api-version": "2020-08-08-preview", "delegatedSubnetParameters": { - "controllerID": "a182cbcf-e8ea-4175-ac2b-ad36a73f9801" + "controllerID": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller" } }, "responses": { diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getController.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getController.json index a14080a78ed4..6fa0fd517f29 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getController.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getController.json @@ -15,10 +15,8 @@ "type": "Microsoft.DelegatedNetwork/controller", "properties": { "state": "Succeeded", - "type": "Kubernetes", - "resourceGuid": "a182cbcf-e8ea-4175-ac2b-ad36a73f9801", - "dncAppID": "ac6192d7-503f-477a-9cfe-4efc3ee2b645", - "dncEndpoint": "https://uscentral.dnc.azure.com/" + "dncAppId": "ac1192d7-503f-477a-9cfe-4efc3ee2bd60", + "dncEndpoint": "https://orch.useast.dnc.azure.com" } } } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getDelegatedSubnet.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getDelegatedSubnet.json index e43f1783eb9f..79100cab522b 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getDelegatedSubnet.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getDelegatedSubnet.json @@ -16,7 +16,8 @@ "name": "delegated1", "type": "Microsoft.DelegatedNetwork/delegatedSubnets", "properties": { - "state": "Succeeded" + "state": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801" } } } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchController.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchController.json index cd5bc1ca436a..629ac7b2f344 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchController.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchController.json @@ -6,14 +6,12 @@ "api-version": "2020-08-08-preview", "controllerParameters": { "controllerType": "Kubernetes", - "kubernetesProperties": [ - { - "serverAppID": "546192d7-503f-477a-9cfe-4efc3ee2b6e1", - "serverTenantID": "da6192d7-503f-477a-9cfe-4efc3ee2b6c3", - "clusterRootCA": "ddsadsad344mfdsfdl", - "apiServerEndpoint": "https://testk8s.cloudapp.net" - } - ] + "properties": { + "serverAppID": "546192d7-503f-477a-9cfe-4efc3ee2b6e1", + "serverTenantID": "da6192d7-503f-477a-9cfe-4efc3ee2b6c3", + "clusterRootCA": "ddsadsad344mfdsfdl", + "apiServerEndpoint": "https://testk8s.cloudapp.net" + } } }, "responses": { @@ -26,10 +24,8 @@ "type": "Microsoft.DelegatedNetwork/controller", "properties": { "state": "Succeeded", - "type": "Kubernetes", - "resourceGuid": "a182cbcf-e8ea-4175-ac2b-ad36a73f9801", - "dncAppID": "ac6192d7-503f-477a-9cfe-4efc3ee2b645", - "dncEndpoint": "https://uscentral.dnc.azure.com/" + "dncAppId": "ac1192d7-503f-477a-9cfe-4efc3ee2bd60", + "dncEndpoint": "https://orch.useast.dnc.azure.com" } } }, @@ -41,8 +37,7 @@ "name": "dnctestcontroller", "type": "Microsoft.DelegatedNetwork/controller", "properties": { - "state": "Provisioning", - "type": "Kubernetes" + "state": "Provisioning" } } } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchDelegatedSubnet.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchDelegatedSubnet.json index 6a4fc4db79ca..9441a459a8d6 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchDelegatedSubnet.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchDelegatedSubnet.json @@ -7,7 +7,7 @@ "resourceName": "delegated1", "api-version": "2020-08-08-preview", "delegatedSubnetParameters": { - "controllerID": "a182cbcf-e8ea-4175-ac2b-ad36a73f9801" + "controllerID": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller" } }, "responses": { @@ -19,7 +19,8 @@ "name": "delegated1", "type": "Microsoft.DelegatedNetwork/delegatedSubnets", "properties": { - "state": "Succeeded" + "state": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801" } } }, diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putController.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putController.json index cd5bc1ca436a..629ac7b2f344 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putController.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putController.json @@ -6,14 +6,12 @@ "api-version": "2020-08-08-preview", "controllerParameters": { "controllerType": "Kubernetes", - "kubernetesProperties": [ - { - "serverAppID": "546192d7-503f-477a-9cfe-4efc3ee2b6e1", - "serverTenantID": "da6192d7-503f-477a-9cfe-4efc3ee2b6c3", - "clusterRootCA": "ddsadsad344mfdsfdl", - "apiServerEndpoint": "https://testk8s.cloudapp.net" - } - ] + "properties": { + "serverAppID": "546192d7-503f-477a-9cfe-4efc3ee2b6e1", + "serverTenantID": "da6192d7-503f-477a-9cfe-4efc3ee2b6c3", + "clusterRootCA": "ddsadsad344mfdsfdl", + "apiServerEndpoint": "https://testk8s.cloudapp.net" + } } }, "responses": { @@ -26,10 +24,8 @@ "type": "Microsoft.DelegatedNetwork/controller", "properties": { "state": "Succeeded", - "type": "Kubernetes", - "resourceGuid": "a182cbcf-e8ea-4175-ac2b-ad36a73f9801", - "dncAppID": "ac6192d7-503f-477a-9cfe-4efc3ee2b645", - "dncEndpoint": "https://uscentral.dnc.azure.com/" + "dncAppId": "ac1192d7-503f-477a-9cfe-4efc3ee2bd60", + "dncEndpoint": "https://orch.useast.dnc.azure.com" } } }, @@ -41,8 +37,7 @@ "name": "dnctestcontroller", "type": "Microsoft.DelegatedNetwork/controller", "properties": { - "state": "Provisioning", - "type": "Kubernetes" + "state": "Provisioning" } } } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putDelegatedSubnet.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putDelegatedSubnet.json index 6a4fc4db79ca..9441a459a8d6 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putDelegatedSubnet.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putDelegatedSubnet.json @@ -7,7 +7,7 @@ "resourceName": "delegated1", "api-version": "2020-08-08-preview", "delegatedSubnetParameters": { - "controllerID": "a182cbcf-e8ea-4175-ac2b-ad36a73f9801" + "controllerID": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller" } }, "responses": { @@ -19,7 +19,8 @@ "name": "delegated1", "type": "Microsoft.DelegatedNetwork/delegatedSubnets", "properties": { - "state": "Succeeded" + "state": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801" } } }, From 942718dc9c1268066c51dee2ab5aebcd18c18726 Mon Sep 17 00:00:00 2001 From: Jorge Cotillo Date: Wed, 16 Sep 2020 00:41:34 -0700 Subject: [PATCH 072/164] added new api version (#10784) --- .../stable/2020-10-01/deploymentScripts.json | 928 ++++++++++++++++++ .../examples/DeploymentScripts_Create.json | 107 ++ ...Scripts_Create_No_UserManagedIdentity.json | 89 ++ ...tScripts_Create_Using_Custom_Aci_Name.json | 116 +++ ..._Create_Using_Existing_StorageAccount.json | 117 +++ .../examples/DeploymentScripts_Delete.json | 45 + .../examples/DeploymentScripts_Get.json | 49 + .../examples/DeploymentScripts_GetLogs.json | 21 + .../DeploymentScripts_GetLogsDefault.json | 17 + ...loymentScripts_GetLogsDefaultWithTail.json | 18 + ...DeploymentScripts_ListByResourceGroup.json | 57 ++ .../DeploymentScripts_ListBySubscription.json | 51 + .../DeploymentScripts_Min_Create.json | 93 ++ .../examples/DeploymentScripts_Update.json | 57 ++ .../resources/resource-manager/readme.md | 12 +- .../resource-manager/readme.python.md | 27 +- 16 files changed, 1797 insertions(+), 7 deletions(-) create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/deploymentScripts.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Create.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Create_No_UserManagedIdentity.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Create_Using_Custom_Aci_Name.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Create_Using_Existing_StorageAccount.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Delete.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Get.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_GetLogs.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_GetLogsDefault.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_GetLogsDefaultWithTail.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_ListByResourceGroup.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_ListBySubscription.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Min_Create.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Update.json diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/deploymentScripts.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/deploymentScripts.json new file mode 100644 index 000000000000..93a79b905a36 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/deploymentScripts.json @@ -0,0 +1,928 @@ +{ + "swagger": "2.0", + "info": { + "title": "DeploymentScriptsClient", + "description": "The APIs listed in this specification can be used to manage Deployment Scripts resource through the Azure Resource Manager.", + "version": "2020-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}": { + "put": { + "tags": [ + "DeploymentScripts" + ], + "operationId": "DeploymentScripts_Create", + "x-ms-long-running-operation": true, + "description": "Creates a deployment script.", + "x-ms-examples": { + "DeploymentScriptsCreate": { + "$ref": "./examples/DeploymentScripts_Create.json" + }, + "DeploymentScriptsCreateNoUserManagedIdentity": { + "$ref": "./examples/DeploymentScripts_Create_No_UserManagedIdentity.json" + }, + "DeploymentScriptsCreate_MinCreate": { + "$ref": "./examples/DeploymentScripts_Min_Create.json" + }, + "DeploymentScriptsCreate_UsingCustomACIName": { + "$ref": "./examples/DeploymentScripts_Create_Using_Custom_Aci_Name.json" + }, + "DeploymentScriptsCreate_UsingExistingStorageAccount": { + "$ref": "./examples/DeploymentScripts_Create_Using_Existing_StorageAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ScriptNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "deploymentScript", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DeploymentScript" + }, + "description": "Deployment script supplied to the operation." + } + ], + "responses": { + "201": { + "description": "Created -- Deployment script created.", + "schema": { + "$ref": "#/definitions/DeploymentScript" + } + }, + "200": { + "description": "OK -- Deployment script is updated.", + "schema": { + "$ref": "#/definitions/DeploymentScript" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/DeploymentScriptsError" + } + } + } + }, + "patch": { + "tags": [ + "DeploymentScripts" + ], + "operationId": "DeploymentScripts_Update", + "description": "Updates deployment script tags with specified values.", + "x-ms-examples": { + "DeploymentScriptsUpdate": { + "$ref": "./examples/DeploymentScripts_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ScriptNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "deploymentScript", + "in": "body", + "schema": { + "$ref": "#/definitions/DeploymentScriptUpdateParameter" + }, + "description": "Deployment script resource with the tags to be updated." + } + ], + "responses": { + "200": { + "description": "OK -- Deployment script tags are updated.", + "schema": { + "$ref": "#/definitions/DeploymentScript" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/DeploymentScriptsError" + } + } + } + }, + "get": { + "tags": [ + "DeploymentScripts" + ], + "operationId": "DeploymentScripts_Get", + "description": "Gets a deployment script with a given name.", + "x-ms-examples": { + "DeploymentScriptsGet": { + "$ref": "./examples/DeploymentScripts_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ScriptNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Returns information about the deployment script.", + "schema": { + "$ref": "#/definitions/DeploymentScript" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/DeploymentScriptsError" + } + } + } + }, + "delete": { + "tags": [ + "DeploymentScripts" + ], + "operationId": "DeploymentScripts_Delete", + "description": "Deletes a deployment script. When operation completes, status code 200 returned without content.", + "x-ms-examples": { + "DeploymentScriptsDelete": { + "$ref": "./examples/DeploymentScripts_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ScriptNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Deployment script deleted." + }, + "204": { + "description": "Deployment script does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/DeploymentScriptsError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentScripts": { + "get": { + "tags": [ + "DeploymentScripts" + ], + "operationId": "DeploymentScripts_ListBySubscription", + "description": "Lists all deployment scripts for a given subscription.", + "x-ms-examples": { + "DeploymentScriptsListBySubscription": { + "$ref": "./examples/DeploymentScripts_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Returns a list of deployment scripts.", + "schema": { + "$ref": "#/definitions/DeploymentScriptListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/DeploymentScriptsError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}/logs": { + "get": { + "tags": [ + "DeploymentScripts" + ], + "operationId": "DeploymentScripts_GetLogs", + "description": "Gets deployment script logs for a given deployment script name.", + "x-ms-examples": { + "DeploymentScriptsGetLogs": { + "$ref": "./examples/DeploymentScripts_GetLogs.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ScriptNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Returns deployment script logs if available.", + "schema": { + "$ref": "#/definitions/ScriptLogsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/DeploymentScriptsError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}/logs/default": { + "get": { + "tags": [ + "DeploymentScripts" + ], + "operationId": "DeploymentScripts_GetLogsDefault", + "description": "Gets deployment script logs for a given deployment script name.", + "x-ms-examples": { + "DeploymentScriptsGetLogs": { + "$ref": "./examples/DeploymentScripts_GetLogsDefault.json" + }, + "DeploymentScriptsGetLogsWithTail": { + "$ref": "./examples/DeploymentScripts_GetLogsDefaultWithTail.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ScriptNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "tail", + "in": "query", + "description": "The number of lines to show from the tail of the deployment script log. Valid value is a positive number up to 1000. If 'tail' is not provided, all available logs are shown up to container instance log capacity of 4mb.", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "OK -- Returns deployment script logs if available.", + "schema": { + "$ref": "#/definitions/ScriptLog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/DeploymentScriptsError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts": { + "get": { + "tags": [ + "DeploymentScripts" + ], + "operationId": "DeploymentScripts_ListByResourceGroup", + "description": "Lists deployments scripts.", + "x-ms-examples": { + "DeploymentScriptsList": { + "$ref": "./examples/DeploymentScripts_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Returns a list of deployment scripts.", + "schema": { + "$ref": "#/definitions/DeploymentScriptListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/DeploymentScriptsError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "DeploymentScript": { + "required": [ + "location", + "kind" + ], + "type": "object", + "description": "Deployment script object.", + "discriminator": "kind", + "properties": { + "identity": { + "description": "Optional property. Managed identity to be used for this deployment script. Currently, only user-assigned MSI is supported.", + "$ref": "#/definitions/ManagedServiceIdentity" + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The location of the ACI and the storage account for the deployment script." + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "kind": { + "type": "string", + "description": "Type of the script.", + "enum": [ + "AzurePowerShell", + "AzureCLI" + ], + "x-ms-enum": { + "name": "ScriptType", + "modelAsString": true + } + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceBase" + } + ] + }, + "DeploymentScriptUpdateParameter": { + "type": "object", + "description": "Deployment script parameters to be updated. ", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags to be updated.", + "additionalProperties": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceBase" + } + ] + }, + "AzurePowerShellScript": { + "required": [ + "properties" + ], + "type": "object", + "x-ms-discriminator-value": "AzurePowerShell", + "description": "Object model for the Azure PowerShell script.", + "properties": { + "properties": { + "description": "Properties of the Azure PowerShell script object.", + "$ref": "#/definitions/AzurePowerShellScriptProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/DeploymentScript" + } + ] + }, + "AzurePowerShellScriptProperties": { + "required": [ + "azPowerShellVersion" + ], + "type": "object", + "description": "Properties of the Azure PowerShell script object.", + "properties": { + "azPowerShellVersion": { + "type": "string", + "description": "Azure PowerShell module version to be used." + } + }, + "allOf": [ + { + "$ref": "#/definitions/DeploymentScriptPropertiesBase" + }, + { + "$ref": "#/definitions/ScriptConfigurationBase" + } + ] + }, + "AzureCliScript": { + "required": [ + "properties" + ], + "type": "object", + "x-ms-discriminator-value": "AzureCLI", + "description": "Object model for the Azure CLI script.", + "properties": { + "properties": { + "description": "Properties of the Azure CLI script object.", + "$ref": "#/definitions/AzureCliScriptProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/DeploymentScript" + } + ] + }, + "AzureCliScriptProperties": { + "required": [ + "azCliVersion" + ], + "type": "object", + "description": "Properties of the Azure CLI script object.", + "properties": { + "azCliVersion": { + "type": "string", + "description": "Azure CLI module version to be used." + } + }, + "allOf": [ + { + "$ref": "#/definitions/DeploymentScriptPropertiesBase" + }, + { + "$ref": "#/definitions/ScriptConfigurationBase" + } + ] + }, + "ScriptConfigurationBase": { + "required": [ + "retentionInterval" + ], + "type": "object", + "x-ms-external": true, + "description": "Common configuration settings for both Azure PowerShell and Azure CLI scripts.", + "properties": { + "primaryScriptUri": { + "type": "string", + "description": "Uri for the script. This is the entry point for the external script." + }, + "supportingScriptUris": { + "type": "array", + "description": "Supporting files for the external script.", + "items": { + "type": "string", + "description": "Supporting file Uri." + } + }, + "scriptContent": { + "type": "string", + "maxLength": 32000, + "description": "Script body." + }, + "arguments": { + "type": "string", + "description": "Command line arguments to pass to the script. Arguments are separated by spaces. ex: -Name blue* -Location 'West US 2' " + }, + "environmentVariables": { + "description": "The environment variables to pass over to the script.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + } + }, + "forceUpdateTag": { + "type": "string", + "description": "Gets or sets how the deployment script should be forced to execute even if the script resource has not changed. Can be current time stamp or a GUID." + }, + "retentionInterval": { + "type": "string", + "format": "duration", + "description": "Interval for which the service retains the script resource after it reaches a terminal state. Resource will be deleted when this duration expires. Duration is based on ISO 8601 pattern (for example P7D means one week)." + }, + "timeout": { + "type": "string", + "format": "duration", + "description": "Maximum allowed script execution time specified in ISO 8601 format. Default value is PT1H" + } + } + }, + "DeploymentScriptPropertiesBase": { + "type": "object", + "x-ms-external": true, + "description": "Common properties for the deployment script.", + "properties": { + "containerSettings": { + "type": "object", + "description": "Container settings.", + "$ref": "#/definitions/ContainerConfiguration" + }, + "storageAccountSettings": { + "type": "object", + "description": "Storage Account settings.", + "$ref": "#/definitions/StorageAccountConfiguration" + }, + "cleanupPreference": { + "type": "string", + "description": "The clean up preference when the script execution gets in a terminal state. Default setting is 'Always'.", + "enum": [ + "Always", + "OnSuccess", + "OnExpiration" + ], + "x-ms-enum": { + "name": "cleanupOptions", + "modelAsString": true + } + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "State of the script execution. This only appears in the response.", + "enum": [ + "Creating", + "ProvisioningResources", + "Running", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ScriptProvisioningState", + "modelAsString": true + } + }, + "status": { + "type": "object", + "readOnly": true, + "description": "Contains the results of script execution.", + "$ref": "#/definitions/ScriptStatus" + }, + "outputs": { + "description": "List of script outputs.", + "type": "object", + "readOnly": true, + "additionalProperties": { + "type": "object", + "description": "Script output in pair." + } + } + } + }, + "ContainerConfiguration": { + "type": "object", + "description": "Settings to customize ACI container instance.", + "properties": { + "containerGroupName": { + "type": "string", + "description": "Container group name, if not specified then the name will get auto-generated. Not specifying a 'containerGroupName' indicates the system to generate a unique name which might end up flagging an Azure Policy as non-compliant. Use 'containerGroupName' when you have an Azure Policy that expects a specific naming convention or when you want to fully control the name. 'containerGroupName' property must be between 1 and 63 characters long, must contain only lowercase letters, numbers, and dashes and it cannot start or end with a dash and consecutive dashes are not allowed. To specify a 'containerGroupName', add the following object to properties: { \"containerSettings\": { \"containerGroupName\": \"contoso-container\" } }. If you do not want to specify a 'containerGroupName' then do not add 'containerSettings' property.", + "minLength": 1, + "maxLength": 63 + } + } + }, + "StorageAccountConfiguration": { + "type": "object", + "description": "Settings to use an existing storage account. Valid storage account kinds are: Storage, StorageV2 and FileStorage", + "properties": { + "storageAccountName": { + "type": "string", + "description": "The storage account name." + }, + "storageAccountKey": { + "type": "string", + "description": "The storage account access key.", + "x-ms-secret": true + } + } + }, + "ScriptStatus": { + "type": "object", + "description": "Generic object modeling results of script execution.", + "properties": { + "containerInstanceId": { + "type": "string", + "readOnly": true, + "description": "ACI resource Id." + }, + "storageAccountId": { + "type": "string", + "readOnly": true, + "description": "Storage account resource Id." + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Start time of the script execution." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "End time of the script execution." + }, + "expirationTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Time the deployment script resource will expire." + }, + "error": { + "description": "Error that is relayed from the script execution.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + } + } + }, + "ManagedServiceIdentity": { + "type": "object", + "description": "Managed identity generic object.", + "properties": { + "type": { + "type": "string", + "description": "Type of the managed identity.", + "enum": [ + "UserAssigned" + ], + "x-ms-enum": { + "name": "ManagedServiceIdentityType", + "modelAsString": true + } + }, + "userAssignedIdentities": { + "type": "object", + "description": "The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.", + "additionalProperties": { + "description": "User-assigned managed identity.", + "$ref": "#/definitions/UserAssignedIdentity" + } + } + } + }, + "UserAssignedIdentity": { + "type": "object", + "description": "User-assigned managed identity.", + "properties": { + "principalId": { + "type": "string", + "description": "Azure Active Directory principal ID associated with this identity." + }, + "clientId": { + "type": "string", + "description": "Client App Id associated with this identity." + } + } + }, + "EnvironmentVariable": { + "description": "The environment variable to pass to the script in the container instance.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the environment variable." + }, + "value": { + "type": "string", + "description": "The value of the environment variable." + }, + "secureValue": { + "type": "string", + "description": "The value of the secure environment variable.", + "x-ms-secret": true + } + }, + "required": [ + "name" + ] + }, + "DeploymentScriptListResult": { + "description": "List of deployment scripts.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeploymentScript" + }, + "description": "An array of deployment scripts." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to use for getting the next set of results." + } + } + }, + "ScriptLogsList": { + "description": "Deployment script execution logs.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ScriptLog" + }, + "description": "Deployment scripts logs." + } + } + }, + "ScriptLog": { + "type": "object", + "description": "Script execution log object.", + "properties": { + "properties": { + "$ref": "#/definitions/LogProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceBase" + } + ] + }, + "LogProperties": { + "type": "object", + "description": "Script log properties.", + "properties": { + "log": { + "type": "string", + "readOnly": true, + "description": "Script execution logs in text format." + } + } + }, + "AzureResourceBase": { + "x-ms-azure-resource": true, + "type": "object", + "description": "Common properties for all Azure resources.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "String Id used to locate any resource on Azure." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of this resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of this resource." + } + } + }, + "DeploymentScriptsError": { + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + } + }, + "description": "Deployment scripts error response." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "description": "Subscription Id which forms part of the URI for every service call." + }, + "ScriptNameParameter": { + "name": "scriptName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the deployment script.", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "ResourceGroupNameParameter": { + "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, + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "description": "Client Api version." + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Create.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Create.json new file mode 100644 index 000000000000..7d6dc278fb69 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Create.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "script-rg", + "scriptName": "MyDeploymentScript", + "deploymentScript": { + "kind": "AzurePowerShell", + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {} + } + }, + "properties": { + "azPowerShellVersion": "1.7.0", + "scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name", + "arguments": "-Location 'westus' -Name \"*rg2\"", + "supportingScriptUris": [ + "https://uri1.to.supporting.script", + "https://uri2.to.supporting.script" + ], + "retentionInterval": "PT7D", + "timeout": "PT1H", + "cleanupPreference": "Always" + } + } + }, + "responses": { + "201": { + "body": { + "kind": "AzurePowerShell", + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {} + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "provisioningState": "Creating", + "azPowerShellVersion": "1.7.0", + "scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name", + "arguments": "-Location 'westus' -Name \"*rg2\"", + "supportingScriptUris": [ + "https://uri1.to.supporting.script", + "https://uri2.to.supporting.script" + ], + "retentionInterval": "P7D", + "timeout": "PT1H", + "cleanupPreference": "Always", + "status": { + "containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage", + "startTime": "2018-11-13T15:19:45-08:00", + "endTime": "2018-11-13T15:19:45-08:00", + "expirationTime": "2018-11-13T15:19:45-08:00" + } + } + } + }, + "200": { + "body": { + "kind": "AzurePowerShell", + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {} + } + }, + "properties": { + "provisioningState": "Succeeded", + "azPowerShellVersion": "1.7.0", + "scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name", + "arguments": "-Location 'westus' -Name \"*rg2\"", + "supportingScriptUris": [ + "https://uri1.to.supporting.script", + "https://uri2.to.supporting.script" + ], + "retentionInterval": "P7D", + "timeout": "PT1H", + "cleanupPreference": "Always", + "status": { + "containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage", + "startTime": "2018-11-13T15:19:45-08:00", + "endTime": "2018-11-13T15:19:45-08:00", + "expirationTime": "2018-11-13T15:19:45-08:00" + }, + "outputs": { + "output1": "value1" + } + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Create_No_UserManagedIdentity.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Create_No_UserManagedIdentity.json new file mode 100644 index 000000000000..61cc35dbd7f2 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Create_No_UserManagedIdentity.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "script-rg", + "scriptName": "MyDeploymentScript", + "deploymentScript": { + "kind": "AzurePowerShell", + "location": "westus", + "properties": { + "azPowerShellVersion": "1.7.0", + "scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name", + "arguments": "-Location 'westus' -Name \"*rg2\"", + "supportingScriptUris": [ + "https://uri1.to.supporting.script", + "https://uri2.to.supporting.script" + ], + "retentionInterval": "PT7D", + "timeout": "PT1H", + "cleanupPreference": "Always" + } + } + }, + "responses": { + "201": { + "body": { + "kind": "AzurePowerShell", + "location": "westus", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "provisioningState": "Creating", + "azPowerShellVersion": "1.7.0", + "scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name", + "arguments": "-Location 'westus' -Name \"*rg2\"", + "supportingScriptUris": [ + "https://uri1.to.supporting.script", + "https://uri2.to.supporting.script" + ], + "retentionInterval": "P7D", + "timeout": "PT1H", + "cleanupPreference": "Always", + "status": { + "containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage", + "startTime": "2018-11-13T15:19:45-08:00", + "endTime": "2018-11-13T15:19:45-08:00", + "expirationTime": "2018-11-13T15:19:45-08:00" + } + } + } + }, + "200": { + "body": { + "kind": "AzurePowerShell", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "azPowerShellVersion": "1.7.0", + "scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name", + "arguments": "-Location 'westus' -Name \"*rg2\"", + "supportingScriptUris": [ + "https://uri1.to.supporting.script", + "https://uri2.to.supporting.script" + ], + "retentionInterval": "P7D", + "timeout": "PT1H", + "cleanupPreference": "Always", + "status": { + "containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage", + "startTime": "2018-11-13T15:19:45-08:00", + "endTime": "2018-11-13T15:19:45-08:00", + "expirationTime": "2018-11-13T15:19:45-08:00" + }, + "outputs": { + "output1": "value1" + } + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Create_Using_Custom_Aci_Name.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Create_Using_Custom_Aci_Name.json new file mode 100644 index 000000000000..371e6a394db8 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Create_Using_Custom_Aci_Name.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "script-rg", + "scriptName": "MyDeploymentScript", + "deploymentScript": { + "kind": "AzurePowerShell", + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {} + } + }, + "properties": { + "azPowerShellVersion": "1.7.0", + "scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name", + "containerSettings": { + "containerGroupName": "contoso-aci" + }, + "arguments": "-Location 'westus' -Name \"*rg2\"", + "supportingScriptUris": [ + "https://uri1.to.supporting.script", + "https://uri2.to.supporting.script" + ], + "retentionInterval": "PT7D", + "timeout": "PT1H", + "cleanupPreference": "Always" + } + } + }, + "responses": { + "201": { + "body": { + "kind": "AzurePowerShell", + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {} + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "provisioningState": "Creating", + "azPowerShellVersion": "1.7.0", + "scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name", + "arguments": "-Location 'westus' -Name \"*rg2\"", + "supportingScriptUris": [ + "https://uri1.to.supporting.script", + "https://uri2.to.supporting.script" + ], + "retentionInterval": "P7D", + "timeout": "PT1H", + "containerSettings": { + "containerGroupName": "contoso-aci" + }, + "cleanupPreference": "Always", + "status": { + "containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage", + "startTime": "2018-11-13T15:19:45-08:00", + "endTime": "2018-11-13T15:19:45-08:00", + "expirationTime": "2018-11-13T15:19:45-08:00" + } + } + } + }, + "200": { + "body": { + "kind": "AzurePowerShell", + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {} + } + }, + "properties": { + "provisioningState": "Succeeded", + "azPowerShellVersion": "1.7.0", + "scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name", + "arguments": "-Location 'westus' -Name \"*rg2\"", + "supportingScriptUris": [ + "https://uri1.to.supporting.script", + "https://uri2.to.supporting.script" + ], + "retentionInterval": "P7D", + "timeout": "PT1H", + "containerSettings": { + "containerGroupName": "contoso-aci" + }, + "cleanupPreference": "Always", + "status": { + "containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage", + "startTime": "2018-11-13T15:19:45-08:00", + "endTime": "2018-11-13T15:19:45-08:00", + "expirationTime": "2018-11-13T15:19:45-08:00" + }, + "outputs": { + "output1": "value1" + } + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Create_Using_Existing_StorageAccount.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Create_Using_Existing_StorageAccount.json new file mode 100644 index 000000000000..704aea8b3a8c --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Create_Using_Existing_StorageAccount.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "script-rg", + "scriptName": "MyDeploymentScript", + "deploymentScript": { + "kind": "AzurePowerShell", + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {} + } + }, + "properties": { + "azPowerShellVersion": "1.7.0", + "scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name", + "storageAccountSettings": { + "storageAccountName": "contosostorage", + "storageAccountKey": "contosostoragekey" + }, + "arguments": "-Location 'westus' -Name \"*rg2\"", + "supportingScriptUris": [ + "https://uri1.to.supporting.script", + "https://uri2.to.supporting.script" + ], + "retentionInterval": "PT7D", + "timeout": "PT1H", + "cleanupPreference": "Always" + } + } + }, + "responses": { + "201": { + "body": { + "kind": "AzurePowerShell", + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {} + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "provisioningState": "Creating", + "azPowerShellVersion": "1.7.0", + "scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name", + "arguments": "-Location 'westus' -Name \"*rg2\"", + "supportingScriptUris": [ + "https://uri1.to.supporting.script", + "https://uri2.to.supporting.script" + ], + "storageAccountSettings": { + "storageAccountName": "contosostorage" + }, + "retentionInterval": "P7D", + "timeout": "PT1H", + "cleanupPreference": "Always", + "status": { + "containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage", + "startTime": "2018-11-13T15:19:45-08:00", + "endTime": "2018-11-13T15:19:45-08:00", + "expirationTime": "2018-11-13T15:19:45-08:00" + } + } + } + }, + "200": { + "body": { + "kind": "AzurePowerShell", + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {} + } + }, + "properties": { + "provisioningState": "Succeeded", + "azPowerShellVersion": "1.7.0", + "scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name", + "arguments": "-Location 'westus' -Name \"*rg2\"", + "supportingScriptUris": [ + "https://uri1.to.supporting.script", + "https://uri2.to.supporting.script" + ], + "storageAccountSettings": { + "storageAccountName": "contosostorage" + }, + "retentionInterval": "P7D", + "timeout": "PT1H", + "cleanupPreference": "Always", + "status": { + "containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage", + "startTime": "2018-11-13T15:19:45-08:00", + "endTime": "2018-11-13T15:19:45-08:00", + "expirationTime": "2018-11-13T15:19:45-08:00" + }, + "outputs": { + "output1": "value1" + } + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Delete.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Delete.json new file mode 100644 index 000000000000..e5644a332306 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Delete.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "script-rg", + "scriptName": "MyDeploymentScript", + "deploymentScript": { + "kind": "AzurePowerShell", + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {} + } + }, + "properties": { + "provisioningState": "Succeeded", + "azPowerShellVersion": "1.7.0", + "scriptContent": "user script body", + "arguments": "user script arguments", + "supportingScriptUris": [ + "https://uri1.to.supporting.script", + "https://uri2.to.supporting.script" + ], + "retentionInterval": "PT7D", + "timeout": "PT1H", + "cleanupPreference": "Always", + "results": { + "aciId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage", + "startTime": "2018-11-13T15:19:45-08:00", + "endTime": "2018-11-13T15:19:45-08:00", + "expirationTime": "2018-11-13T15:19:45-08:00" + }, + "outputs": { + "output1": "value1" + } + } + } + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Get.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Get.json new file mode 100644 index 000000000000..553918eb5463 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Get.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "script-rg", + "scriptName": "MyDeploymentScript" + }, + "responses": { + "200": { + "body": { + "kind": "AzurePowerShell", + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {} + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "azPowerShellVersion": "1.7.0", + "scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name", + "arguments": "-Location 'westus' -Name \"*rg2\"", + "retentionInterval": "PT7D", + "timeout": "PT1H", + "cleanupPreference": "Always", + "status": { + "containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage", + "startTime": "2018-11-13T15:19:45-08:00", + "endTime": "2018-11-13T15:19:45-08:00", + "expirationTime": "2018-11-13T15:19:45-08:00" + }, + "outputs": { + "output1": "value1" + } + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_GetLogs.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_GetLogs.json new file mode 100644 index 000000000000..0b5fb099e739 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_GetLogs.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "script-rg", + "scriptName": "MyDeploymentScript" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "log": "script execution stdout/stderr logs" + } + } + ] + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_GetLogsDefault.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_GetLogsDefault.json new file mode 100644 index 000000000000..73a81f114436 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_GetLogsDefault.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "script-rg", + "scriptName": "MyDeploymentScript" + }, + "responses": { + "200": { + "body": { + "properties": { + "log": "script execution stdout/stderr logs" + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_GetLogsDefaultWithTail.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_GetLogsDefaultWithTail.json new file mode 100644 index 000000000000..996b635c7bf1 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_GetLogsDefaultWithTail.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "script-rg", + "scriptName": "MyDeploymentScript", + "tail": 5 + }, + "responses": { + "200": { + "body": { + "properties": { + "log": "script execution stdout/stderr logs" + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_ListByResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_ListByResourceGroup.json new file mode 100644 index 000000000000..d527ef70a942 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_ListByResourceGroup.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "script-rg", + "scriptName": "MyDeploymentScript" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "AzurePowerShell", + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {} + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "azPowerShellVersion": "1.7.0", + "scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name", + "arguments": "-Location 'westus' -Name \"*rg2\"", + "supportingScriptUris": [ + "https://uri1.to.supporting.script", + "https://uri2.to.supporting.script" + ], + "retentionInterval": "P7D", + "timeout": "PT1H", + "cleanupPreference": "Always", + "status": { + "containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage", + "startTime": "2018-11-13T15:19:45-08:00", + "endTime": "2018-11-13T15:19:45-08:00", + "expirationTime": "2018-11-13T15:19:45-08:00" + }, + "outputs": { + "output1": "value1" + } + } + } + ] + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_ListBySubscription.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_ListBySubscription.json new file mode 100644 index 000000000000..9ff921de6919 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_ListBySubscription.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "AzurePowerShell", + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {} + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "provisioningState": "Succeeded", + "azPowerShellVersion": "1.7.0", + "scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name", + "arguments": "-Location 'westus' -Name \"*rg2\"", + "retentionInterval": "PT7D", + "timeout": "PT1H", + "cleanupPreference": "Always", + "status": { + "containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage", + "startTime": "2018-11-13T15:19:45-08:00", + "endTime": "2018-11-13T15:19:45-08:00", + "expirationTime": "2018-11-13T15:19:45-08:00" + }, + "outputs": { + "output1": "value1" + } + } + } + ] + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Min_Create.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Min_Create.json new file mode 100644 index 000000000000..1ed1115e3701 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Min_Create.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "script-rg", + "scriptName": "MyDeploymentScript", + "deploymentScript": { + "kind": "AzurePowerShell", + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {} + } + }, + "properties": { + "azPowerShellVersion": "1.7.0", + "scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name", + "arguments": "-Location 'westus' -Name \"*rg2\"", + "retentionInterval": "P7D" + } + } + }, + "responses": { + "201": { + "body": { + "kind": "AzurePowerShell", + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {} + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "provisioningState": "Creating", + "azPowerShellVersion": "1.7.0", + "scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name", + "arguments": "-Location 'westus' -Name \"*rg2\"", + "retentionInterval": "P7D", + "timeout": "PT1H", + "cleanupPreference": "Always", + "status": { + "containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage", + "startTime": "2018-11-13T15:19:45-08:00", + "endTime": "2018-11-13T15:19:45-08:00", + "expirationTime": "2018-11-13T15:19:45-08:00" + } + } + } + }, + "200": { + "body": { + "kind": "AzurePowerShell", + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {} + } + }, + "properties": { + "provisioningState": "Succeeded", + "azPowerShellVersion": "1.7.0", + "scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name", + "arguments": "-Location 'westus' -Name \"*rg2\"", + "retentionInterval": "P7D", + "timeout": "PT1H", + "cleanupPreference": "Always", + "status": { + "containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage", + "startTime": "2018-11-13T15:19:45-08:00", + "endTime": "2018-11-13T15:19:45-08:00", + "expirationTime": "2018-11-13T15:19:45-08:00" + }, + "outputs": { + "output1": "value1" + } + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Update.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Update.json new file mode 100644 index 000000000000..a55272446486 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-10-01/examples/DeploymentScripts_Update.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2020-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "script-rg", + "scriptName": "MyDeploymentScript", + "deploymentScript": { + "tags": {} + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "azPowerShellVersion": "1.7.0", + "scriptContent": "Param([string]$Location,[string]$Name) $deploymentScriptOutputs['test'] = 'value' Get-AzResourceGroup -Location $Location -Name $Name", + "arguments": "-Location 'westus' -Name \"*rg2\"", + "supportingScriptUris": [ + "https://uri1.to.supporting.script", + "https://uri2.to.supporting.script" + ], + "retentionInterval": "P7D", + "timeout": "PT1H", + "cleanupPreference": "Always", + "status": { + "containerInstanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ContainerInstance/containerGroups/scriptContainer", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.Storage/storageAccounts/scriptStorage", + "startTime": "2018-11-13T15:19:45-08:00", + "endTime": "2018-11-13T15:19:45-08:00", + "expirationTime": "2018-11-13T15:19:45-08:00" + }, + "outputs": { + "output1": "value1" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "kind": "AzurePowerShell", + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scriptRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai": {} + } + }, + "tags": {} + } + } + } +} diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md index f79a261926da..1aeb07ca5d22 100644 --- a/specification/resources/resource-manager/readme.md +++ b/specification/resources/resource-manager/readme.md @@ -57,7 +57,7 @@ tag: package-managedapplications-2018-06 ``` ``` yaml $(package-deploymentscripts) -tag: package-deploymentscripts-2019-10-preview +tag: package-deploymentscripts-2020-10 ``` ``` yaml $(package-templatespecs) @@ -91,6 +91,15 @@ input-file: - Microsoft.Resources/stable/2020-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. + +``` yaml $(tag) == 'package-deploymentscripts-2020-10' +input-file: +- Microsoft.Resources/stable/2020-10-01/deploymentScripts.json +``` + ### Tag: package-deploymentscripts-2019-10-preview These settings apply only when `--tag=package-deploymentscripts-2019-10-preview` is specified on the command line. @@ -726,6 +735,7 @@ input-file: - $(this-folder)/Microsoft.Resources/stable/2020-06-01/resources.json - $(this-folder)/Microsoft.Resources/stable/2020-01-01/subscriptions.json - $(this-folder)/Microsoft.Resources/preview/2019-10-01-preview/deploymentScripts.json + - $(this-folder)/Microsoft.Resources/stable/2020-10-01/deploymentScripts.json - $(this-folder)/Microsoft.Features/stable/2015-12-01/features.json - $(this-folder)/Microsoft.Authorization/stable/2016-09-01/locks.json - $(this-folder)/Microsoft.Authorization/stable/2015-01-01/locks.json diff --git a/specification/resources/resource-manager/readme.python.md b/specification/resources/resource-manager/readme.python.md index a280776e0d1a..fc83b036dc42 100644 --- a/specification/resources/resource-manager/readme.python.md +++ b/specification/resources/resource-manager/readme.python.md @@ -57,7 +57,8 @@ batch: - tag: package-subscriptions-2019-06 - tag: package-subscriptions-2018-06 - tag: package-subscriptions-2016-06 - - tag: package-deploymentscripts-2019-10-preview + - tag: package-deploymentscripts-2020-10 + - tag: package-deploymentscripts-2019-10-preview - tag: package-templatespecs-2019-06-preview ``` @@ -100,7 +101,8 @@ batch: - tag: package-subscriptions-2018-06 - tag: package-subscriptions-2016-06 - multiapiscript-subscriptions: true - - tag: package-deploymentscripts-2019-10-preview + - tag: package-deploymentscripts-2020-10 + - tag: package-deploymentscripts-2019-10-preview - multiapiscript-deploymentscripts: true - tag: package-templatespecs-2019-06-preview - multiapiscript-templatespecs: true @@ -560,11 +562,24 @@ These settings apply only when `--tag=package-deploymentscripts-2019-10-preview` Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-deploymentscripts-2019-10-preview' -namespace: azure.mgmt.resource.deploymentscripts.v2019_10_preview -output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/deploymentscripts/v2019_10_preview +namespace: azure.mgmt.resource.deploymentscripts.v2019_10_01_preview +output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/deploymentscripts/v2019_10_01_preview python: - namespace: azure.mgmt.resource.deploymentscripts.v2019_10_preview - output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/deploymentscripts/v2019_10_preview + namespace: azure.mgmt.resource.deploymentscripts.v2019_10_01_preview + output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/deploymentscripts/v2019_10_01_preview +``` + +### Tag: package-deploymentscripts-2020-10 and python + +These settings apply only when `--tag=package-deploymentscripts-2020-10` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-deploymentscripts-2020-10' +namespace: azure.mgmt.resource.deploymentscripts.v2020_10_01 +output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/deploymentscripts/v2020_10_01 +python: + namespace: azure.mgmt.resource.deploymentscripts.v2020_10_01 + output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/deploymentscripts/v2020_10_01 ``` ### Tag: package-templatespecs-2019-06-preview and python From 995320f08eb9b7e1bc12047987dce146a08c405e Mon Sep 17 00:00:00 2001 From: shmartel <53022511+shmartel@users.noreply.github.com> Date: Wed, 16 Sep 2020 01:42:03 -0700 Subject: [PATCH 073/164] [Hub Generated] Move private branch 'dev-healthcareapis-Microsoft.HealthcareApis-2020-03-15' to public (#10757) --- .../examples/CheckNameAvailabilityPost.json | 19 + .../examples/OperationResultsGet.json | 27 + .../2020-03-15/examples/OperationsList.json | 53 + .../2020-03-15/examples/ServiceCreate.json | 171 +++ .../examples/ServiceCreateMinimum.json | 91 ++ .../2020-03-15/examples/ServiceDelete.json | 12 + .../2020-03-15/examples/ServiceGet.json | 59 ++ .../2020-03-15/examples/ServiceList.json | 62 ++ .../examples/ServiceListByResourceGroup.json | 63 ++ .../2020-03-15/examples/ServicePatch.json | 68 ++ .../stable/2020-03-15/healthcare-apis.json | 989 ++++++++++++++++++ .../healthcareapis/resource-manager/readme.md | 25 +- 12 files changed, 1631 insertions(+), 8 deletions(-) create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/CheckNameAvailabilityPost.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/OperationResultsGet.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/OperationsList.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceCreate.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceCreateMinimum.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceDelete.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceGet.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceList.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceListByResourceGroup.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServicePatch.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/healthcare-apis.json diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/CheckNameAvailabilityPost.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/CheckNameAvailabilityPost.json new file mode 100644 index 000000000000..4bcf5e0ea023 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/CheckNameAvailabilityPost.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2020-03-15", + "subscriptionId": "subid", + "checkNameAvailabilityInputs": { + "type": "Microsoft.HealthcareApis/services", + "name": "serviceName" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "Service name is not available." + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/OperationResultsGet.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/OperationResultsGet.json new file mode 100644 index 000000000000..fc456dd9cd27 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/OperationResultsGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2020-03-15", + "subscriptionId": "subid", + "locationName": "westus", + "operationResultId": "exampleid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.HealthcareApis/locations/westus/operationresults/exampleid", + "name": "servicename", + "status": "Requested", + "startTime": "2019-01-21T06:03:30.2716301Z", + "properties": {} + } + }, + "404": { + "body": { + "error": { + "code": "OperationResultNotFound", + "message": "The operation result was not found." + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/OperationsList.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/OperationsList.json new file mode 100644 index 000000000000..fb6ef411d36a --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/OperationsList.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2020-03-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.HealthcareApis/services/read", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/services/write", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/services/delete", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/locations/operationresults/read", + "display": { + "provider": "Microsoft.HealthcareApis", + "resource": "operationresults", + "operation": "read", + "description": "Get the status of an asynchronous operation" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/checkNameAvailability/post", + "display": {}, + "origin": "user" + }, + { + "name": "Microsoft.HealthcareApis/Operations/read", + "display": { + "provider": "Microsoft.HealthcareApis", + "resource": "operations", + "operation": "read", + "description": "Get the list of operations supported by this Resource Provider." + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceCreate.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceCreate.json new file mode 100644 index 000000000000..0913fe446c46 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceCreate.json @@ -0,0 +1,171 @@ +{ + "parameters": { + "resourceName": "service1", + "resourceGroupName": "rg1", + "api-version": "2020-03-15", + "subscriptionId": "subid", + "serviceDescription": { + "location": "westus2", + "tags": {}, + "kind": "fhir-R4", + "properties": { + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key" + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "exportConfiguration": { + "storageAccountName": "existingStorageAccount" + } + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US 2", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir-R4", + "etag": "etagvalue", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key" + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "exportConfiguration": { + "storageAccountName": "existingStorageAccount" + } + }, + "identity": { + "principalId": "03fe6ae0-952c-4e4b-954b-cc0364dd252e", + "tenantId": "72f988bf-86f1-41af-91ab-2d8cd011db47", + "type": "SystemAssigned" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US 2", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir-R4", + "etag": "etagvalue", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000 + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + }, + "exportConfiguration": { + "storageAccountName": "existingStorageAccount" + } + }, + "identity": { + "principalId": "03fe6ae0-952c-4e4b-954b-cc0364dd252e", + "tenantId": "72f988bf-86f1-41af-91ab-2d8cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceCreateMinimum.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceCreateMinimum.json new file mode 100644 index 000000000000..5623735dcb6d --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceCreateMinimum.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "resourceName": "service2", + "resourceGroupName": "rg1", + "api-version": "2020-03-15", + "subscriptionId": "subid", + "serviceDescription": { + "location": "westus2", + "tags": {}, + "kind": "fhir-R4", + "properties": { + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service2", + "name": "service2", + "type": "Microsoft.HealthcareApis/services", + "etag": "etagvalue", + "location": "westus2", + "kind": "fhir-R4", + "tags": {}, + "properties": { + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000 + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": false + }, + "corsConfiguration": { + "origins": [], + "headers": [], + "methods": [], + "maxAge": null, + "allowCredentials": false + }, + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service2", + "name": "service2", + "type": "Microsoft.HealthcareApis/services", + "etag": "etagvalue", + "location": "westus2", + "kind": "fhir-R4", + "tags": {}, + "properties": { + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": null + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": false + }, + "corsConfiguration": { + "origins": [], + "headers": [], + "methods": [], + "maxAge": null, + "allowCredentials": false + }, + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceDelete.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceDelete.json new file mode 100644 index 000000000000..6f463e67ae50 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "resourceName": "service1", + "resourceGroupName": "rg1", + "api-version": "2020-03-15", + "subscriptionId": "subid" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceGet.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceGet.json new file mode 100644 index 000000000000..ca5cf7e079ad --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceGet.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "resourceName": "service1", + "resourceGroupName": "rg1", + "api-version": "2020-03-15", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir-R4", + "etag": "etagvalue", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key" + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + } + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceList.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceList.json new file mode 100644 index 000000000000..a390808e92b9 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceList.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2020-03-15", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir-R4", + "etag": "etag", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key" + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + } + } + } + ], + "nextLink": "https://host/subscriptions/subid/providers/Microsoft.HealthcareApis/services?api-version=2018-08-20-preview&%24skipToken=e30%3d" + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceListByResourceGroup.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceListByResourceGroup.json new file mode 100644 index 000000000000..18c57575d8f0 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServiceListByResourceGroup.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2020-03-15", + "subscriptionId": "subid", + "resourceGroupName": "rgname" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/dddb8dcb-effb-4290-bb47-ce1e8440c729", + "name": "service1", + "location": "westus", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir-R4", + "tags": {}, + "etag": "etagvalue", + "properties": { + "provisioningState": "Creating", + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key" + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + } + } + } + ], + "nextLink": "https://host/subscriptions/subid/resourceGroups/rgname/providers/Microsoft.HealthcareApis/services?api-version=2018-08-20-preview&%24skipToken=e30%3d" + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServicePatch.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServicePatch.json new file mode 100644 index 000000000000..f039be7c4ac7 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/examples/ServicePatch.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "resourceName": "service1", + "resourceGroupName": "rg1", + "api-version": "2020-03-15", + "subscriptionId": "subid", + "servicePatchDescription": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir-R4", + "etag": "etagvalue", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Creating", + "accessPolicies": [ + { + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" + }, + { + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" + } + ], + "cosmosDbConfiguration": { + "offerThroughput": 1000, + "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key" + }, + "authenticationConfiguration": { + "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc", + "audience": "https://azurehealthcareapis.com", + "smartProxyEnabled": true + }, + "corsConfiguration": { + "origins": [ + "*" + ], + "headers": [ + "*" + ], + "methods": [ + "DELETE", + "GET", + "OPTIONS", + "PATCH", + "POST", + "PUT" + ], + "maxAge": 1440, + "allowCredentials": false + } + } + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/healthcare-apis.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/healthcare-apis.json new file mode 100644 index 000000000000..8f52e2e545cf --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2020-03-15/healthcare-apis.json @@ -0,0 +1,989 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-03-15", + "title": "HealthcareApisClient", + "description": "Use this API to manage Microsoft HealthcareApis services in your Azure subscription." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}": { + "get": { + "tags": [ + "Resource" + ], + "description": "Get the metadata of a service instance.", + "operationId": "Services_Get", + "x-ms-examples": { + "Get metadata": { + "$ref": "./examples/ServiceGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains all of the properties of the service instance.", + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + }, + "default": { + "description": "Default error response", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Resource" + ], + "description": "Create or update the metadata of a service instance.", + "operationId": "Services_CreateOrUpdate", + "x-ms-examples": { + "Create or Update a service with all parameters": { + "$ref": "./examples/ServiceCreate.json" + }, + "Create or Update a service with minimum parameters": { + "$ref": "./examples/ServiceCreateMinimum.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "serviceDescription", + "in": "body", + "description": "The service instance metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + } + ], + "responses": { + "200": { + "description": "Updated - Put request accepted and an existing resource is being updated; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + }, + "201": { + "description": "Created - Put request accepted and a new resource was created; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "Resource" + ], + "description": "Update the metadata of a service instance.", + "operationId": "Services_Update", + "x-ms-examples": { + "Patch service": { + "$ref": "./examples/ServicePatch.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "servicePatchDescription", + "in": "body", + "description": "The service instance metadata and security metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/ServicesPatchDescription" + } + } + ], + "responses": { + "200": { + "description": "The tags for the resource were updated successfully.", + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Resource" + ], + "description": "Delete a service instance.", + "operationId": "Services_Delete", + "x-ms-examples": { + "Delete service": { + "$ref": "./examples/ServiceDelete.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "202": { + "description": "Accepted - Delete request accepted; the operation will complete asynchronously." + }, + "204": { + "description": "The resource does not exist." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/services": { + "get": { + "tags": [ + "Collection" + ], + "description": "Get all the service instances in a subscription.", + "operationId": "Services_List", + "x-ms-examples": { + "List all services in subscription": { + "$ref": "./examples/ServiceList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the service instances in the subscription.", + "schema": { + "$ref": "#/definitions/ServicesDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services": { + "get": { + "tags": [ + "Collection" + ], + "description": "Get all the service instances in a resource group.", + "operationId": "Services_ListByResourceGroup", + "x-ms-examples": { + "List all services in resource group": { + "$ref": "./examples/ServiceListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the service instances in the resource group.", + "schema": { + "$ref": "#/definitions/ServicesDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/providers/Microsoft.HealthcareApis/operations": { + "get": { + "tags": [ + "Proxy" + ], + "description": "Lists all of the available Healthcare service REST API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "List operations": { + "$ref": "./examples/OperationsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/checkNameAvailability": { + "post": { + "tags": [ + "Proxy" + ], + "description": "Check if a service instance name is available.", + "operationId": "Services_CheckNameAvailability", + "x-ms-examples": { + "Check name availability": { + "$ref": "./examples/CheckNameAvailabilityPost.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "checkNameAvailabilityInputs", + "in": "body", + "description": "Set the name parameter in the CheckNameAvailabilityParameters structure to the name of the service instance to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + } + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the service name is available. If the name is not available, the body contains the reason.", + "schema": { + "$ref": "#/definitions/ServicesNameAvailabilityInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/{locationName}/operationresults/{operationResultId}": { + "get": { + "tags": [ + "Resource" + ], + "description": "Get the operation result for a long running operation.", + "operationId": "OperationResults_Get", + "x-ms-examples": { + "Get operation result": { + "$ref": "./examples/OperationResultsGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/locationName" + }, + { + "$ref": "#/parameters/operationResultId" + } + ], + "responses": { + "200": { + "description": "The body contains all of the properties of the operation result.", + "schema": { + "$ref": "#/definitions/OperationResultsDescription" + } + }, + "404": { + "description": "No operation result was found matching operationResultId.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + }, + "default": { + "description": "Default error response", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + } + }, + "definitions": { + "ServicesProperties": { + "description": "The properties of a service instance.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state.", + "enum": [ + "Deleting", + "Succeeded", + "Creating", + "Accepted", + "Verifying", + "Updating", + "Failed", + "Canceled", + "Deprovisioned" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + }, + "accessPolicies": { + "$ref": "#/definitions/ServiceAccessPoliciesInfo", + "description": "The access policies of the service instance." + }, + "cosmosDbConfiguration": { + "$ref": "#/definitions/ServiceCosmosDbConfigurationInfo", + "description": "The settings for the Cosmos DB database backing the service." + }, + "authenticationConfiguration": { + "$ref": "#/definitions/ServiceAuthenticationConfigurationInfo", + "description": "The authentication configuration for the service instance." + }, + "corsConfiguration": { + "$ref": "#/definitions/ServiceCorsConfigurationInfo", + "description": "The settings for the CORS configuration of the service instance." + }, + "exportConfiguration": { + "$ref": "#/definitions/ServiceExportConfigurationInfo", + "description": "The settings for the export operation of the service instance." + } + } + }, + "ServiceAccessPoliciesInfo": { + "description": "The access policies of the service instance.", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceAccessPolicyEntry" + } + }, + "ServiceAccessPolicyEntry": { + "description": "An access policy entry.", + "properties": { + "objectId": { + "description": "An Azure AD object ID (User or Apps) that is allowed access to the FHIR service.", + "type": "string", + "pattern": "^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$" + } + }, + "required": [ + "objectId" + ] + }, + "ServiceCosmosDbConfigurationInfo": { + "description": "The settings for the Cosmos DB database backing the service.", + "type": "object", + "properties": { + "offerThroughput": { + "type": "integer", + "description": "The provisioned throughput for the backing database.", + "readOnly": false, + "minimum": 400, + "maximum": 10000 + }, + "keyVaultKeyUri": { + "type": "string", + "description": "The URI of the customer-managed key for the backing database.", + "readOnly": false + } + } + }, + "ServiceAuthenticationConfigurationInfo": { + "description": "Authentication configuration information", + "type": "object", + "properties": { + "authority": { + "type": "string", + "description": "The authority url for the service", + "readOnly": false + }, + "audience": { + "type": "string", + "description": "The audience url for the service", + "readOnly": false + }, + "smartProxyEnabled": { + "type": "boolean", + "description": "If the SMART on FHIR proxy is enabled", + "readOnly": false + } + } + }, + "ServiceCorsConfigurationInfo": { + "description": "The settings for the CORS configuration of the service instance.", + "type": "object", + "properties": { + "origins": { + "type": "array", + "description": "The origins to be allowed via CORS.", + "readOnly": false, + "items": { + "$ref": "#/definitions/ServiceCorsConfigurationOriginEntry" + } + }, + "headers": { + "type": "array", + "description": "The headers to be allowed via CORS.", + "readOnly": false, + "items": { + "$ref": "#/definitions/ServiceCorsConfigurationHeaderEntry" + } + }, + "methods": { + "type": "array", + "description": "The methods to be allowed via CORS.", + "readOnly": false, + "items": { + "$ref": "#/definitions/ServiceCorsConfigurationMethodEntry" + } + }, + "maxAge": { + "type": "integer", + "description": "The max age to be allowed via CORS.", + "readOnly": false, + "minimum": 0, + "maximum": 99999 + }, + "allowCredentials": { + "type": "boolean", + "description": "If credentials are allowed via CORS.", + "readOnly": false + } + } + }, + "ServiceExportConfigurationInfo": { + "description": "Export operation configuration information", + "type": "object", + "properties": { + "storageAccountName": { + "type": "string", + "description": "The name of the default export storage account.", + "readOnly": false + } + } + }, + "ServiceCorsConfigurationOriginEntry": { + "description": "An origin for CORS.", + "type": "string", + "pattern": "^(?:(?:(?:[hH][tT][tT][pP](?:[sS]|))\\:\\/\\/(?:[a-zA-Z0-9-]+[.]?)+(?:\\:[0-9]{1,5})?|[*]))$" + }, + "ServiceCorsConfigurationHeaderEntry": { + "description": "A header for CORS.", + "type": "string" + }, + "ServiceCorsConfigurationMethodEntry": { + "description": "A method for CORS.", + "type": "string" + }, + "ServicesDescription": { + "description": "The description of the service.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "description": "The common properties of a service.", + "$ref": "#/definitions/ServicesProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ServicesPatchDescription": { + "description": "The description of the service.", + "type": "object", + "properties": { + "tags": { + "description": "Instance tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Resource": { + "description": "The common properties of a service.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "kind": { + "readOnly": false, + "type": "string", + "description": "The kind of the service.", + "enum": [ + "fhir", + "fhir-Stu3", + "fhir-R4" + ], + "x-ms-enum": { + "name": "kind", + "modelAsString": false + } + }, + "location": { + "type": "string", + "description": "The resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + }, + "etag": { + "description": "An etag associated with the resource, used for optimistic concurrency when editing it.", + "type": "string" + }, + "identity": { + "type": "object", + "description": "Setting indicating whether the service has a managed identity associated with it.", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of the resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of the resource." + }, + "type": { + "description": "Type of identity being specified, currently SystemAssigned and None are allowed.", + "type": "string", + "enum": [ + "SystemAssigned", + "None" + ], + "x-ms-enum": { + "name": "ManagedServiceIdentityType", + "modelAsString": true + } + } + } + } + }, + "x-ms-azure-resource": true, + "required": [ + "location", + "kind" + ] + }, + "ErrorDetails": { + "description": "Error details.", + "type": "object", + "properties": { + "error": { + "description": "Object containing error details.", + "$ref": "#/definitions/ErrorDetailsInternal" + } + } + }, + "ErrorDetailsInternal": { + "description": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "The target of the particular error.", + "type": "string", + "readOnly": true + } + } + }, + "ServicesDescriptionListResult": { + "description": "A list of service description objects with a next link.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of service description objects.", + "type": "string" + }, + "value": { + "description": "A list of service description objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ServicesDescription" + } + } + } + }, + "OperationListResult": { + "description": "A list of service operations. It contains a list of operations and a URL link to get the next set of results.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of service description objects.", + "type": "string" + }, + "value": { + "description": "A list of service operations supported by the Microsoft.HealthcareApis resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + } + } + }, + "Operation": { + "description": "Service REST API operation.", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{read | write | action | delete}" + }, + "origin": { + "readOnly": true, + "type": "string", + "description": "Default value is 'user,system'." + }, + "display": { + "description": "The information displayed about the operation.", + "$ref": "#/definitions/OperationDisplay" + } + } + }, + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft.HealthcareApis" + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource Type: Services" + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Name of the operation" + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Friendly description for the operation," + } + } + }, + "CheckNameAvailabilityParameters": { + "description": "Input values.", + "type": "object", + "properties": { + "name": { + "description": "The name of the service instance to check.", + "type": "string" + }, + "type": { + "description": "The fully qualified resource type which includes provider namespace.", + "type": "string" + } + }, + "required": [ + "name", + "type" + ] + }, + "ServicesNameAvailabilityInfo": { + "description": "The properties indicating whether a given service name is available.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "The value which indicates whether the provided name is available.", + "type": "boolean", + "readOnly": true + }, + "reason": { + "description": "The reason for unavailability.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ServiceNameUnavailabilityReason", + "modelAsString": false + } + }, + "message": { + "description": "The detailed reason message.", + "type": "string" + } + } + }, + "OperationResultsDescription": { + "description": "The properties indicating the operation result of an operation on a service.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the operation returned.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the operation result.", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "The status of the operation being performed.", + "enum": [ + "Canceled", + "Succeeded", + "Failed", + "Requested", + "Running" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "OperationResultStatus", + "modelAsString": true + } + }, + "startTime": { + "description": "The time that the operation was started.", + "readOnly": true, + "type": "string" + }, + "properties": { + "x-ms-client-flatten": false, + "description": "Additional properties of the operation result." + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription identifier.", + "required": true, + "type": "string" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the service instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + "resourceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the service instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "minLength": 3, + "maxLength": 24 + }, + "locationName": { + "name": "locationName", + "in": "path", + "description": "The location of the operation.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "operationResultId": { + "name": "operationResultId", + "in": "path", + "description": "The ID of the operation result to get.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/healthcareapis/resource-manager/readme.md b/specification/healthcareapis/resource-manager/readme.md index f236f6dfd961..6b873de67d45 100644 --- a/specification/healthcareapis/resource-manager/readme.md +++ b/specification/healthcareapis/resource-manager/readme.md @@ -4,10 +4,10 @@ This is the AutoRest configuration file for HealthcareApis. - - --- + ## Getting Started + To build the SDK for HealthcareApis, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -15,23 +15,32 @@ To build the SDK for HealthcareApis, simply [Install AutoRest](https://aka.ms/au To see additional help and options, run: > `autorest --help` + --- ## Configuration - - ### Basic Information + These are the global settings for HealthcareApis service. ``` yaml title: HealthcareApisManagementClient description: Azure Healthcare APIs Client openapi-type: arm -tag: package-2019-09 +tag: package-2020-03 azure-arm: true ``` + +### Tag: package-2020-03 + +These settings apply only when `--tag=package-2020-03` is specified on the command line. + +```yaml $(tag) == 'package-2020-03' +input-file: + - Microsoft.HealthcareApis/stable/2020-03-15/healthcare-apis.json +``` ### Tag: package-2019-09 These settings apply only when `--tag=package-2019-09` is specified on the command line. @@ -52,7 +61,6 @@ input-file: # Code Generation - ## Swagger to SDK This section describes what SDK should be generated by the automatic system. @@ -69,6 +77,7 @@ swagger-to-sdk: after_scripts: - node sdkauto_afterscript.js healthcareapis/resource-manager ``` + ## C# These settings apply only when `--csharp` is specified on the command line. @@ -83,6 +92,7 @@ csharp: output-folder: $(csharp-sdks-folder)/healthcareapis/Microsoft.Azure.Management.HealthcareApis/src/Generated clear-output-folder: true ``` + ## Python See configuration in [readme.python.md](./readme.python.md) @@ -166,11 +176,10 @@ input-file: ``` -If there are files that should not be in the `all-api-versions` set, +If there are files that should not be in the `all-api-versions` set, uncomment the `exclude-file` section below and add the file paths. ``` yaml $(tag) == 'all-api-versions' #exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json ``` - From 8362798a00b2cd87a8efc23e2988937d13c0fe16 Mon Sep 17 00:00:00 2001 From: Dongwei Wang Date: Wed, 16 Sep 2020 08:48:00 -0700 Subject: [PATCH 074/164] [Synapse] - Unify dayofweek definition (#10449) --- .../preview/2019-06-01-preview/entityTypes/Trigger.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Trigger.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Trigger.json index 37376429432c..8f3943b4a7bf 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Trigger.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Trigger.json @@ -183,7 +183,7 @@ "Saturday" ], "x-ms-enum": { - "name": "DaysOfWeek", + "name": "DayOfWeek", "modelAsString": false } }, From 0ac9e064be76262b2625a0b5be1a0cc8b9b272fa Mon Sep 17 00:00:00 2001 From: wonner Date: Wed, 16 Sep 2020 23:48:31 +0800 Subject: [PATCH 075/164] fix synapse readme for python (#10750) Co-authored-by: Wan Yang --- specification/synapse/data-plane/readme.md | 8 ++++++++ specification/synapse/data-plane/readme.python.md | 2 ++ 2 files changed, 10 insertions(+) diff --git a/specification/synapse/data-plane/readme.md b/specification/synapse/data-plane/readme.md index 42c66982590e..8512d34cd14f 100644 --- a/specification/synapse/data-plane/readme.md +++ b/specification/synapse/data-plane/readme.md @@ -67,6 +67,14 @@ input-file: - Microsoft.Synapse/preview/2019-06-01-preview/sqlPools.json - Microsoft.Synapse/preview/2019-06-01-preview/bigDataPools.json - Microsoft.Synapse/preview/2019-06-01-preview/integrationRuntimes.json +- Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/DataFlow.json +- Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Dataset.json +- Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/LinkedService.json +- Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Notebook.json +- Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json +- Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/SparkJobDefinition.json +- Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/SqlScript.json +- Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Trigger.json ``` ### Tag: package-access-control-2020-02-01-preview diff --git a/specification/synapse/data-plane/readme.python.md b/specification/synapse/data-plane/readme.python.md index 0ea1d2fe60b5..997c58f7ae73 100644 --- a/specification/synapse/data-plane/readme.python.md +++ b/specification/synapse/data-plane/readme.python.md @@ -25,6 +25,8 @@ output-folder: $(python-sdks-folder)/synapse/azure-synapse-spark/azure/synapse/s ``` yaml $(package-artifacts) no-namespace-folders: true namespace: azure.synapse.artifacts +modelerfour: + lenient-model-deduplication: true output-folder: $(python-sdks-folder)/synapse/azure-synapse-artifacts/azure/synapse/artifacts ``` ``` yaml $(package-access-control) From c71c7ee745fdfa760118961d871e34b2695cf667 Mon Sep 17 00:00:00 2001 From: Laurent Mazuel Date: Wed, 16 Sep 2020 15:11:10 -0700 Subject: [PATCH 076/164] Fix Python conf for AnomalyDectector (#10818) * Fix Python conf for AnomalyDectector * AI namespace --- .../data-plane/AnomalyDetector/readme.python.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/cognitiveservices/data-plane/AnomalyDetector/readme.python.md b/specification/cognitiveservices/data-plane/AnomalyDetector/readme.python.md index e698a92e151e..f02d74f86624 100644 --- a/specification/cognitiveservices/data-plane/AnomalyDetector/readme.python.md +++ b/specification/cognitiveservices/data-plane/AnomalyDetector/readme.python.md @@ -11,16 +11,16 @@ add-credentials: true credential-default-policy-type: AzureKeyCredentialPolicy credential-key-header-name: Ocp-Apim-Subscription-Key payload-flattening-threshold: 1 -namespace: azure.cognitiveservices.anomalydetector -package-name: azure-cognitiveservices-anomalydetector +namespace: azure.ai.anomalydetector +package-name: azure-ai-anomalydetector package-version: 0.2.0 clear-output-folder: true ``` ``` yaml $(python-mode) == 'update' no-namespace-folders: true -output-folder: $(python-sdks-folder)/cognitiveservices/azure-cognitiveservices-anomalydetector/azure/cognitiveservices/anomalydetector +output-folder: $(python-sdks-folder)/anomalydetector/azure-ai-anomalydetector/azure/ai/anomalydetector ``` ``` yaml $(python-mode) == 'create' basic-setup-py: true -output-folder: $(python-sdks-folder)/cognitiveservices/azure-cognitiveservices-anomalydetector +output-folder: $(python-sdks-folder)/anomalydetector/azure-ai-anomalydetector ``` From 5325e1398eb73e5de8c8a251909763b9e4803150 Mon Sep 17 00:00:00 2001 From: Matt Ellis Date: Wed, 16 Sep 2020 15:49:58 -0700 Subject: [PATCH 077/164] Add CloudEvent and Custom Schema versions of the EventGrid Data-Plane API (#10388) * Add Cloud Events version of the Data Plane API * Add Custom Schema version of the Data Plane API * Run Prettier * Add new words to customwords.txt * Add supression for data_base64 name * Add format type for `data_base64` --- custom-words.txt | 4 + .../stable/2018-01-01/EventGrid.json | 144 +++++++++++++++++- ...shEventsToEventGridTopicAsCloudEvents.json | 22 +++ ...sToEventGridTopicAsCustomSchemaEvents.json | 20 +++ specification/eventgrid/data-plane/readme.md | 9 ++ 5 files changed, 198 insertions(+), 1 deletion(-) create mode 100644 specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/examples/PublishEventsToEventGridTopicAsCloudEvents.json create mode 100644 specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/examples/PublishEventsToEventGridTopicAsCustomSchemaEvents.json diff --git a/custom-words.txt b/custom-words.txt index 70a0bbe84d4e..23d754610419 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -305,6 +305,7 @@ closedlist closedlists Cloudamize cloudapp +cloudevents cloudproperties cloudsimple clustermonitoring @@ -394,6 +395,7 @@ Databricks datacatalog Datacenter datacenters +datacontenttype datadisk datafactory datafactoryv @@ -408,6 +410,7 @@ datamigration datapoint Dataset datasets +dataschema datasource Datasources datastore @@ -1476,6 +1479,7 @@ southindia sparkconf sparql SPDX +specversion SQLAG sqldatabase SQLDB diff --git a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json index 5220d070ce4a..b70b49b75ed7 100644 --- a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json @@ -70,10 +70,93 @@ } } }, + "x-ms-paths": { + "/api/events?overload=cloudEvent": { + "post": { + "consumes": [ + "application/cloudevents-batch+json; charset=utf-8" + ], + "tags": [ + "Events" + ], + "description": "Publishes a batch of events to an Azure Event Grid topic.", + "operationId": "PublishCloudEventEvents", + "parameters": [ + { + "name": "events", + "description": "An array of events to be published to Event Grid.", + "in": "body", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudEventEvent" + } + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error.\n\n * 429 Too Many Events\n\n * 404 Not Found." + } + }, + "x-ms-examples": { + "PublishEventsToEventGridTopicAsCloudEvents": { + "$ref": "./examples/PublishEventsToEventGridTopicAsCloudEvents.json" + } + } + } + }, + "/api/events?overload=customEvent": { + "post": { + "tags": [ + "Events" + ], + "description": "Publishes a batch of events to an Azure Event Grid topic.", + "operationId": "PublishCustomEventEvents", + "parameters": [ + { + "name": "events", + "description": "An array of events to be published to Event Grid.", + "in": "body", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomEventEvent" + } + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error.\n\n * 429 Too Many Events\n\n * 404 Not Found." + } + }, + "x-ms-examples": { + "PublishEventsToEventGridTopicAsCloudEvents": { + "$ref": "./examples/PublishEventsToEventGridTopicAsCustomSchemaEvents.json" + } + } + } + } + }, "definitions": { "EventGridEvent": { "type": "object", - "description": "Properties of an event published to an Event Grid topic.", + "description": "Properties of an event published to an Event Grid topic using the EventGrid Schema.", "required": [ "id", "subject", @@ -119,6 +202,65 @@ } } }, + "CloudEventEvent": { + "type": "object", + "description": "Properties of an event published to an Event Grid topic using the CloudEvent 1.0 Schema", + "required": [ + "type", + "specversion", + "source", + "id" + ], + "properties": { + "id": { + "description": "An identifier for the event. The combination of id and source must be unique for each distinct event.", + "type": "string" + }, + "source": { + "description": "Identifies the context in which an event happened. The combination of id and source must be unique for each distinct event.", + "type": "string" + }, + "data": { + "description": "Event data specific to the event type.", + "type": "object" + }, + "data_base64": { + "description": "Event data specific to the event type, encoded as a base64 string.", + "type": "string", + "format": "byte" + }, + "type": { + "description": "Type of event related to the originating occurrence.", + "type": "string" + }, + "time": { + "description": "The time (in UTC) the event was generated, in RFC3339 format.", + "format": "date-time", + "type": "string" + }, + "specversion": { + "description": "The version of the CloudEvents specification which the event uses.", + "type": "string" + }, + "dataschema": { + "description": "Identifies the schema that data adheres to.", + "type": "string" + }, + "datacontenttype": { + "description": "Content type of data value.", + "type": "string" + }, + "subject": { + "description": "This describes the subject of the event in the context of the event producer (identified by source).", + "type": "string" + } + }, + "additionalProperties": true + }, + "CustomEventEvent": { + "type": "object", + "description": "Properties of an event published to an Event Grid topic using a custom schema" + }, "SubscriptionValidationEventData": { "description": "Schema of the Data property of an EventGridEvent for a Microsoft.EventGrid.SubscriptionValidationEvent.", "type": "object", diff --git a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/examples/PublishEventsToEventGridTopicAsCloudEvents.json b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/examples/PublishEventsToEventGridTopicAsCloudEvents.json new file mode 100644 index 000000000000..8f8d89f0d232 --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/examples/PublishEventsToEventGridTopicAsCloudEvents.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "topicHostname": "mytopic.westcentralus-1.eventgrid.azure.net", + "api-version": "2018-01-01", + "events": [ + { + "id": "b3ccc7e3-c1cb-49bf-b7c8-0d4e60980616", + "source": "/microsoft/autorest/examples/eventgrid/cloud-events/publish", + "specversion": "1.0", + "data": { + "Property1": "Value1", + "Property2": "Value2" + }, + "type": "Microsoft.Contoso.TestEvent", + "time": "2017-12-04T22:06:09.147165Z" + } + ] + }, + "responses": { + "200": {} + } +} diff --git a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/examples/PublishEventsToEventGridTopicAsCustomSchemaEvents.json b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/examples/PublishEventsToEventGridTopicAsCustomSchemaEvents.json new file mode 100644 index 000000000000..cba65d5dce7b --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/examples/PublishEventsToEventGridTopicAsCustomSchemaEvents.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "topicHostname": "mytopic.westcentralus-1.eventgrid.azure.net", + "api-version": "2018-01-01", + "events": [ + { + "sub": "Test event", + "data": { + "Property1": "Value1", + "Property2": "Value2" + }, + "type": "Microsoft.Contoso.TestEvent", + "ver": "1.0" + } + ] + }, + "responses": { + "200": {} + } +} diff --git a/specification/eventgrid/data-plane/readme.md b/specification/eventgrid/data-plane/readme.md index fd7eb6016138..05a8c882b111 100644 --- a/specification/eventgrid/data-plane/readme.md +++ b/specification/eventgrid/data-plane/readme.md @@ -61,6 +61,15 @@ input-file: - Microsoft.Web/stable/2018-01-01/Web.json ``` +### Suppression +``` yaml +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + from: Microsoft.EventGrid/stable/2018-01-01/EventGrid.json + where: $.definitions.CloudEventEvent.properties.data_base64 + reason: This parameter name is defined by the Cloud Events 1.0 specification +``` + --- # Code Generation From f595fe8142bff77ddba974fe8ec53522528eed61 Mon Sep 17 00:00:00 2001 From: Su Shi <1684739+metacpp@users.noreply.github.com> Date: Wed, 16 Sep 2020 23:01:21 -0700 Subject: [PATCH 078/164] Change enum value name for SupportedRuntimeVersion (#10824) * Update appplatform.json * Update appplatform.json --- .../preview/2019-05-01-preview/appplatform.json | 2 +- .../Microsoft.AppPlatform/stable/2020-07-01/appplatform.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json index f09b74a8b617..8787229ed864 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json @@ -3865,7 +3865,7 @@ ], "type": "string", "x-ms-enum": { - "name": "SupportedRuntimeVersion", + "name": "SupportedRuntimeValue", "modelAsString": true } }, diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/appplatform.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/appplatform.json index 655b3cbed58b..5d0e7e8f056c 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/appplatform.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2020-07-01/appplatform.json @@ -4341,7 +4341,7 @@ ], "type": "string", "x-ms-enum": { - "name": "SupportedRuntimeVersion", + "name": "SupportedRuntimeValue", "modelAsString": true } }, From e34240331a664f5a945cd7897e32d348de0b3428 Mon Sep 17 00:00:00 2001 From: changlong-liu <59815250+changlong-liu@users.noreply.github.com> Date: Thu, 17 Sep 2020 17:26:43 +0800 Subject: [PATCH 079/164] python codegen (#10826) --- .../resource-manager/readme.md | 2 ++ .../resource-manager/readme.python.md | 25 ++++++++++++++++--- 2 files changed, 23 insertions(+), 4 deletions(-) diff --git a/specification/streamanalytics/resource-manager/readme.md b/specification/streamanalytics/resource-manager/readme.md index da97ee0bb56d..6fd532ad2a32 100644 --- a/specification/streamanalytics/resource-manager/readme.md +++ b/specification/streamanalytics/resource-manager/readme.md @@ -105,6 +105,8 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net + - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-go - repo: azure-sdk-for-node - repo: azure-sdk-for-js diff --git a/specification/streamanalytics/resource-manager/readme.python.md b/specification/streamanalytics/resource-manager/readme.python.md index 9e43992844d1..f13ae0206aff 100644 --- a/specification/streamanalytics/resource-manager/readme.python.md +++ b/specification/streamanalytics/resource-manager/readme.python.md @@ -4,7 +4,8 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. -``` yaml $(python) + +``` yaml !$(track2) python-mode: create python: azure-arm: true @@ -15,12 +16,28 @@ python: package-version: 0.1.0 clear-output-folder: true ``` -``` yaml $(python) && $(python-mode) == 'update' + +These settings apply only when `--track2` is specified on the command line. + +``` yaml $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-streamanalytics +no-namespace-folders: true +package-version: 0.1.0 +``` + +``` yaml $(python-mode) == 'update' python: no-namespace-folders: true output-folder: $(python-sdks-folder)/streamanalytics/azure-mgmt-streamanalytics/azure/mgmt/streamanalytics +no-namespace-folders: true +output-folder: $(python-sdks-folder)/streamanalytics/azure-mgmt-streamanalytics/azure/mgmt/streamanalytics ``` -``` yaml $(python) && $(python-mode) == 'create' +``` yaml $(python-mode) == 'create' python: basic-setup-py: true - output-folder: $(python-sdks-folder)/streamanalytics/azure-mgmt-streamanalytics \ No newline at end of file + output-folder: $(python-sdks-folder)/streamanalytics/azure-mgmt-streamanalytics +basic-setup-py: true +output-folder: $(python-sdks-folder)/streamanalytics/azure-mgmt-streamanalytics +``` From 434f266391040435a6b473f5d6d0ea4404a89474 Mon Sep 17 00:00:00 2001 From: orieldar Date: Thu, 17 Sep 2020 16:19:36 +0300 Subject: [PATCH 080/164] [Hub Generated] Review request for Microsoft.AlertsManagement to add version stable/2019-03-01 (#10389) * Removed SmartAlerts from 2019-03-01 API * Added alertsmanagement to CODEOWNERS * Add alertsMetaData to match ARM Manifest * Added identifer parameter * Added alertsMetaData example * Removed Smart Groups Examples * Fixed example version * Added MoniterServiceList Definiton * Fixed exccesive parantheses * Added alertsData operation to 2019-03-01-preview * Added monitorServiceList * Removed alertsMetaData example from 2019-03-01-preview * Removed 2019-03-01-preview changes * Removed 2019-03-01-preview changes * Removed alertsMetaData example from 2019-03-01-preview * Added alertsMetaData example from 2019-03-01 * Removed alertsMetaData example from 2019-03-01-preview * Added default response for alertsMetaData --- CODEOWNERS | 1 + .../stable/2019-03-01/AlertsManagement.json | 314 +++++++----------- .../AlertsMetaData_MonitorService.json | 89 +++++ .../examples/SmartGroups_ChangeState.json | 74 ----- .../examples/SmartGroups_GetById.json | 70 ---- .../examples/SmartGroups_History.json | 30 -- .../2019-03-01/examples/SmartGroups_List.json | 145 -------- 7 files changed, 206 insertions(+), 517 deletions(-) create mode 100644 specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/AlertsMetaData_MonitorService.json delete mode 100644 specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/SmartGroups_ChangeState.json delete mode 100644 specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/SmartGroups_GetById.json delete mode 100644 specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/SmartGroups_History.json delete mode 100644 specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/SmartGroups_List.json diff --git a/CODEOWNERS b/CODEOWNERS index c7a94e485dbb..189ce8104fc5 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -1,4 +1,5 @@ /specification/analysisservices/ @taiwu +/specification/alertsmanagement/ @ofirmanor @olalavi @erangon @orieldar @ilaizi @shakednai1 @khaboasb @orenhor /specification/apimanagement/ @promoisha @solankisamir /specification/applicationinsights/ @alexeldeib /specification/asazure/ @athipp diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json index dc6ce3d65350..b5be751defbb 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json @@ -52,6 +52,42 @@ } } }, + "/providers/Microsoft.AlertsManagement/alertsMetaData": { + "get": { + "operationId": "Alerts_MetaData", + "description": "List alerts meta data information based on value of identifier parameter.", + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/identifier" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK. Successfully listed alert meta data.", + "schema": { + "$ref": "#/definitions/alertsMetaData" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AlertsManagementErrorResponse" + } + } + }, + "x-ms-examples": { + "MonService": { + "$ref": "./examples/AlertsMetaData_MonitorService.json" + } + } + } + }, "/{scope}/providers/Microsoft.AlertsManagement/alerts": { "get": { "operationId": "Alerts_GetAll", @@ -325,204 +361,6 @@ } } } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups": { - "get": { - "operationId": "SmartGroups_GetAll", - "summary": "Get all Smart Groups within a specified subscription", - "description": "List all the Smart Groups within a specified subscription. ", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/targetResource" - }, - { - "$ref": "#/parameters/targetResourceGroup" - }, - { - "$ref": "#/parameters/targetResourceType" - }, - { - "$ref": "#/parameters/monitorService" - }, - { - "$ref": "#/parameters/monitorCondition" - }, - { - "$ref": "#/parameters/severity" - }, - { - "$ref": "#/parameters/smartGroupState" - }, - { - "$ref": "#/parameters/timeRange" - }, - { - "$ref": "#/parameters/pageCount" - }, - { - "$ref": "#/parameters/smartGroupsSortBy" - }, - { - "$ref": "#/parameters/sortOrder" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "OK. Returns list of all smartGroups.", - "schema": { - "$ref": "#/definitions/smartGroupsList", - "description": "List of smart groups in value property." - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/AlertsManagementErrorResponse" - } - } - }, - "x-ms-examples": { - "List": { - "$ref": "./examples/SmartGroups_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}": { - "get": { - "operationId": "SmartGroups_GetById", - "summary": "Get information related to a specific Smart Group.", - "description": "Get information related to a specific Smart Group.", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/smartGroupId" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK. Returns the group with the specified smart group Id.", - "headers": { - "x-ms-request-id": { - "type": "string", - "description": "Service generated Request ID." - } - }, - "schema": { - "$ref": "#/definitions/smartGroup" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/AlertsManagementErrorResponse" - } - } - }, - "x-ms-examples": { - "Get": { - "$ref": "./examples/SmartGroups_GetById.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/changeState": { - "post": { - "operationId": "SmartGroups_ChangeState", - "description": "Change the state of a Smart Group.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/smartGroupId" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/newState" - } - ], - "responses": { - "200": { - "description": "OK. Smart Group state updated.", - "headers": { - "x-ms-request-id": { - "type": "string", - "description": "Service generated Request ID." - } - }, - "schema": { - "$ref": "#/definitions/smartGroup" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/AlertsManagementErrorResponse" - } - } - }, - "x-ms-examples": { - "changestate": { - "$ref": "./examples/SmartGroups_ChangeState.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/history": { - "get": { - "operationId": "SmartGroups_GetHistory", - "description": "Get the history a smart group, which captures any Smart Group state changes (New/Acknowledged/Closed) .", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/smartGroupId" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK. Returns the list of changes of smart group.", - "schema": { - "$ref": "#/definitions/smartGroupModification" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/AlertsManagementErrorResponse" - } - } - }, - "x-ms-examples": { - "Resolve": { - "$ref": "./examples/SmartGroups_History.json" - } - } - } } }, "parameters": { @@ -867,6 +705,21 @@ "in": "query", "required": false, "x-ms-parameter-location": "method" + }, + "identifier": { + "name": "identifier", + "description": "Identification of the information to be retrieved by API call.", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "MonitorServiceList" + ], + "x-ms-enum": { + "name": "identifier", + "modelAsString": true + }, + "x-ms-parameter-location": "method" } }, "definitions": { @@ -1388,6 +1241,34 @@ } } }, + "alertsMetaData": { + "description": "alert meta data information.", + "properties": { + "properties": { + "$ref": "#/definitions/alertsMetaDataProperties" + } + } + }, + "alertsMetaDataProperties": { + "description": "alert meta data property bag", + "discriminator": "metadataIdentifier", + "required": [ + "metadataIdentifier" + ], + "properties": { + "metadataIdentifier": { + "type": "string", + "description": "Identification of the information to be retrieved by API call", + "enum": [ + "MonitorServiceList" + ], + "x-ms-enum": { + "name": "metadataIdentifier", + "modelAsString": true + } + } + } + }, "smartGroupsList": { "description": "List the alerts.", "properties": { @@ -1541,6 +1422,43 @@ "description": "Total number of items of type." } } + }, + "MonitorServiceList": { + "title": "Monitor service details", + "description": "Monitor service details", + "required": [ + "data" + ], + "allOf": [ + { + "$ref": "#/definitions/alertsMetaDataProperties" + }, + { + "type": "object" + } + ], + "properties": { + "data": { + "description": "Array of operations", + "type": "array", + "items": { + "$ref": "#/definitions/MonitorServiceDetails" + } + } + } + }, + "MonitorServiceDetails": { + "description": "Details of a monitor service", + "properties": { + "name": { + "type": "string", + "description": "Monitor service name" + }, + "displayName": { + "type": "string", + "description": "Monitor service display name" + } + } } } } diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/AlertsMetaData_MonitorService.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/AlertsMetaData_MonitorService.json new file mode 100644 index 000000000000..41ef963509e3 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/AlertsMetaData_MonitorService.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2019-03-01", + "identifier": "MonitorServiceList" + }, + "responses": { + "200": { + "body": { + "properties": { + "metadataIdentifier": "MonitorServiceList", + "data": [ + { + "name": "ActivityLog Administrative", + "displayName": "Activity Log - Administrative" + }, + { + "name": "ActivityLog Autoscale", + "displayName": "Activity Log - Autoscale" + }, + { + "name": "ActivityLog Policy", + "displayName": "Activity Log - Policy" + }, + { + "name": "ActivityLog Recommendation", + "displayName": "Activity Log - Recommendation" + }, + { + "name": "ActivityLog Security", + "displayName": "Activity Log - Security" + }, + { + "name": "Application Insights", + "displayName": "Application Insights" + }, + { + "name": "Azure Backup", + "displayName": "Azure Backup" + }, + { + "name": "Custom", + "displayName": "Custom" + }, + { + "name": "Data Box Edge", + "displayName": "Data Box Edge" + }, + { + "name": "VM Insights", + "displayName": "VM Insights" + }, + { + "name": "Log Analytics", + "displayName": "Log Analytics" + }, + { + "name": "Nagios", + "displayName": "NAGIOS" + }, + { + "name": "Platform", + "displayName": "Platform" + }, + { + "name": "Resource Health", + "displayName": "Resource Health" + }, + { + "name": "SCOM", + "displayName": "SCOM" + }, + { + "name": "ServiceHealth", + "displayName": "Service Health" + }, + { + "name": "Smart Detector", + "displayName": "SmartDetector" + }, + { + "name": "Zabbix", + "displayName": "ZABBIX" + } + ] + } + } + } + } +} diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/SmartGroups_ChangeState.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/SmartGroups_ChangeState.json deleted file mode 100644 index 9b07e12589e0..000000000000 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/SmartGroups_ChangeState.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "api-version": "2018-05-05", - "subscriptionId": "dd91de05-d791-4ceb-b6dc-988682dc7d72", - "smartGroupId": "a808445e-bb38-4751-85c2-1b109ccc1059", - "newState": "Acknowledged", - "body": { - "comments": "Acknowledging smart group" - } - }, - "responses": { - "200": { - "body": { - "properties": { - "alertsCount": 1942, - "smartGroupState": "Acknowledged", - "severity": "Sev3", - "startDateTime": "2018-06-06T12:35:09Z", - "lastModifiedDateTime": "2018-06-13T06:30:09Z", - "lastModifiedUserName": "System", - "resources": [ - { - "name": "/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int", - "count": 1942 - } - ], - "resourceTypes": [ - { - "name": "components", - "count": 1942 - } - ], - "resourceGroups": [ - { - "name": "alertscorrelationrg", - "count": 1942 - } - ], - "monitorServices": [ - { - "name": "Application Insights", - "count": 1942 - } - ], - "monitorConditions": [ - { - "name": "Fired", - "count": 1942 - } - ], - "alertStates": [ - { - "name": "New", - "count": 1941 - }, - { - "name": "Acknowledged", - "count": 1 - } - ], - "alertSeverities": [ - { - "name": "Sev3", - "count": 1942 - } - ] - }, - "id": "/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups/a808445e-bb38-4751-85c2-1b109ccc1059", - "type": "Microsoft.AlertsManagement/smartGroups", - "name": "cpu alert" - } - } - } -} diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/SmartGroups_GetById.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/SmartGroups_GetById.json deleted file mode 100644 index fb66b322f894..000000000000 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/SmartGroups_GetById.json +++ /dev/null @@ -1,70 +0,0 @@ -{ - "parameters": { - "api-version": "2018-05-05", - "subscriptionId": "9e261de7-c804-4b9d-9ebf-6f50fe350a9a", - "smartGroupId": "603675da-9851-4b26-854a-49fc53d32715" - }, - "responses": { - "200": { - "body": { - "properties": { - "alertsCount": 1942, - "smartGroupState": "New", - "severity": "Sev3", - "startDateTime": "2018-06-06T12:35:09Z", - "lastModifiedDateTime": "2018-06-13T06:30:09Z", - "lastModifiedUserName": "System", - "resources": [ - { - "name": "/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int", - "count": 1942 - } - ], - "resourceTypes": [ - { - "name": "components", - "count": 1942 - } - ], - "resourceGroups": [ - { - "name": "alertscorrelationrg", - "count": 1942 - } - ], - "monitorServices": [ - { - "name": "Application Insights", - "count": 1942 - } - ], - "monitorConditions": [ - { - "name": "Fired", - "count": 1942 - } - ], - "alertStates": [ - { - "name": "New", - "count": 1941 - }, - { - "name": "Acknowledged", - "count": 1 - } - ], - "alertSeverities": [ - { - "name": "Sev3", - "count": 1942 - } - ] - }, - "id": "/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups/a808445e-bb38-4751-85c2-1b109ccc1059", - "type": "Microsoft.AlertsManagement/smartGroups", - "name": "cpu alert" - } - } - } -} diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/SmartGroups_History.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/SmartGroups_History.json deleted file mode 100644 index a3d749f1d6ff..000000000000 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/SmartGroups_History.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "api-version": "2018-05-05", - "subscriptionId": "9e261de7-c804-4b9d-9ebf-6f50fe350a9a", - "smartGroupId": "a808445e-bb38-4751-85c2-1b109ccc1059" - }, - "responses": { - "200": { - "body": { - "properties": { - "smartGroupId": "a808445e-bb38-4751-85c2-1b109ccc1059", - "modifications": [ - { - "modificationEvent": "SmartGroupCreated", - "oldValue": "", - "newValue": "", - "modifiedAt": "2018-06-06T12:35:09Z", - "modifiedBy": "System", - "comments": "", - "description": "New Smart Group is created" - } - ] - }, - "id": "/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/smartGroups/a808445e-bb38-4751-85c2-1b109ccc1059/history/default", - "type": "Microsoft.AlertsManagement/alerts", - "name": "cpu alert" - } - } - } -} diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/SmartGroups_List.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/SmartGroups_List.json deleted file mode 100644 index bf4722bcdb59..000000000000 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/SmartGroups_List.json +++ /dev/null @@ -1,145 +0,0 @@ -{ - "parameters": { - "api-version": "2018-05-05", - "subscriptionId": "dd91de05-d791-4ceb-b6dc-988682dc7d72" - }, - "responses": { - "200": { - "body": { - "nextLink": null, - "value": [ - { - "properties": { - "alertsCount": 1942, - "smartGroupState": "New", - "severity": "Sev3", - "startDateTime": "2018-06-06T12:35:09Z", - "lastModifiedDateTime": "2018-06-13T06:30:09Z", - "lastModifiedUserName": "System", - "resources": [ - { - "name": "/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/alertscorrelationrg/providers/microsoft.insights/components/alertscorrelationworkerrole_int", - "count": 1942 - } - ], - "resourceTypes": [ - { - "name": "components", - "count": 1942 - } - ], - "resourceGroups": [ - { - "name": "alertscorrelationrg", - "count": 1942 - } - ], - "monitorServices": [ - { - "name": "Application Insights", - "count": 1942 - } - ], - "monitorConditions": [ - { - "name": "Fired", - "count": 1942 - } - ], - "alertStates": [ - { - "name": "New", - "count": 1941 - }, - { - "name": "Acknowledged", - "count": 1 - } - ], - "alertSeverities": [ - { - "name": "Sev3", - "count": 1942 - } - ] - }, - "id": "/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups/a808445e-bb38-4751-85c2-1b109ccc1059", - "type": "Microsoft.AlertsManagement/smartGroups", - "name": "cpu alert" - }, - { - "properties": { - "alertsCount": 15374, - "smartGroupState": "Acknowledged", - "severity": "Sev0", - "startDateTime": "2018-05-17T10:18:44.2020997Z", - "lastModifiedDateTime": "2018-06-13T06:29:01Z", - "lastModifiedUserName": "System", - "resources": [ - { - "name": "/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/resourcegroups/mms-eus/providers/microsoft.operationalinsights/workspaces/alertsint", - "count": 15374 - } - ], - "resourceTypes": [ - { - "name": "microsoft.operationalinsights/workspaces", - "count": 6912 - }, - { - "name": "workspaces", - "count": 8462 - } - ], - "resourceGroups": [ - { - "name": "mms-eus", - "count": 15374 - } - ], - "monitorServices": [ - { - "name": "Log Analytics", - "count": 13911 - } - ], - "monitorConditions": [ - { - "name": "Fired", - "count": 15374 - } - ], - "alertStates": [ - { - "name": "New", - "count": 15358 - }, - { - "name": "Acknowledged", - "count": 12 - }, - { - "name": "Closed", - "count": 4 - } - ], - "alertSeverities": [ - { - "name": "Sev0", - "count": 6984 - }, - { - "name": "Sev1", - "count": 6927 - } - ] - }, - "id": "/subscriptions/dd91de05-d791-4ceb-b6dc-988682dc7d72/providers/Microsoft.AlertsManagement/smartGroups/01114c7c-769f-4fd4-b6fa-ab77693b83cd", - "type": "Microsoft.AlertsManagement/smartGroups", - "name": "CPU Alert" - } - ] - } - } - } -} From 2bb9298116c56cd4e0c4fb99f89d39d9b4ee0921 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Au=C3=B0unn?= Date: Thu, 17 Sep 2020 14:55:03 +0000 Subject: [PATCH 081/164] Corrected case in operation ids (#10811) Co-authored-by: Audunn Baldvinsson --- .../stable/2020-06-01/netapp.json | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/netapp.json index 70b86d93eac1..f177ba0e6d73 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/netapp.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2020-06-01/netapp.json @@ -1683,7 +1683,7 @@ "tags": [ "Snapshot Policy" ], - "operationId": "snapshotPolicies_Get", + "operationId": "SnapshotPolicies_Get", "description": "Get a snapshot Policy", "responses": { "200": { @@ -1706,7 +1706,7 @@ "tags": [ "Snapshot Policy" ], - "operationId": "snapshotPolicies_Create", + "operationId": "SnapshotPolicies_Create", "description": "Create a snapshot policy", "parameters": [ { @@ -1747,7 +1747,7 @@ "tags": [ "Snapshot Policy" ], - "operationId": "snapshotPolicies_Update", + "operationId": "SnapshotPolicies_Update", "description": "Patch a snapshot policy", "parameters": [ { @@ -1781,7 +1781,7 @@ "tags": [ "Snapshot Policy" ], - "operationId": "snapshotPolicies_Delete", + "operationId": "SnapshotPolicies_Delete", "description": "Delete snapshot policy", "responses": { "200": { @@ -2296,7 +2296,7 @@ ], "summary": "Get a backup Policy", "description": "Get a particular backup Policy", - "operationId": "backupPolicies_Get", + "operationId": "BackupPolicies_Get", "parameters": [ { "$ref": "#/parameters/SubscriptionId" @@ -2337,7 +2337,7 @@ ], "summary": "Create a backup policy", "description": "Create a backup policy for Netapp Account", - "operationId": "backupPolicies_Create", + "operationId": "BackupPolicies_Create", "parameters": [ { "$ref": "#/parameters/SubscriptionId" @@ -2397,7 +2397,7 @@ ], "summary": "Patch a backup policy", "description": "Patch a backup policy for Netapp Account", - "operationId": "backupPolicies_Update", + "operationId": "BackupPolicies_Update", "parameters": [ { "$ref": "#/parameters/SubscriptionId" @@ -2447,7 +2447,7 @@ ], "summary": "Delete a backup policy", "description": "Delete backup policy", - "operationId": "backupPolicies_Delete", + "operationId": "BackupPolicies_Delete", "parameters": [ { "$ref": "#/parameters/SubscriptionId" From 3aa6a51349b07a7b8672ee0fdf8ba5dbeee31153 Mon Sep 17 00:00:00 2001 From: Chris Henk Date: Thu, 17 Sep 2020 09:49:49 -0700 Subject: [PATCH 082/164] Document IMDS version 2020-06-01 (#10426) * document new api version * cr feedback * Supress camel casing errors * fixes * Add UEFI to custom words * Fix api version * cr feedback Co-authored-by: Chris Henk --- custom-words.txt | 1 + .../2020-06-01/examples/GetAttestedData.json | 15 + .../2020-06-01/examples/GetIdentityInfo.json | 13 + .../2020-06-01/examples/GetIdentityToken.json | 20 + .../examples/GetInstanceMetadata.json | 117 +++ .../stable/2020-06-01/imds.json | 883 ++++++++++++++++++ specification/imds/data-plane/readme.md | 24 + 7 files changed, 1073 insertions(+) create mode 100644 specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2020-06-01/examples/GetAttestedData.json create mode 100644 specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2020-06-01/examples/GetIdentityInfo.json create mode 100644 specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2020-06-01/examples/GetIdentityToken.json create mode 100644 specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2020-06-01/examples/GetInstanceMetadata.json create mode 100644 specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2020-06-01/imds.json diff --git a/custom-words.txt b/custom-words.txt index 23d754610419..c064b70c886f 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1640,6 +1640,7 @@ Turbonomic Txns Typeless typeperf +UEFI UEBA Uint uksouth diff --git a/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2020-06-01/examples/GetAttestedData.json b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2020-06-01/examples/GetAttestedData.json new file mode 100644 index 000000000000..43b01f911cff --- /dev/null +++ b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2020-06-01/examples/GetAttestedData.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "nonce": "abcde12345", + "Metadata": "true" + }, + "responses": { + "200": { + "body": { + "encoding": "pkcs7", + "signature": "MIID2gYJKoZIhvcNAQcCoIIDyzCCA8cCAQExDzANBgkqhkiG9w0BAQsFADCBggYJKoZIhvcNAQcBoHUEc3sibm9uY2UiOiIxMTExMTExMTExIiwicGxhbiI6eyJuYW1lIjoiIiwicHJvZHVjdCI6IiIsInB1Ymxpc2hlciI6IiJ9LCJ2bUlkIjoiMDJhYWI4YTQtNzRlZi00NzZlLTgxODItZjZkMmJhNDE2NmE2In2gggI/MIICOzCCAaSgAwIBAgIQQWsFjXN35oBJKFXI3QrM3TANBgkqhkiG9w0BAQQFADArMSkwJwYDVQQDEyB0ZXN0c3ViZG9tYWluLm1ldGFkYXRhLmF6dXJlLmNvbTAeFw0xODExMDgxODUzMDRaFw0xODEyMDgxODUzMDNaMCsxKTAnBgNVBAMTIHRlc3RzdWJkb21haW4ubWV0YWRhdGEuYXp1cmUuY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDEi0FVslYnUX+MneC7ERMU4ZM88z4J80r7RPgvzxCPNhXUQlWm3cmVRZMD8kKMv7brkvEsATP7Ak60/I/XEtOga4LGCvMaQa8I/MW8IhSyp2Vj015glAiV8TeUI5DuOIOS96lQvM+G7bt23swkIwVjm1u1ViTZiKKytwpY/EGqzQIDAQABo2AwXjBcBgNVHQEEVTBTgBAt3MRgJmEoUMiPy7k06cLfoS0wKzEpMCcGA1UEAxMgdGVzdHN1YmRvbWFpbi5tZXRhZGF0YS5henVyZS5jb22CEEFrBY1zd+aASShVyN0KzN0wDQYJKoZIhvcNAQEEBQADgYEAd87qiZnRlGIFQ5IEcL/A7ru23WSQAOBsNPt70Fg1GtaEHcYshKUJFhGwXOgZ11cY5wRfrSvEKuzvhAeIZwkvzkBjC04g8sRrjN5leLY5CsKzQhjN52TUMsHhqTM58tfAnICeTddQwn6LOgfqtYH5WO+F/VbFCwPstYUqjmQEYAoxgegwgeUCAQEwPzArMSkwJwYDVQQDEyB0ZXN0c3ViZG9tYWluLm1ldGFkYXRhLmF6dXJlLmNvbQIQQWsFjXN35oBJKFXI3QrM3TANBgkqhkiG9w0BAQsFADANBgkqhkiG9w0BAQEFAASBgCbkRKmQ1MdWZPVOrX7ZBKHQUWPFrQQNdjk3KB67GkY0W0Taxut4K7D2PmiflVEwxB92pTbaZZr/dldu1k1ab1YamHcVYdgZgxIkoOWohGR0ym8oL9JHjFMEqHUbEPtDwE8X+djtDd8TVdb6LYe77IXmz/VaX4whuejlSvQXjaL" + } + } + } +} diff --git a/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2020-06-01/examples/GetIdentityInfo.json b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2020-06-01/examples/GetIdentityInfo.json new file mode 100644 index 000000000000..38e36e9316f8 --- /dev/null +++ b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2020-06-01/examples/GetIdentityInfo.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "Metadata": "true" + }, + "responses": { + "200": { + "body": { + "tenantId": "abd8daee-d393-4239-9377-883adda3d40f" + } + } + } +} diff --git a/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2020-06-01/examples/GetIdentityToken.json b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2020-06-01/examples/GetIdentityToken.json new file mode 100644 index 000000000000..7b673d8d3492 --- /dev/null +++ b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2020-06-01/examples/GetIdentityToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "Metadata": "true", + "resource": "https://vault.azure.net" + }, + "responses": { + "200": { + "body": { + "access_token": "dummytoken", + "client_id": "be5947ed-3560-4afe-9504-59967a63f810", + "expires_in": "3599", + "expires_on": "1541705014", + "ext_expires_in": "262800", + "not_before": "1508961830", + "resource": "https://va" + } + } + } +} diff --git a/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2020-06-01/examples/GetInstanceMetadata.json b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2020-06-01/examples/GetInstanceMetadata.json new file mode 100644 index 000000000000..e0353464269c --- /dev/null +++ b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2020-06-01/examples/GetInstanceMetadata.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "Metadata": "true" + }, + "responses": { + "200": { + "body": { + "compute": { + "azEnvironment": "AZUREPUBLICCLOUD", + "isHostCompatibilityLayerVm": "true", + "location": "westus", + "name": "examplevmname", + "offer": "Windows", + "osType": "linux", + "placementGroupId": "f67c14ab-e92c-408c-ae2d-da15866ec79a", + "plan": { + "name": "planName", + "product": "planProduct", + "publisher": "planPublisher" + }, + "platformFaultDomain": "36", + "platformUpdateDomain": "42", + "provider": "Microsoft.Compute", + "publicKeys": [ + { + "keyData": "ssh-rsa 0", + "path": "/home/user/.ssh/authorized_keys0" + }, + { + "keyData": "ssh-rsa 1", + "path": "/home/user/.ssh/authorized_keys1" + } + ], + "publisher": "RDFE-Test-Microsoft-Windows-Server-Group", + "resourceGroupName": "macikgo-test-may-23", + "resourceId": "/subscriptions/8d10da13-8125-4ba9-a717-bf7490507b3d/resourceGroups/macikgo-test-may-23/providers/Microsoft.Compute/virtualMachines/examplevmname", + "securityProfile": { + "secureBootEnabled": "true", + "virtualTpmEnabled": "false" + }, + "sku": "Windows-Server-2012-R2-Datacenter", + "storageProfile": { + "dataDisks": [ + { + "caching": "None", + "createOption": "Empty", + "diskSizeGB": "1024", + "image": { + "uri": "" + }, + "lun": "0", + "managedDisk": { + "id": "/subscriptions/8d10da13-8125-4ba9-a717-bf7490507b3d/resourceGroups/macikgo-test-may-23/providers/Microsoft.Compute/disks/exampledatadiskname", + "storageAccountType": "Standard_LRS" + }, + "name": "exampledatadiskname", + "vhd": { + "uri": "" + }, + "writeAcceleratorEnabled": "false" + } + ], + "imageReference": { + "id": "", + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "16.04.0-LTS", + "version": "latest" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "diskSizeGB": "30", + "diffDiskSettings": { + "option": "Local" + }, + "encryptionSettings": { + "enabled": "false" + }, + "image": { + "uri": "" + }, + "managedDisk": { + "id": "/subscriptions/8d10da13-8125-4ba9-a717-bf7490507b3d/resourceGroups/macikgo-test-may-23/providers/Microsoft.Compute/disks/exampleosdiskname", + "storageAccountType": "Standard_LRS" + }, + "name": "exampleosdiskname", + "osType": "Linux", + "vhd": { + "uri": "" + }, + "writeAcceleratorEnabled": "false" + } + }, + "subscriptionId": "8d10da13-8125-4ba9-a717-bf7490507b3d", + "tags": "baz:bash;foo:bar", + "tagsList": [ + { + "name": "baz", + "value": "bash" + }, + { + "name": "foo", + "value": "bar" + } + ], + "version": "15.05.22", + "vmId": "02aab8a4-74ef-476e-8182-f6d2ba4166a6", + "vmScaleSetName": "crpteste9vflji9", + "vmSize": "Standard_A3", + "zone": "" + } + } + } + } +} diff --git a/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2020-06-01/imds.json b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2020-06-01/imds.json new file mode 100644 index 000000000000..3559c66fe3e7 --- /dev/null +++ b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2020-06-01/imds.json @@ -0,0 +1,883 @@ +{ + "swagger": "2.0", + "info": { + "title": "InstanceMetadataClient", + "description": "The Azure Instance Metadata Client", + "version": "2020-06-01" + }, + "host": "169.254.169.254", + "basePath": "/metadata", + "schemes": [ + "http", + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "basic_auth": { + "type": "basic", + "description": "A Basic authentication flow" + } + }, + "paths": { + "/instance": { + "get": { + "operationId": "Instances_GetMetadata", + "description": "Get Instance Metadata for the Virtual Machine.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/MetadataParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Instance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Instance Metadata for the VM": { + "$ref": "./examples/GetInstanceMetadata.json" + } + } + } + }, + "/attested/document": { + "get": { + "operationId": "Attested_GetDocument", + "description": "Get Attested Data for the Virtual Machine.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "nonce", + "in": "query", + "required": false, + "type": "string", + "description": "This is a string of up to 32 random alphanumeric characters." + }, + { + "$ref": "#/parameters/MetadataParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AttestedData" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Attested Data for the VM": { + "$ref": "./examples/GetAttestedData.json" + } + } + } + }, + "/identity/oauth2/token": { + "get": { + "tags": [ + "Get token" + ], + "description": "Get a Token from Azure AD", + "operationId": "Identity_GetToken", + "produces": [ + "application/json" + ], + "security": [ + {}, + { + "basic_auth": [] + } + ], + "parameters": [ + { + "$ref": "#/parameters/MetadataParameter" + }, + { + "name": "resource", + "in": "query", + "type": "string", + "description": "This is the urlencoded identifier URI of the sink resource for the requested Azure AD token. The resulting token contains the corresponding aud for this resource.", + "required": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "client_id", + "in": "query", + "type": "string", + "description": "This identifies, by Azure AD client id, a specific explicit identity to use when authenticating to Azure AD. Mutually exclusive with object_id and msi_res_id.", + "required": false + }, + { + "name": "object_id", + "in": "query", + "type": "string", + "description": "This identifies, by Azure AD object id, a specific explicit identity to use when authenticating to Azure AD. Mutually exclusive with client_id and msi_res_id.", + "required": false + }, + { + "name": "msi_res_id", + "in": "query", + "type": "string", + "description": "This identifies, by urlencoded ARM resource id, a specific explicit identity to use when authenticating to Azure AD. Mutually exclusive with client_id and object_id.", + "required": false + }, + { + "name": "authority", + "in": "query", + "type": "string", + "description": "This indicates the authority to request AAD tokens from. Defaults to the known authority of the identity to be used.", + "required": false + }, + { + "name": "bypass_cache", + "in": "query", + "type": "string", + "enum": [ + "true" + ], + "description": "If provided, the value must be 'true'. This indicates to the server that the token must be retrieved from Azure AD and cannot be retrieved from an internal cache.", + "required": false, + "x-ms-enum": { + "name": "BypassCache", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "$ref": "#/definitions/IdentityTokenResponse" + } + }, + "default": { + "headers": { + "Www-Authenticate": { + "type": "string", + "description": "This is the response header containing a challenge for the Basic scheme with a realm value" + } + }, + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/IdentityErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Identity Token for the VM": { + "$ref": "./examples/GetIdentityToken.json" + } + } + } + }, + "/identity/info": { + "get": { + "tags": [ + "Get metadata information" + ], + "description": "Get information about AAD Metadata", + "operationId": "Identity_GetInfo", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/MetadataParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "$ref": "#/definitions/IdentityInfoResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/IdentityErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Identity Info for the VM": { + "$ref": "./examples/GetIdentityInfo.json" + } + } + } + } + }, + "definitions": { + "Compute": { + "type": "object", + "properties": { + "azEnvironment": { + "type": "string", + "description": "This is the name of the environment in which the VM is running." + }, + "isHostCompatibilityLayerVm": { + "type": "string", + "description": "Identifies if the VM runs on the Host Compatibility Layer." + }, + "location": { + "type": "string", + "description": "This is the Azure Region in which the VM is running." + }, + "name": { + "type": "string", + "description": "This is the name of the VM." + }, + "offer": { + "type": "string", + "description": "This is the offer information for the VM image. This value is only present for images deployed from the Azure Image Gallery." + }, + "osType": { + "type": "string", + "description": "This value indicates the type of OS the VM is running, either Linux or Windows." + }, + "placementGroupId": { + "type": "string", + "description": "This is the placement group of your Virtual Machine Scale Set." + }, + "plan": { + "type": "object", + "description": "This contains the data about the plan.", + "$ref": "#/definitions/PlanProperties" + }, + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/PublicKeysProperties" + }, + "description": "This is information about the SSH certificate" + }, + "platformFaultDomain": { + "type": "string", + "description": "This is the fault domain in which the VM." + }, + "platformUpdateDomain": { + "type": "string", + "description": "This is the update domain in which the VM." + }, + "provider": { + "type": "string", + "description": "This is the provider of the VM." + }, + "publisher": { + "type": "string", + "description": "This is the publisher of the VM image." + }, + "resourceGroupName": { + "type": "string", + "description": "This is the resource group for the VM." + }, + "resourceId": { + "type": "string", + "description": "This is the fully qualified ID for the VM." + }, + "securityProfile": { + "description": "This contains the data about the security profile associated with the VM.", + "$ref": "#/definitions/SecurityProfile" + }, + "sku": { + "type": "string", + "description": "This is the specific SKU for the VM image." + }, + "storageProfile": { + "type": "object", + "description": "This contains the data about the storage disks associated with the VM.", + "$ref": "#/definitions/StorageProfile" + }, + "subscriptionId": { + "type": "string", + "description": "This is the Azure subscription for the VM." + }, + "tags": { + "type": "string", + "description": "This is the list of tags for your VM." + }, + "tagsList": { + "type": "array", + "items": { + "$ref": "#/definitions/TagsProperties" + }, + "description": "This is the list of tags for your VM formatted as a JSON array for easier programmatic parsing." + }, + "version": { + "type": "string", + "description": "This is the version of the VM image." + }, + "vmId": { + "type": "string", + "description": "This is the unique identifier for the VM." + }, + "vmScaleSetName": { + "type": "string", + "description": "This is the resource name of the VMSS." + }, + "vmSize": { + "type": "string", + "description": "This is the size of the VM." + }, + "zone": { + "type": "string", + "description": "This is the availability zone of the VM." + } + }, + "description": "Compute Metadata" + }, + "Network": { + "type": "object", + "properties": { + "interface": { + "type": "array", + "description": "This contains data about the network interface.", + "items": { + "type": "object", + "$ref": "#/definitions/NetworkInterface" + } + } + }, + "description": "Network Metadata" + }, + "NetworkInterface": { + "type": "object", + "description": "This contains data about the network interface.", + "properties": { + "ipv4": { + "type": "object", + "description": "This contains the IPv4 address.", + "properties": { + "ipAddress": { + "type": "array", + "description": "This is the IP address", + "items": { + "type": "object", + "description": "This contains the IPv4 properties.", + "$ref": "#/definitions/Ipv4Properties" + } + }, + "subnet": { + "type": "array", + "description": "This is the subnet", + "items": { + "type": "object", + "description": "This contains the subnet properties.", + "$ref": "#/definitions/SubnetProperties" + } + } + } + }, + "ipv6": { + "type": "object", + "description": "This contains the IPv6 address.", + "properties": { + "ipAddress": { + "type": "array", + "description": "This is the IP address", + "items": { + "type": "object", + "description": "This contains the IPv6 properties.", + "$ref": "#/definitions/Ipv6Properties" + } + } + } + }, + "macAddress": { + "type": "string", + "description": "This is the MAC address of the interface." + } + } + }, + "PlanProperties": { + "type": "object", + "description": "This contains the data about the plan.", + "properties": { + "name": { + "type": "string", + "description": "This is the Plan ID." + }, + "publisher": { + "type": "string", + "description": "This is the publisher ID." + }, + "product": { + "type": "string", + "description": "This is the product of the image from the Marketplace." + } + } + }, + "PublicKeysProperties": { + "type": "object", + "description": "This contains the data about the public key.", + "properties": { + "path": { + "type": "string", + "description": "This specifies the full path on the VM where the SSH public key is stored." + }, + "keyData": { + "type": "string", + "description": "This is the SSH public key certificate used to authenticate with the VM." + } + } + }, + "TagsProperties": { + "type": "object", + "description": "This contains the properties of the tags in a tagsList.", + "properties": { + "name": { + "type": "string", + "description": "This is the name of the tag. It is equivalent to the key in the key-value pair format." + }, + "value": { + "type": "string", + "description": "This is the value of the tag. It is, as expected, equivalent to the value in the key-value pair format." + } + } + }, + "Ipv4Properties": { + "type": "object", + "description": "This contains the IPv4 properties.", + "properties": { + "privateIpAddress": { + "type": "string", + "description": "This is the private IP address assigned to the interface." + }, + "publicIpAddress": { + "type": "string", + "description": "This is the public IP address assigned to the interface." + } + } + }, + "Ipv6Properties": { + "type": "object", + "description": "This contains the IPv6 properties.", + "properties": { + "privateIpAddress": { + "type": "string", + "description": "This is the private IPv6 address assigned to the interface." + } + } + }, + "SubnetProperties": { + "type": "object", + "description": "This contains the properties of the subnet.", + "properties": { + "address": { + "type": "string", + "description": "This is the address range of the subnet." + }, + "prefix": { + "type": "string", + "description": "This is the prefix of the subnet." + } + } + }, + "SecurityProfile": { + "type": "object", + "description": "This contains the data about the security profile associated with the VM.", + "properties": { + "secureBootEnabled": { + "type": "string", + "description": "Identifies if UEFI secure boot is enabled on the VM" + }, + "virtualTpmEnabled": { + "type": "string", + "description": "Identifies if the virtual Trusted Platform Module (TPM) is enabled on the VM" + } + } + }, + "StorageProfile": { + "type": "object", + "description": "This contains the data about the storage disks associated with the VM.", + "properties": { + "imageReference": { + "type": "object", + "$ref": "#/definitions/ImageReference", + "description": "Image information" + }, + "osDisk": { + "type": "object", + "$ref": "#/definitions/OsDisk", + "description": "OS disk information" + }, + "dataDisks": { + "type": "array", + "description": "Data disk information", + "items": { + "type": "object", + "description": "This contains information about the data disk.", + "$ref": "#/definitions/DataDisk" + } + } + } + }, + "ImageReference": { + "type": "object", + "description": "This contains information about the OS image.", + "properties": { + "id": { + "type": "string", + "description": "This is the resource ID." + }, + "offer": { + "type": "string", + "description": "This is the offer of the platform or marketplace image." + }, + "publisher": { + "type": "string", + "description": "This is the image publisher." + }, + "sku": { + "type": "string", + "description": "This is the image SKU." + }, + "version": { + "type": "string", + "description": "This is the version of the platform or marketplace image." + } + } + }, + "OsDisk": { + "type": "object", + "description": "This contains information about the OS disk used by the VM.", + "properties": { + "caching": { + "type": "string", + "description": "This is the caching requirements." + }, + "createOption": { + "type": "string", + "description": "This is information about how the VM was created." + }, + "diffDiskSettings": { + "type": "object", + "description": "This is the ephemeral disk settings.", + "$ref": "#/definitions/DiffDiskSettings" + }, + "diskSizeGB": { + "type": "string", + "description": "This is the size of the disk in GB." + }, + "encryptionSettings": { + "type": "object", + "description": "This is the encryption settings for the disk.", + "$ref": "#/definitions/EncryptionSettings" + }, + "image": { + "type": "object", + "description": "This is the source user image virtual hard disk.", + "$ref": "#/definitions/DiskImage" + }, + "managedDisk": { + "type": "object", + "description": "This is managed disk parameters.", + "$ref": "#/definitions/ManagedDisk" + }, + "name": { + "type": "string", + "description": "This is the disk name." + }, + "osType": { + "type": "string", + "description": "This is the type of OS included in the disk." + }, + "vhd": { + "type": "object", + "description": "This is the virtual hard disk.", + "$ref": "#/definitions/VirtualHardDisk" + }, + "writeAcceleratorEnabled": { + "type": "string", + "description": "This specifies whether or not writeAccelerator is enabled on the disk." + } + } + }, + "DataDisk": { + "type": "object", + "description": "This contains information about the data disk.", + "properties": { + "caching": { + "type": "string", + "description": "This is the caching requirements." + }, + "createOption": { + "type": "string", + "description": "This is information about how the VM was created." + }, + "diskSizeGB": { + "type": "string", + "description": "This is the size of the disk in GB." + }, + "image": { + "type": "object", + "description": "This is the source user image virtual hard disk.", + "$ref": "#/definitions/DiskImage" + }, + "lun": { + "type": "string", + "description": "This is the logical unit number of the disk." + }, + "managedDisk": { + "type": "object", + "description": "This is managed disk parameters.", + "$ref": "#/definitions/ManagedDisk" + }, + "name": { + "type": "string", + "description": "This is the disk name." + }, + "vhd": { + "type": "object", + "description": "This is the virtual hard disk.", + "$ref": "#/definitions/VirtualHardDisk" + }, + "writeAcceleratorEnabled": { + "type": "string", + "description": "This specifies whether or not writeAccelerator is enabled on the disk." + } + } + }, + "EncryptionSettings": { + "type": "object", + "description": "This is the encryption settings for the disk.", + "properties": { + "enabled": { + "type": "string", + "description": "This specifies whether or not disk encryption is enabled on the VM." + } + } + }, + "DiffDiskSettings": { + "type": "object", + "description": "This is the ephemeral disk settings.", + "properties": { + "option": { + "type": "string", + "description": "This specifies the ephemeral disk settings." + } + } + }, + "DiskImage": { + "type": "object", + "description": "This is the source user image virtual hard disk.", + "properties": { + "uri": { + "type": "string", + "description": "This is the uri of the virtual hard disk." + } + } + }, + "ManagedDisk": { + "type": "object", + "description": "This is managed disk parameters.", + "properties": { + "id": { + "type": "string", + "description": "This is the resource ID." + }, + "storageAccountType": { + "type": "string", + "description": "This is the storage account type for the managed disk." + } + } + }, + "VirtualHardDisk": { + "type": "object", + "description": "This is the virtual hard disk.", + "properties": { + "uri": { + "type": "string", + "description": "This is the uri of the virtual hard disk." + } + } + }, + "ApplicationResponse": { + "type": "string", + "description": "This is a binary string containing the application." + }, + "Instance": { + "type": "object", + "description": "This is the response from the Instance_GetMetadata operation.", + "properties": { + "compute": { + "$ref": "#/definitions/Compute", + "description": "Compute Metadata" + }, + "network": { + "$ref": "#/definitions/Network", + "description": "Network Metadata" + } + } + }, + "AttestedData": { + "type": "object", + "description": "This is the response from the Attested_GetDocument operation.", + "properties": { + "signature": { + "type": "string", + "description": "This is the encoded string containing the VM ID, SKU, plan information, public key, timestamp, and nonce value." + }, + "encoding": { + "type": "string", + "description": "This is the encoding scheme of the signature." + } + } + }, + "ErrorResponse": { + "description": "This is the response from an operation in the case an error occurs.", + "type": "object", + "properties": { + "error": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, + "IdentityErrorResponse": { + "type": "object", + "description": "This is the response from an Identity operation in the case an error occurs.", + "properties": { + "error": { + "type": "string", + "description": "Error code", + "enum": [ + "invalid_request", + "unauthorized_client", + "access_denied", + "unsupported_response_type", + "invalid_scope", + "server_error", + "service_unavailable", + "bad_request", + "forbidden", + "not_found", + "method_not_allowed", + "too_many_requests" + ], + "x-ms-enum": { + "name": "Error", + "modelAsString": true + } + }, + "error_description": { + "type": "string", + "description": "Error message indicating why the operation failed." + } + } + }, + "IdentityTokenResponse": { + "type": "object", + "description": "This is the response from the Identity_GetToken operation.", + "properties": { + "access_token": { + "type": "string", + "description": "This is the requested access token. The app can use this token to authenticate to the sink resource." + }, + "expires_in": { + "type": "string", + "description": "This is how long the access token is valid (in seconds)." + }, + "expires_on": { + "type": "string", + "description": "This is the time when the access token expires. The date is represented as the number of seconds from 1970-01-01T0:0:0Z UTC until the expiration time. This value is used to determine the lifetime of cached tokens." + }, + "ext_expires_in": { + "type": "string", + "description": "This indicates the extended lifetime of the token (in seconds)." + }, + "not_before": { + "type": "string", + "description": "This is the time when the access token becomes effective. The date is represented as the number of seconds from 1970-01-01T0:0:0Z UTC until the expiration time." + }, + "resource": { + "type": "string", + "description": "This is the app ID URI of the sink resource." + }, + "token_type": { + "type": "string", + "description": "This indicates the token type value." + }, + "client_id": { + "type": "string", + "description": "This is the client_id specified in the request, if any." + }, + "object_id": { + "type": "string", + "description": "This is the object_id specified in the request, if any." + }, + "msi_res_id": { + "type": "string", + "description": "This is the msi_res_id specified in the request, if any." + } + } + }, + "IdentityInfoResponse": { + "type": "object", + "description": "This is the response from the Identity_GetInfo operation.", + "properties": { + "tenantId": { + "type": "string", + "description": "This is the AAD tenantId of the identity of the system assigned managed identity." + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "type": "string", + "enum": [ + "2018-10-01" + ], + "description": "This is the API version to use.", + "required": true, + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + } + }, + "MetadataParameter": { + "name": "Metadata", + "in": "header", + "type": "string", + "enum": [ + "true" + ], + "description": "This must be set to 'true'.", + "required": true, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/imds/data-plane/readme.md b/specification/imds/data-plane/readme.md index 8202bc8b0956..50d959f25654 100644 --- a/specification/imds/data-plane/readme.md +++ b/specification/imds/data-plane/readme.md @@ -106,6 +106,14 @@ These settings apply only when `--tag=package-2019-11-01` is specified on the co input-file: - Microsoft.InstanceMetadataService/stable/2019-11-01/imds.json ``` +### Tag: package-2020-06-01 + +These settings apply only when `--tag=package-2020-06-01` is specified on the command line. + +```yaml $(tag) == 'package-2020-06-01' +input-file: +- Microsoft.InstanceMetadataService/stable/2020-06-01/imds.json +``` ## Suppression ``` yaml @@ -259,6 +267,22 @@ input-file: - $.definitions.IdentityTokenResponse.properties.object_id - $.definitions.IdentityTokenResponse.properties.msi_res_id - $.definitions.IdentityErrorResponse.properties.error_description + + - suppress: DefinitionsPropertiesNamesCamelCase + reason: The following properties follow the Oath2 spec, which does not use camelCase. + from: Microsoft.InstanceMetadataService/stable/2020-06-01/imds.json + where: + - $.definitions.IdentityTokenResponse.properties.access_token + - $.definitions.IdentityTokenResponse.properties.expires_in + - $.definitions.IdentityTokenResponse.properties.expires_on + - $.definitions.IdentityTokenResponse.properties.ext_expires_in + - $.definitions.IdentityTokenResponse.properties.not_before + - $.definitions.IdentityTokenResponse.properties.resource + - $.definitions.IdentityTokenResponse.properties.token_type + - $.definitions.IdentityTokenResponse.properties.client_id + - $.definitions.IdentityTokenResponse.properties.object_id + - $.definitions.IdentityTokenResponse.properties.msi_res_id + - $.definitions.IdentityErrorResponse.properties.error_description ``` --- From 75f089d9f9a70f0553fe1419345fbadd54bb9b10 Mon Sep 17 00:00:00 2001 From: rapatank <69176921+rapatank@users.noreply.github.com> Date: Thu, 17 Sep 2020 16:36:29 -0700 Subject: [PATCH 083/164] Adding PowerPlatform swagger. (#10651) * PowerPlatform RP specifications * PowerPlatform changes * Updating powerplatform json * Update definitions.json * Updating the schema * Updated the schema. * Updates to schema * Schema update * Schema update * Example update * Update description * Updating the swagger * Updating the swagger definition * Swagger update. * Swagger updates * Adding private link changes. * Updates to readme.md * Private link updates * Schema update * private link update * response update * Added systemData * Updated description. * Adding subnet configuration * readme update. * Adding systemData. * Updated example * Update * Update to systemData * Updates * Updates * Updated the version of common types * readme.go update * Update * Updated version * version update * update * update * Updated "enterprisePromise" to "enterprisePolicy". * Updates * Updates * Updating to use common type * updates --- azure-rest-api-specs | 1 + .../common/v1/definitions.json | 190 +++++++ .../2020-10-30-preview/enterprisePolicy.json | 514 ++++++++++++++++++ .../PrivateEndpointConnectionDelete.json | 14 + .../PrivateEndpointConnectionGet.json | 28 + .../PrivateEndpointConnectionListGet.json | 46 ++ .../PrivateEndpointConnectionUpdate.json | 37 ++ .../examples/PrivateLinkResourceGet.json | 25 + .../examples/PrivateLinkResourceListGet.json | 36 ++ .../createOrUpdateEnterprisePolicy.json | 53 ++ .../examples/deleteEnterprisePolicy.json | 12 + .../examples/getEnterprisePolicy.json | 24 + ...listEnterprisePoliciesByResourceGroup.json | 56 ++ .../listEnterprisePoliciesBySubscription.json | 51 ++ .../examples/listOperations.json | 36 ++ .../listSubnetsByEnterprisePolicy.json | 55 ++ .../examples/subnetGet.json | 24 + .../examples/subnetUpdate.json | 21 + .../examples/updateEnterprisePolicy.json | 36 ++ .../privateEndpointConnection.json | 331 +++++++++++ .../privateLinkResources.json | 239 ++++++++ .../2020-10-30-preview/subnetResources.json | 311 +++++++++++ .../resource-manager/readme.csharp.md | 15 + .../resource-manager/readme.go.md | 19 + .../powerplatform/resource-manager/readme.md | 82 +++ .../resource-manager/readme.python.md | 21 + .../resource-manager/readme.ruby.md | 19 + .../resource-manager/readme.typescript.md | 13 + 28 files changed, 2309 insertions(+) create mode 160000 azure-rest-api-specs create mode 100644 specification/powerplatform/resource-manager/Microsoft.PowerPlatform/common/v1/definitions.json create mode 100644 specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json create mode 100644 specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateEndpointConnectionDelete.json create mode 100644 specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateEndpointConnectionGet.json create mode 100644 specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateEndpointConnectionListGet.json create mode 100644 specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateEndpointConnectionUpdate.json create mode 100644 specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateLinkResourceGet.json create mode 100644 specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateLinkResourceListGet.json create mode 100644 specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/createOrUpdateEnterprisePolicy.json create mode 100644 specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/deleteEnterprisePolicy.json create mode 100644 specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/getEnterprisePolicy.json create mode 100644 specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listEnterprisePoliciesByResourceGroup.json create mode 100644 specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listEnterprisePoliciesBySubscription.json create mode 100644 specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listOperations.json create mode 100644 specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listSubnetsByEnterprisePolicy.json create mode 100644 specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/subnetGet.json create mode 100644 specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/subnetUpdate.json create mode 100644 specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/updateEnterprisePolicy.json create mode 100644 specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/privateEndpointConnection.json create mode 100644 specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/privateLinkResources.json create mode 100644 specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/subnetResources.json create mode 100644 specification/powerplatform/resource-manager/readme.csharp.md create mode 100644 specification/powerplatform/resource-manager/readme.go.md create mode 100644 specification/powerplatform/resource-manager/readme.md create mode 100644 specification/powerplatform/resource-manager/readme.python.md create mode 100644 specification/powerplatform/resource-manager/readme.ruby.md create mode 100644 specification/powerplatform/resource-manager/readme.typescript.md diff --git a/azure-rest-api-specs b/azure-rest-api-specs new file mode 160000 index 000000000000..545a9ad7563f --- /dev/null +++ b/azure-rest-api-specs @@ -0,0 +1 @@ +Subproject commit 545a9ad7563fe2858d08aba9ee5b8444375d47a9 diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/common/v1/definitions.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/common/v1/definitions.json new file mode 100644 index 000000000000..07979d47210d --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/common/v1/definitions.json @@ -0,0 +1,190 @@ +{ + "swagger": "2.0", + "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" + } + } + }, + "info": { + "version": "v1", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "ErrorResponse": { + "description": "ARM error response body.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorResponseBody", + "description": "Details about the error." + } + } + }, + "ErrorResponseBody": { + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + } + }, + "description": "An error response from the PowerPlatform service." + }, + "Resource": { + "description": "The core properties of ARM resources", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "ARM resource id of the EnterprisePolicy." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Name of the EnterprisePolicy." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "Region where the EnterprisePolicy is located." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource." + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The Azure Region where the resource lives" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ProxyResource": { + "description": "ARM proxy resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "Operation": { + "description": "PowerPlatform REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: For ex. providers/Microsoft.PowerPlatform/enterprisePolicies/write or read", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "string" + }, + "display": { + "properties": { + "provider": { + "description": "Service provider: Microsoft.PowerPlatform", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description about operation.", + "type": "string" + } + }, + "description": "Provider, Resource, Operation and description values." + }, + "properties": { + "properties": { + "statusCode": { + "description": "Service provider: Microsoft.PowerPlatform", + "type": "string" + } + }, + "x-ms-client-flatten": true, + "description": "Provider, Resource, Operation and description values." + } + } + }, + "OperationList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of PowerPlatform operations supported by the PowerPlatform resource provider." + } + }, + "description": "The response model for the list of PowerPlatform operations" + } + }, + "parameters": { + "EnterprisePolicyNameParameter": { + "name": "enterprisePolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "EnterprisePolicy for the Microsoft Azure subscription.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json new file mode 100644 index 000000000000..0d6a9c352264 --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json @@ -0,0 +1,514 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-10-30-preview", + "title": "PowerPlatform" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerPlatform/enterprisePolicies/{enterprisePolicyName}": { + "put": { + "tags": [ + "EnterprisePolicies" + ], + "operationId": "EnterprisePolicies_CreateOrUpdate", + "description": "Creates an EnterprisePolicy", + "x-ms-examples": { + "Create or update EnterprisePolicy": { + "$ref": "./examples/createOrUpdateEnterprisePolicy.json" + } + }, + "parameters": [ + { + "name": "enterprisePolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the EnterprisePolicy." + }, + { + "$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/EnterprisePolicy" + }, + "description": "Parameters supplied to create or update EnterprisePolicy." + } + ], + "responses": { + "201": { + "description": "Created. The EnterprisePolicy was created successfully.", + "schema": { + "$ref": "#/definitions/EnterprisePolicy" + } + }, + "200": { + "description": "OK. The EnterprisePolicy was updated successfully.", + "schema": { + "$ref": "#/definitions/EnterprisePolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "EnterprisePolicies" + ], + "operationId": "EnterprisePolicies_Get", + "description": "Get information about an EnterprisePolicy", + "x-ms-examples": { + "Get an EnterprisePolicy": { + "$ref": "./examples/getEnterprisePolicy.json" + } + }, + "parameters": [ + { + "name": "enterprisePolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The EnterprisePolicy name." + }, + { + "$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" + } + ], + "responses": { + "200": { + "description": "OK. The EnterprisePolicy was returned successfully.", + "schema": { + "$ref": "#/definitions/EnterprisePolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "EnterprisePolicies" + ], + "operationId": "EnterprisePolicies_Delete", + "description": "Delete an EnterprisePolicy", + "x-ms-examples": { + "Delete an EnterprisePolicy": { + "$ref": "./examples/deleteEnterprisePolicy.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "enterprisePolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the EnterprisePolicy" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "patch": { + "tags": [ + "EnterprisePolicies" + ], + "operationId": "EnterprisePolicies_Update", + "description": "Updates an EnterprisePolicy", + "x-ms-examples": { + "Update EnterprisePolicy": { + "$ref": "./examples/updateEnterprisePolicy.json" + } + }, + "parameters": [ + { + "name": "enterprisePolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the EnterprisePolicy." + }, + { + "$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/EnterprisePolicy" + }, + "description": "Parameters supplied to update EnterprisePolicy." + } + ], + "responses": { + "200": { + "description": "OK. The EnterprisePolicy was updated successfully.", + "schema": { + "$ref": "#/definitions/EnterprisePolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerPlatform/enterprisePolicies": { + "get": { + "tags": [ + "EnterprisePolicies" + ], + "operationId": "EnterprisePolicies_ListByResourceGroup", + "description": "Retrieve a list of EnterprisePolicies within a given resource group", + "x-ms-examples": { + "List EnterprisePolicies by resource group": { + "$ref": "./examples/listEnterprisePoliciesByResourceGroup.json" + } + }, + "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" + } + ], + "responses": { + "200": { + "description": "OK. List of EnterprisePolicies.", + "schema": { + "$ref": "#/definitions/EnterprisePolicyList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.PowerPlatform/enterprisePolicies": { + "get": { + "tags": [ + "EnterprisePolicies" + ], + "operationId": "EnterprisePolicies_ListBySubscription", + "description": "Retrieve a list of EnterprisePolicies within a subscription", + "x-ms-examples": { + "List EnterprisePolicies by subscription": { + "$ref": "./examples/listEnterprisePoliciesBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. List of EnterprisePolicies.", + "schema": { + "$ref": "#/definitions/EnterprisePolicyList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/providers/Microsoft.PowerPlatform/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available PowerPlatform REST API operations.", + "x-ms-examples": { + "Lists all of the available PowerPlatform REST API operations": { + "$ref": "./examples/listOperations.json" + } + }, + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "EnterprisePolicy": { + "properties": { + "identity": { + "$ref": "#/definitions/EnterprisePolicyIdentity", + "description": "The identity of the EnterprisePolicy." + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], + "description": "Definition of the EnterprisePolicy." + }, + "EnterprisePolicyIdentity": { + "properties": { + "systemAssignedIdentityPrincipalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of EnterprisePolicy identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the EnterprisePolicy." + }, + "type": { + "type": "string", + "description": "The type of identity used for the EnterprisePolicy. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity.", + "enum": [ + "SystemAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "lockbox": { + "$ref": "#/definitions/status", + "description": "lockbox configuration" + }, + "encryption": { + "type": "object", + "description": "The encryption settings for a configuration store.", + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Key vault properties." + } + } + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata for the enterprisePolicy." + } + }, + "description": "Identity for the EnterprisePolicy." + }, + "status": { + "type": "string", + "readOnly": true, + "description": "The state of onboarding, which only appears in the response.", + "x-ms-enum": { + "name": "status", + "modelAsString": true + }, + "enum": [ + "Enabled", + "Disabled", + "NotConfigured" + ] + }, + "KeyVaultProperties": { + "type": "object", + "description": "Settings concerning key vault encryption for a configuration store.", + "properties": { + "id": { + "type": "string", + "description": "Uri of KeyVault" + }, + "key": { + "$ref": "#/definitions/keyProperties", + "description": "Identity of the secret that includes name and version." + }, + "status": { + "description": "The state of onboarding, which only appears in the response.", + "$ref": "#/definitions/status" + } + } + }, + "keyProperties": { + "properties": { + "name": { + "description": "The identifier of the key vault key used to encrypt data.", + "type": "string" + }, + "version": { + "description": "The version of the identity which will be used to access key vault.", + "type": "string" + } + }, + "description": "Url and version of the KeyVault Secret" + }, + "EnterprisePolicyList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EnterprisePolicy" + }, + "description": "Result of the list EnterprisePolicy operation." + } + }, + "description": "The response of the list EnterprisePolicy operation." + } + }, + "parameters": {} +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateEndpointConnectionDelete.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateEndpointConnectionDelete.json new file mode 100644 index 000000000000..7275859a9a37 --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateEndpointConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "enterprisePolicyName": "ddb1", + "api-version": "2020-10-30-preview", + "privateEndpointConnectionName": "privateEndpointConnectionName" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateEndpointConnectionGet.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateEndpointConnectionGet.json new file mode 100644 index 000000000000..956cb49ea6de --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateEndpointConnectionGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "enterprisePolicyName": "ddb1", + "api-version": "2020-10-30-preview", + "privateEndpointConnectionName": "privateEndpointConnectionName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.PowerPlatform/enterprisePolicies/ddb1/privateEndpointConnections/privateEndpointConnectionName", + "name": "privateEndpointConnectionName", + "type": "Microsoft.PowerPlatform/enterprisePolicies/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1Network/providers/Microsoft.PowerPlatform/privateEndpoints/privateEndpointName" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateEndpointConnectionListGet.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateEndpointConnectionListGet.json new file mode 100644 index 000000000000..33ebd4ab5bf9 --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateEndpointConnectionListGet.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "enterprisePolicyName": "ddb1", + "api-version": "2020-10-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.PowerPlatform/enterprisePolicies/ddb1/privateEndpointConnections/privateEndpointConnectionName", + "name": "privateEndpointConnectionName", + "type": "Microsoft.PowerPlatform/enterprisePolicies/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.PowerPlatform/enterprisePolicies/ddb1/privateEndpointConnections/privateEndpointConnectionName2", + "name": "privateEndpointConnectionName", + "type": "Microsoft.PowerPlatform/enterprisePolicies/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateEndpointConnectionUpdate.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateEndpointConnectionUpdate.json new file mode 100644 index 000000000000..e895fd751243 --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateEndpointConnectionUpdate.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "enterprisePolicyName": "ddb1", + "api-version": "2020-10-30-preview", + "privateEndpointConnectionName": "privateEndpointConnectionName", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.PowerPlatform/enterprisePolicies/ddb1/privateEndpointConnections/privateEndpointConnectionName", + "name": "privateEndpointConnectionName", + "type": "Microsoft.PowerPlatform/enterprisePolicies/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + }, + "202": {} + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateLinkResourceGet.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateLinkResourceGet.json new file mode 100644 index 000000000000..461589beb21c --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateLinkResourceGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "enterprisePolicyName": "ddb1", + "api-version": "2020-10-30-preview", + "groupName": "sql" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.PowerPlatform/enterprisePolicies/ddb1/privateLinkResources/sql", + "name": "sql", + "type": "Microsoft.PowerPlatform/enterprisePolicies/privateLinkResources", + "properties": { + "groupId": "sql", + "requiredMembers": [ + "ddb1", + "ddb1-westus" + ] + } + } + } + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateLinkResourceListGet.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateLinkResourceListGet.json new file mode 100644 index 000000000000..a4e079ac2a17 --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/PrivateLinkResourceListGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "enterprisePolicyName": "ddb1", + "api-version": "2020-10-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.PowerPlatform/enterprisePolicies/ddb1/privateLinkResources/sql", + "name": "sql", + "type": "Microsoft.PowerPlatform/enterprisePolicies/privateLinkResources", + "properties": { + "groupId": "sql", + "requiredMembers": [ + "ddb1", + "ddb1-westus" + ], + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + } + ] + } + } + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/createOrUpdateEnterprisePolicy.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/createOrUpdateEnterprisePolicy.json new file mode 100644 index 000000000000..c41b857d5fa9 --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/createOrUpdateEnterprisePolicy.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "resourceGroup", + "api-version": "2020-10-30-preview", + "enterprisePolicyName": "enterprisePolicy", + "parameters": { + "tags": { + "Organization": "Administration" + }, + "identity": { + "type": "SystemAssigned" + }, + "location": "East US" + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "name": "enterprisePolicy", + "id": "/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.PowerPlatform/enterprisePolicies/enterprisePolicy", + "type": "Microsoft.PowerPlatform/enterprisePolicies", + "location": "East US", + "tags": { + "Organization": "Administration" + }, + "identity": { + "systemAssignedIdentityPrincipalId": "principalId", + "tenantId": "tenantId", + "type": "SystemAssigned" + } + } + }, + "200": { + "headers": {}, + "body": { + "name": "enterprisePolicy", + "id": "/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.PowerPlatform/enterprisePolicies/enterprisePolicy", + "type": "Microsoft.PowerPlatform/enterprisePolicies", + "location": "East US", + "tags": { + "Organization": "Administration" + }, + "identity": { + "systemAssignedIdentityPrincipalId": "principalId", + "tenantId": "tenantId", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/deleteEnterprisePolicy.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/deleteEnterprisePolicy.json new file mode 100644 index 000000000000..c0055eba1837 --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/deleteEnterprisePolicy.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "resourceGroup", + "enterprisePolicyName": "enterprisePolicy", + "api-version": "2020-10-30-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/getEnterprisePolicy.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/getEnterprisePolicy.json new file mode 100644 index 000000000000..7b7ae06b29b7 --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/getEnterprisePolicy.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "enterprisePolicyName": "enterprisePolicy", + "api-version": "2020-10-30-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "enterprisePolicy", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.PowerPlatform/enterprisePolicies/enterprisePolicy", + "type": "Microsoft.PowerPlatform/enterprisePolicies", + "location": "East US", + "identity": { + "systemAssignedIdentityPrincipalId": "principalId", + "tenantId": "tenantId", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listEnterprisePoliciesByResourceGroup.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listEnterprisePoliciesByResourceGroup.json new file mode 100644 index 000000000000..1d6c31b7fb5f --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listEnterprisePoliciesByResourceGroup.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "api-version": "2020-10-30-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "name": "entrprisePolicy1", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.PowerPlatform/enterprisePolicies/enterprisePolicy1", + "type": "Microsoft.PowerPlatform/enterprisePolicies", + "location": "East US", + "properties": { + "identity": { + "systemAssignedIdentityPrincipalId": "principalId", + "tenantId": "tenantId", + "type": "SystemAssigned", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + } + }, + { + "name": "enterprisePolicy2", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.PowerPlatform/enterprisePolicies/enterprisePolicy2", + "type": "Microsoft.PowerPlatform/enterprisePolicies", + "location": "East US", + "properties": { + "identity": { + "systemAssignedIdentityPrincipalId": "principalId", + "tenantId": "tenantId", + "type": "SystemAssigned" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + } + ] + } + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listEnterprisePoliciesBySubscription.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listEnterprisePoliciesBySubscription.json new file mode 100644 index 000000000000..6b240cbee0e0 --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listEnterprisePoliciesBySubscription.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2020-10-30-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "name": "enterprisePolicy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.PowerPlatform/enterprisePolicies/enterprisePolicy1", + "type": "Microsoft.PowerPlatform/enterprisePolicies", + "location": "East US", + "identity": { + "systemAssignedIdentityPrincipalId": "principalId", + "tenantId": "tenantId", + "type": "SystemAssigned", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + }, + { + "name": "enterprisePolicy2", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.PowerPlatform/enterprisePolicies/enterprisePolicy2", + "type": "Microsoft.PowerPlatform/enterprisePolicies", + "location": "East US", + "identity": { + "systemAssignedIdentityPrincipalId": "principalId", + "tenantId": "tenantId", + "type": "SystemAssigned", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + } + ] + } + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listOperations.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listOperations.json new file mode 100644 index 000000000000..73e6845fe313 --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listOperations.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2020-10-30-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "Microsoft.PowerPlatform/enterprisePolicies/write", + "isDataAction": "false", + "display": { + "provider": "Microsoft PowerPlatform", + "resource": "Microsoft.PowerPlatform/enterprisePolicies", + "operation": "Microsoft.PowerPlatform/enterprisePolicies/write", + "description": "Create new enterprisePolicy." + }, + "properties": null + }, + { + "name": "Microsoft.PowerPlatform/enterprisePolicies/read", + "isDataAction": "false", + "display": { + "provider": "Microsoft PowerPlatform", + "resource": "Microsoft.PowerPlatform/enterprisePolicies", + "operation": "Microsoft.PowerPlatform/enterprisePolicies/read", + "description": "Get enterprisePolicy." + }, + "properties": null + } + ] + } + } + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listSubnetsByEnterprisePolicy.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listSubnetsByEnterprisePolicy.json new file mode 100644 index 000000000000..a630f91380c1 --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/listSubnetsByEnterprisePolicy.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "enterprisePolicyName": "ep1", + "api-version": "2020-10-30-preview", + "subnetName": "subnetName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.PowerPlatform/enterprisePolicies/ep1/subnets", + "name": "subnetName", + "type": "Microsoft.PowerPlatform/enterprisePolicies/subnets", + "properties": { + "subnet": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/subnet1" + }, + "status": "Enabled", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.PowerPlatform/enterprisePolicies/ep1/subnets", + "name": "subnetName", + "type": "Microsoft.PowerPlatform/enterprisePolicies/subnets", + "properties": { + "subnet": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/subnet2" + }, + "status": "Disabled", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + } + } + } + ] + } + } + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/subnetGet.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/subnetGet.json new file mode 100644 index 000000000000..14ba1ba62fa7 --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/subnetGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "enterprisePolicyName": "ddb1", + "api-version": "2020-10-30-preview", + "subnetName": "subnetName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.PowerPlatform/enterprisePolicies/ddb1/subnets", + "name": "subnetName", + "type": "Microsoft.PowerPlatform/enterprisePolicies/subnets", + "properties": { + "subnet": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/subnet1" + }, + "status": "Enabled" + } + } + } + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/subnetUpdate.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/subnetUpdate.json new file mode 100644 index 000000000000..485a69b7ddaa --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/subnetUpdate.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "enterprisePolicyName": "ddb1", + "api-version": "2020-10-30-preview", + "subnetName": "subnetName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.PowerPlatform/enterprisePolicies/ddb1/subnets/subnetName", + "name": "subnetName", + "type": "Microsoft.PowerPlatform/enterprisePolicies/subnets", + "properties": { + "status": "Disabled" + } + } + } + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/updateEnterprisePolicy.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/updateEnterprisePolicy.json new file mode 100644 index 000000000000..4237ba2e50e0 --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/examples/updateEnterprisePolicy.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "resourceGroup", + "enterprisePolicyName": "enterprisePolicy", + "api-version": "2020-10-30-preview", + "parameters": { + "tags": { + "Organization": "Administration" + }, + "identity": { + "type": "SystemAssigned" + }, + "location": "East US" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "enterprisePolicy", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.PowerPlatform/enterprisePolicies/enterprisePolicy", + "type": "Microsoft.PowerPlatform/enterprisePolicies", + "location": "East US", + "tags": { + "Organization": "Administration" + }, + "identity": { + "systemAssignedIdentityPrincipalId": "principalId", + "tenantId": "tenantId", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/privateEndpointConnection.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/privateEndpointConnection.json new file mode 100644 index 000000000000..b4e23df2f5ab --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/privateEndpointConnection.json @@ -0,0 +1,331 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-10-30-preview", + "title": "PowerPlatform" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerPlatform/enterprisePolicies/{enterprisePolicyName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "List all private endpoint connections on an EnterprisePolicy.", + "operationId": "PrivateEndpointConnections_ListByEnterprisePolicy", + "x-ms-pageable": { + "nextLinkName": null + }, + "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" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EnterprisePolicyNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/PrivateEndpointConnectionListGet.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerPlatform/enterprisePolicies/{enterprisePolicyName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets a private endpoint connection.", + "operationId": "PrivateEndpointConnections_Get", + "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" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EnterprisePolicyNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/PrivateEndpointConnectionGet.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Approve or reject a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "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" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EnterprisePolicyNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "Parameters supplied to create or update a private endpoint connection." + } + ], + "responses": { + "200": { + "description": "Successfully approved or rejected private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "Accepted. The private endpoint connection update will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Approve or reject a private endpoint connection with a given name.": { + "$ref": "./examples/PrivateEndpointConnectionUpdate.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnections_Delete", + "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" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EnterprisePolicyNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "The private endpoint connection was successfully deleted." + }, + "202": { + "description": "Accepted. The private endpoint connection delete will complete asynchronously." + }, + "204": { + "description": "Private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes a private endpoint connection with a given name.": { + "$ref": "./examples/PrivateEndpointConnectionDelete.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/providers/Microsoft.PowerPlatform/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available PowerPlatform REST API operations.", + "x-ms-examples": { + "Lists all of the available PowerPlatform REST API operations": { + "$ref": "./examples/listOperations.json" + } + }, + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "PrivateEndpointConnectionListResult": { + "description": "A list of private endpoint connections", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "properties": { + "properties": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnectionProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" + } + ] + } + }, + "parameters": { + "PrivateEndpointConnectionNameParameter": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the private endpoint connection." + } + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/privateLinkResources.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/privateLinkResources.json new file mode 100644 index 000000000000..9ee5e981113d --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/privateLinkResources.json @@ -0,0 +1,239 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-10-30-preview", + "title": "PowerPlatform" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerPlatform/enterprisePolicies/{enterprisePolicyName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources that need to be created for enterprisePolicy.", + "operationId": "PrivateLinkResources_ListByEnterprisePolicy", + "x-ms-pageable": { + "nextLinkName": null + }, + "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" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EnterprisePolicyNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/PrivateLinkResourceListGet.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerPlatform/enterprisePolicies/{enterprisePolicyName}/privateLinkResources/{groupName}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources that need to be created for an EnterprisePolicy.", + "operationId": "PrivateLinkResources_Get", + "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" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EnterprisePolicyNameParameter" + }, + { + "$ref": "#/parameters/GroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified private link resource.", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/PrivateLinkResourceGet.json" + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/providers/Microsoft.PowerPlatform/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available PowerPlatform REST API operations.", + "x-ms-examples": { + "Lists all of the available PowerPlatform REST API operations": { + "$ref": "./examples/listOperations.json" + } + }, + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "PrivateLinkResourceListResult": { + "description": "A list of private link resources", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" + } + ] + }, + "PrivateLinkResourceProperties": { + "description": "Properties of a private link resource.", + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata for the private link resource." + } + } + } + }, + "parameters": { + "GroupNameParameter": { + "name": "groupName", + "in": "path", + "description": "The name of the private link resource.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + } + } +} diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/subnetResources.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/subnetResources.json new file mode 100644 index 000000000000..1d7b553e551a --- /dev/null +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/subnetResources.json @@ -0,0 +1,311 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-10-30-preview", + "title": "PowerPlatform" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerPlatform/enterprisePolicies/{enterprisePolicyName}/subnets/{subnetName}": { + "get": { + "tags": [ + "Subnets" + ], + "summary": "Gets Subnets associated with EnterprisePolicy authorized for outbound calls from PowerPlatform.", + "description": "Description of Subnets that are authorized for outbound calls from PowerPlatform.", + "operationId": "Subnets_Get", + "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" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EnterprisePolicyNameParameter" + }, + { + "$ref": "#/parameters/SubnetNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Subnet" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets subnet.": { + "$ref": "./examples/subnetGet.json" + } + }, + "x-ms-long-running-operation": false, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "put": { + "tags": [ + "PowerPlatform" + ], + "summary": "Create or Update Subnet that PowerPlatform resources can access.", + "description": "Description of the Subnet that PowerPlatform resources can access.", + "operationId": "Subnets_CreateOrUpdate", + "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" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EnterprisePolicyNameParameter" + }, + { + "$ref": "#/parameters/SubnetNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Subnet" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creates or Updates subnet.": { + "$ref": "./examples/subnetUpdate.json" + } + }, + "x-ms-long-running-operation": false, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PowerPlatform/enterprisePolicies/{enterprisePolicyName}/subnets": { + "get": { + "tags": [ + "Subnets" + ], + "operationId": "Subnets_ListByEnterprisePolicy", + "description": "Retrieve a list of subnets within a given enterprisePolicy", + "x-ms-examples": { + "List EnterprisePolicies by resource group": { + "$ref": "./examples/listSubnetsByEnterprisePolicy.json" + } + }, + "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" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/EnterprisePolicyNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. List of subnets.", + "schema": { + "$ref": "#/definitions/SubnetListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/providers/Microsoft.PowerPlatform/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available PowerPlatform REST API operations.", + "x-ms-examples": { + "Lists all of the available PowerPlatform REST API operations": { + "$ref": "./examples/listOperations.json" + } + }, + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "SubnetListResult": { + "description": "A list of subnets", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of subnets", + "items": { + "$ref": "#/definitions/Subnet" + } + } + } + }, + "Subnet": { + "description": "A subnet", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/SubnetProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" + } + ] + }, + "SubnetProperties": { + "description": "Properties of a subnet.", + "type": "object", + "properties": { + "subnet": { + "$ref": "#/definitions/SubnetEndpointProperty", + "description": "Endpoint of the subnet." + }, + "status": { + "$ref": "#/definitions/SubnetState", + "description": "Connection State of the subnet." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata for the subnet." + } + } + }, + "SubnetEndpointProperty": { + "type": "object", + "description": "Endpoint of the subnet.", + "properties": { + "id": { + "type": "string", + "description": "Resource id of the subnet." + } + } + }, + "SubnetState": { + "type": "string", + "readOnly": true, + "description": "The state of onboarding, which only appears in the response.", + "x-ms-enum": { + "name": "status", + "modelAsString": true + }, + "enum": [ + "Enabled", + "Disabled", + "NotConfigured" + ] + } + }, + "parameters": { + "SubnetNameParameter": { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The name of the subnet." + } + } +} diff --git a/specification/powerplatform/resource-manager/readme.csharp.md b/specification/powerplatform/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..d92f60506dcf --- /dev/null +++ b/specification/powerplatform/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.PowerPlatform + output-folder: $(csharp-sdks-folder)/powerplatform/management/Microsoft.PowerPlatform/GeneratedProtocol +``` diff --git a/specification/powerplatform/resource-manager/readme.go.md b/specification/powerplatform/resource-manager/readme.go.md new file mode 100644 index 000000000000..ca4e7e44bdc3 --- /dev/null +++ b/specification/powerplatform/resource-manager/readme.go.md @@ -0,0 +1,19 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + clear-output-folder: true +``` + +### Tag: package-2020-10-30-preview and go + +These settings apply only when `--tag=package-2020-10-30-preview --go` is specified on the command line. +Please also specify `--go-sdks-folder=`. + +```yaml $(tag) == 'package-2020-10-30-preview' && $(go) +namespace: powerplatform +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-10-30/$(namespace) +``` diff --git a/specification/powerplatform/resource-manager/readme.md b/specification/powerplatform/resource-manager/readme.md new file mode 100644 index 000000000000..d66f7b64acdd --- /dev/null +++ b/specification/powerplatform/resource-manager/readme.md @@ -0,0 +1,82 @@ +# powerplatform + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for powerplatform. + +## Getting Started rapatank + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the powerplatform. + +```yaml +openapi-type: arm +tag: package-2020-10-30-preview +``` + +### Tag: package-2020-10-30-preview + +These settings apply only when `--tag=package-2020-10-30-preview` is specified on the command line. + +```yaml $(tag) == 'package-2020-10-30-preview' +input-file: + - Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json + - Microsoft.PowerPlatform/preview/2020-10-30-preview/privateEndpointConnection.json + - Microsoft.PowerPlatform/preview/2020-10-30-preview/privateLinkResources.json + - Microsoft.PowerPlatform/preview/2020-10-30-preview/subnetResources.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_powerplatform'] +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Ruby + +See configuration in [readme.ruby.md](./readme.ruby.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) diff --git a/specification/powerplatform/resource-manager/readme.python.md b/specification/powerplatform/resource-manager/readme.python.md new file mode 100644 index 000000000000..97f765b5ffae --- /dev/null +++ b/specification/powerplatform/resource-manager/readme.python.md @@ -0,0 +1,21 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +```yaml $(python) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: Microsoft.PowerPlatform + package-name: powerplatform + package-version: 2020-10-30-preview + clear-output-folder: true +``` + +```yaml $(python) +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt/powerplatform +``` diff --git a/specification/powerplatform/resource-manager/readme.ruby.md b/specification/powerplatform/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..0e24a502ad57 --- /dev/null +++ b/specification/powerplatform/resource-manager/readme.ruby.md @@ -0,0 +1,19 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +```yaml +package-name: azure_mgmt_powerplatform +package-version: 2020-10-30-preview +azure-arm: true +``` + +### Tag: package-2020-10-30-preview and ruby + +These settings apply only when `--tag=package-2020-10-30-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2020-10-30-preview' && $(ruby) +namespace: Microsoft.PowerPlatform +output-folder: $(ruby-sdks-folder)/powerplatform +``` diff --git a/specification/powerplatform/resource-manager/readme.typescript.md b/specification/powerplatform/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..57a0596adf9a --- /dev/null +++ b/specification/powerplatform/resource-manager/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +```yaml $(typescript) +typescript: + azure-arm: true + package-name: "powerplatform" + output-folder: "$(typescript-sdks-folder)/packages/powerplatform" + payload-flattening-threshold: 1 + generate-metadata: true +``` From 2e84e67b8e0c76bd9066fe8eef6ccb5fa2e14321 Mon Sep 17 00:00:00 2001 From: rapatank <69176921+rapatank@users.noreply.github.com> Date: Thu, 17 Sep 2020 19:50:49 -0700 Subject: [PATCH 084/164] Powerplatformrp (#10838) * PowerPlatform RP specifications * PowerPlatform changes * Updating powerplatform json * Update definitions.json * Updating the schema * Updated the schema. * Updates to schema * Schema update * Schema update * Example update * Update description * Updating the swagger * Updating the swagger definition * Swagger update. * Swagger updates * Adding private link changes. * Updates to readme.md * Private link updates * Schema update * private link update * response update * Added systemData * Updated description. * Adding subnet configuration * readme update. * Adding systemData. * Updated example * Update * Update to systemData * Updates * Updates * Updated the version of common types * readme.go update * Update * Updated version * version update * update * update * Updated "enterprisePromise" to "enterprisePolicy". * Updates * Updates * Updating to use common type * updates * Update for lockbox --- .../preview/2020-10-30-preview/enterprisePolicy.json | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json index 0d6a9c352264..677c74402f5c 100644 --- a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json @@ -432,8 +432,14 @@ } }, "lockbox": { - "$ref": "#/definitions/status", - "description": "lockbox configuration" + "type": "object", + "description": "Settings concerning lockbox.", + "properties": { + "status": { + "$ref": "#/definitions/status", + "description": "lockbox configuration" + } + } }, "encryption": { "type": "object", From 1b04f5fce19cd330dcc0eec11a98e499c0cda50d Mon Sep 17 00:00:00 2001 From: Achal Jain Date: Thu, 17 Sep 2020 19:55:26 -0700 Subject: [PATCH 085/164] Add Datasets and datastores API swagger (#10644) * Add datasets get API * fix error * fix long type * errors * add get api for dataset resource * fix * fix * fix * fix in path * caps * caps * fix * fix * fix * pretttier * dataset put and delete * prettier * fix build * fixes * fix * pretty * datastore swagger * prettier * errors * spellcheck * fix * remove name * error * fix enum * fix * enumtype * enum * fix enum * fixes * comment --- cSpell.json | 7 + .../examples/createOrUpdateAdlsDatastore.json | 82 + .../createOrUpdateAdlsGen2Datastore.json | 97 + .../examples/createOrUpdateBlobDatastore.json | 83 + .../examples/createOrUpdateDataset.json | 103 + .../examples/createOrUpdateDbfsDatastore.json | 64 + .../examples/createOrUpdateFileDatastore.json | 83 + .../createOrUpdateMySqlDatastore.json | 87 + .../createOrUpdatePostgreSqlDatastore.json | 88 + .../examples/createOrUpdateSqlDatastore.json | 87 + .../examples/deleteDataset.json | 13 + .../examples/deleteDatastore.json | 13 + .../examples/getDataset.json | 81 + .../examples/getDatasets.json | 156 ++ .../examples/getDatastore.json | 71 + .../examples/getDatastores.json | 485 ++++ .../machineLearningServices.json | 2377 ++++++++++++++--- 17 files changed, 3545 insertions(+), 432 deletions(-) create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateAdlsDatastore.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateAdlsGen2Datastore.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateBlobDatastore.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateDataset.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateDbfsDatastore.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateFileDatastore.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateMySqlDatastore.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdatePostgreSqlDatastore.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateSqlDatastore.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteDataset.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteDatastore.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getDataset.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getDatasets.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getDatastore.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getDatastores.json diff --git a/cSpell.json b/cSpell.json index 207203bfb932..88648ed85612 100644 --- a/cSpell.json +++ b/cSpell.json @@ -713,6 +713,13 @@ "networkrulesets", "Setget" ] + }, + { + "filename": "**/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/machineLearningServices.json", + "words": [ + "mysqldb", + "psqldb" + ] } ] } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateAdlsDatastore.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateAdlsDatastore.json new file mode 100644 index 000000000000..132cb2d8be78 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateAdlsDatastore.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroupName": "acjain-mleastUS2", + "workspaceName": "acjain-mleastUS2", + "api-version": "2020-05-01-preview", + "datastoreName": "adlsDatastore", + "properties": { + "dataStoreType": "adls", + "clientId": "233d7008-b157-4354-88d1-ba191f06a900", + "clientSecret": "vdvgdvdvdv", + "storeName": "stanley", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/35f16a99-532a-4a47-9e93-00305f6c40f2/resourceGroups/acjain-mleastUS2/providers/Microsoft.MachineLearningServices/workspaces/acjain-mleastUS2/datastores/adlsDatastore", + "name": "adlsDatastore", + "type": "Microsoft.MachineLearningServices/workspaces/datastores", + "location": "eastus2", + "tags": null, + "properties": { + "name": "adlsdatastore", + "dataStoreType": "AzureDataLake", + "hasBeenValidated": false, + "tags": null, + "azureStorageSection": null, + "azureDataLakeSection": { + "storeName": "stanley", + "credentialType": "ServicePrincipal", + "clientId": "233d7008-b157-4354-88d1-ba191f06a900", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "isCertAuth": false, + "certificate": null, + "thumbprint": null, + "clientSecret": "maM1h1A7xu/4TPiBR-ZBFmhiceqwRE_@", + "authorityUrl": "https://login.microsoftonline.com", + "resourceUri": "https://datalake.azure.net/", + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroup": "acjain-mleastUS2", + "serviceDataAccessAuthIdentity": "None" + }, + "azureSqlDatabaseSection": null, + "azurePostgreSqlSection": null, + "azureMySqlSection": null, + "glusterFsSection": null, + "createdBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "Achal Jain" + }, + "modifiedBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "Achal Jain" + }, + "createdTime": "2020-09-08T05:49:40.9221987Z", + "modifiedTime": "2020-09-08T05:49:41.5438281Z", + "linkedInfo": null + }, + "identity": null, + "sku": null + } + }, + "201": { + "description": "The request was accepted.", + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateAdlsGen2Datastore.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateAdlsGen2Datastore.json new file mode 100644 index 000000000000..d7721bab1184 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateAdlsGen2Datastore.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroupName": "acjain-mleastUS2", + "workspaceName": "acjain-mleastUS2", + "api-version": "2020-05-01-preview", + "datastoreName": "adlsgen2Datastore", + "properties": { + "dataStoreType": "adls-gen2", + "fileSystem": "testfs1", + "accountName": "nicksadlsgen2storage", + "clientId": "233d7008-b157-4354-88d1-ba191f06a900", + "clientSecret": "vdegbvedgeg", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/35f16a99-532a-4a47-9e93-00305f6c40f2/resourceGroups/acjain-mleastUS2/providers/Microsoft.MachineLearningServices/workspaces/acjain-mleastUS2/datastores/adlsgen2Datastore", + "name": "adlsgen2Datastore", + "type": "Microsoft.MachineLearningServices/workspaces/datastores", + "location": "eastus2", + "tags": null, + "properties": { + "name": "adlsgen2datastore", + "dataStoreType": "AzureDataLakeGen2", + "hasBeenValidated": false, + "tags": null, + "azureStorageSection": { + "accountName": "nicksadlsgen2storage", + "containerName": "testfs1", + "endpoint": "core.windows.net", + "protocol": "https", + "credentialType": "ClientCredentials", + "credential": null, + "clientCredentials": { + "clientId": "233d7008-b157-4354-88d1-ba191f06a900", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "isCertAuth": false, + "certificate": null, + "thumbprint": null, + "clientSecret": "maM1h1A7xu/4TPiBR-ZBFmhiceqwRE_@", + "authorityUrl": "https://login.microsoftonline.com", + "resourceUri": "https://storage.azure.com/", + "subscriptionId": null, + "resourceGroup": null, + "serviceDataAccessAuthIdentity": "None" + }, + "blobCacheTimeout": null, + "isSas": false, + "accountKey": null, + "sasToken": null, + "areWorkspaceManagedIdentitiesAllowed": false, + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroup": "acjain-mleastUS2", + "serviceDataAccessAuthIdentity": "None" + }, + "azureDataLakeSection": null, + "azureSqlDatabaseSection": null, + "azurePostgreSqlSection": null, + "azureMySqlSection": null, + "glusterFsSection": null, + "createdBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "Achal Jain" + }, + "modifiedBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "Achal Jain" + }, + "createdTime": "2020-09-08T05:57:31.7019233Z", + "modifiedTime": "2020-09-08T05:57:32.3251822Z", + "linkedInfo": null + }, + "identity": null, + "sku": null + } + }, + "201": { + "description": "The request was accepted.", + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateBlobDatastore.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateBlobDatastore.json new file mode 100644 index 000000000000..5773748f92ee --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateBlobDatastore.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroupName": "acjain-mleastUS2", + "workspaceName": "acjain-mleastUS2", + "api-version": "2020-05-01-preview", + "datastoreName": "blobDatastore", + "properties": { + "dataStoreType": "blob", + "accountName": "acjainmleastus9484093746", + "containerName": "azureml-blobstore-5da947c5-53aa-41a5-bb2b-074074e73b7", + "accountKey": "wddrfewfewsgewgrrwegwreg" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/35f16a99-532a-4a47-9e93-00305f6c40f2/resourceGroups/acjain-mleastUS2/providers/Microsoft.MachineLearningServices/workspaces/acjain-mleastUS2/datastores/blobDatastore", + "name": "blobDatastore", + "type": "Microsoft.MachineLearningServices/workspaces/datastores", + "location": "eastus2", + "tags": null, + "properties": { + "name": "blobDatastore", + "dataStoreType": "AzureBlob", + "hasBeenValidated": false, + "tags": null, + "azureStorageSection": { + "accountName": "acjainmleastus9484093746", + "containerName": "azureml-blobstore-5da947c5-53aa-41a5-bb2b-074074e73b7", + "endpoint": "core.windows.net", + "protocol": "https", + "credentialType": "AccountKey", + "credential": "wddrfewfewsgewgrrwegwreg", + "clientCredentials": null, + "blobCacheTimeout": null, + "isSas": false, + "accountKey": "wddrfewfewsgewgrrwegwreg", + "sasToken": null, + "areWorkspaceManagedIdentitiesAllowed": false, + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroup": "acjain-mleastUS2", + "serviceDataAccessAuthIdentity": "None" + }, + "azureDataLakeSection": null, + "azureSqlDatabaseSection": null, + "azurePostgreSqlSection": null, + "azureMySqlSection": null, + "glusterFsSection": null, + "createdBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "Achal Jain" + }, + "modifiedBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "Achal Jain" + }, + "createdTime": "2020-09-08T05:23:21.1954812Z", + "modifiedTime": "2020-09-08T05:24:00.5673353Z", + "linkedInfo": null + }, + "identity": null, + "sku": null + } + }, + "201": { + "description": "The request was accepted.", + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateDataset.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateDataset.json new file mode 100644 index 000000000000..6b9a44d64fd3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateDataset.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroupName": "acjain-mleastUS2", + "workspaceName": "acjain-mleastUS2", + "api-version": "2020-05-01-preview", + "datasetName": "datasetName123", + "properties": { + "skipValidation": false, + "datasetType": "file", + "parameters": { + "path": { + "dataPath": { + "datastoreName": "testblobfromarm", + "relativePath": "UI/03-26-2020_083359_UTC/latin1encoding.csv" + } + } + }, + "registration": { + "description": "test description", + "name": "datasetName123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/35f16a99-532a-4a47-9e93-00305f6c40f2/resourceGroups/acjain-mleastUS2/providers/Microsoft.MachineLearningServices/workspaces/acjain-mleastUS2/datasets/datasetName123", + "name": "datasetName123", + "type": "Microsoft.MachineLearningServices/workspaces/datasets", + "location": "eastus2", + "tags": null, + "properties": { + "datasetId": "db9c8fbe-a404-4019-9b9e-722a544f83ff", + "datasetState": { + "state": "active", + "deprecatedBy": null, + "etag": "\"6e121555-0000-0200-0000-5f4ea2230000\"" + }, + "latest": { + "datasetId": "db9c8fbe-a404-4019-9b9e-722a544f83ff", + "versionId": "1", + "datasetDefinitionState": { + "state": "active", + "deprecatedBy": null, + "etag": "\"6e121455-0000-0200-0000-5f4ea2230000\"" + }, + "dataflow": "{\n \"blocks\": [\n {\n \"id\": \"11c52b64-7e70-4dae-9091-c57372827491\",\n \"type\": \"Microsoft.DPrep.GetDatastoreFilesBlock\",\n \"arguments\": {\n \"datastores\": [\n {\n \"datastoreName\": \"testblobfromarm\",\n \"path\": \"UI/03-26-2020_083359_UTC/latin1encoding.csv\",\n \"resourceGroup\": \"acjain-mleastUS2\",\n \"subscription\": \"35f16a99-532a-4a47-9e93-00305f6c40f2\",\n \"workspaceName\": \"acjain-mleastUS2\"\n }\n ]\n },\n \"localData\": {},\n \"isEnabled\": true,\n \"name\": null,\n \"annotation\": null\n }\n ],\n \"inspectors\": [],\n \"meta\": {\n \"savedDatasetId\": \"47198920-b0d5-4274-85c0-fba9ec6662a6\",\n \"datasetType\": \"file\",\n \"subscriptionId\": \"35f16a99-532a-4a47-9e93-00305f6c40f2\",\n \"workspaceId\": \"5da947c5-53aa-41a5-bb2b-074074e73b76\",\n \"workspaceLocation\": \"eastus2\"\n }\n}", + "dataPath": { + "datastoreName": "testblobfromarm", + "relativePath": "UI/03-26-2020_083359_UTC/latin1encoding.csv", + "azureFilePath": "https://acjainmleastus9484093746.blob.core.windows.net/azureml-blobstore-5da947c5-53aa-41a5-bb2b-074074e73b76/UI/03-26-2020_083359_UTC/latin1encoding.csv", + "paths": null, + "sqlDataPath": null, + "httpUrl": null, + "additionalProperties": {}, + "partitionFormat": null, + "partitionFormatIgnoreError": false + }, + "partitionFormatInPath": null, + "notes": "Auto generated from UI/03-26-2020_083359_UTC/latin1encoding.csv.", + "etag": "\"6e121455-0000-0200-0000-5f4ea2230000\"", + "createdTime": "2020-09-01T19:33:55.014954Z", + "modifiedTime": "2020-09-01T19:33:55.014954Z", + "createdBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "Achal Jain" + }, + "fileType": "Unknown", + "properties": {}, + "savedDatasetId": "47198920-b0d5-4274-85c0-fba9ec6662a6", + "telemetryInfo": {}, + "useDescriptionTagsFromDefinition": true, + "description": "geggegegegeg", + "tags": {} + }, + "createdTime": "2020-09-01T19:33:55.0914964Z", + "modifiedTime": "2020-09-01T19:33:55.0914964Z", + "etag": "\"6e121555-0000-0200-0000-5f4ea2230000\"", + "name": "datasetNdddamdddeefe", + "description": "geggegegegeg", + "tags": {}, + "isVisible": true, + "defaultCompute": null, + "datasetType": "file" + }, + "identity": null, + "sku": null + } + }, + "201": { + "description": "The request was accepted.", + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateDbfsDatastore.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateDbfsDatastore.json new file mode 100644 index 000000000000..02370d1f6cb6 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateDbfsDatastore.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroupName": "acjain-mleastUS2", + "workspaceName": "acjain-mleastUS2", + "api-version": "2020-05-01-preview", + "datastoreName": "blobDatastore", + "properties": { + "dataStoreType": "dbfs" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/35f16a99-532a-4a47-9e93-00305f6c40f2/resourceGroups/acjain-mleastUS2/providers/Microsoft.MachineLearningServices/workspaces/acjain-mleastUS2/datastores/dbfsDatastore", + "name": "dbfsDatastore", + "type": "Microsoft.MachineLearningServices/workspaces/datastores", + "location": "eastus2", + "tags": null, + "properties": { + "name": "dbfsdatastore", + "dataStoreType": "DBFS", + "hasBeenValidated": false, + "tags": null, + "azureStorageSection": null, + "azureDataLakeSection": null, + "azureSqlDatabaseSection": null, + "azurePostgreSqlSection": null, + "azureMySqlSection": null, + "glusterFsSection": null, + "createdBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "Achal Jain" + }, + "modifiedBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "Achal Jain" + }, + "createdTime": "2020-09-08T06:00:08.4621095Z", + "modifiedTime": "2020-09-08T06:00:08.4719758Z", + "linkedInfo": null + }, + "identity": null, + "sku": null + } + }, + "201": { + "description": "The request was accepted.", + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateFileDatastore.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateFileDatastore.json new file mode 100644 index 000000000000..b8b0857cd785 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateFileDatastore.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroupName": "acjain-mleastUS2", + "workspaceName": "acjain-mleastUS2", + "api-version": "2020-05-01-preview", + "datastoreName": "fileDatastore", + "properties": { + "dataStoreType": "file", + "accountName": "acjainmleastus9484093746", + "shareName": "azureml-filestore-5da947c5-53aa-41a5-bb2b-074074e73b76", + "accountKey": "wddrfewfewsgewgrrwegwreg" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/35f16a99-532a-4a47-9e93-00305f6c40f2/resourceGroups/acjain-mleastUS2/providers/Microsoft.MachineLearningServices/workspaces/acjain-mleastUS2/datastores/fileDatastore", + "name": "fileDatastore", + "type": "Microsoft.MachineLearningServices/workspaces/datastores", + "location": "eastus2", + "tags": null, + "properties": { + "name": "filedatastore", + "dataStoreType": "AzureFile", + "hasBeenValidated": false, + "tags": null, + "azureStorageSection": { + "accountName": "acjainmleastus9484093746", + "containerName": "azureml-filestore-5da947c5-53aa-41a5-bb2b-074074e73b76", + "endpoint": "core.windows.net", + "protocol": "https", + "credentialType": "AccountKey", + "credential": "JCI+yadbNeeNRpBN2mMvDF56zyKINDqWTaYzsGPO/5F7wKtc65DGUya5q0sUfQyFXzwGES7eYNhQ9De79MGIAg==", + "clientCredentials": null, + "blobCacheTimeout": null, + "isSas": false, + "accountKey": "JCI+yadbNeeNRpBN2mMvDF56zyKINDqWTaYzsGPO/5F7wKtc65DGUya5q0sUfQyFXzwGES7eYNhQ9De79MGIAg==", + "sasToken": null, + "areWorkspaceManagedIdentitiesAllowed": false, + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroup": "acjain-mleastUS2", + "serviceDataAccessAuthIdentity": "None" + }, + "azureDataLakeSection": null, + "azureSqlDatabaseSection": null, + "azurePostgreSqlSection": null, + "azureMySqlSection": null, + "glusterFsSection": null, + "createdBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "Achal Jain" + }, + "modifiedBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "Achal Jain" + }, + "createdTime": "2020-09-08T05:30:45.929961Z", + "modifiedTime": "2020-09-08T05:30:47.2122056Z", + "linkedInfo": null + }, + "identity": null, + "sku": null + } + }, + "201": { + "description": "The request was accepted.", + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateMySqlDatastore.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateMySqlDatastore.json new file mode 100644 index 000000000000..05addd0307f4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateMySqlDatastore.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroupName": "acjain-mleastUS2", + "workspaceName": "acjain-mleastUS2", + "api-version": "2020-05-01-preview", + "datastoreName": "mySqlDatastore", + "properties": { + "dataStoreType": "mysqldb", + "databaseName": "dataset", + "serverName": "dataset-mysql-srv", + "userId": "demo_user@dataset-mysql-srv", + "password": "fefefefe#1234" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/35f16a99-532a-4a47-9e93-00305f6c40f2/resourceGroups/acjain-mleastUS2/providers/Microsoft.MachineLearningServices/workspaces/acjain-mleastUS2/datastores/mySqlDatastore", + "name": "mySqlDatastore", + "type": "Microsoft.MachineLearningServices/workspaces/datastores", + "location": "eastus2", + "tags": null, + "properties": { + "name": "mysqldatastore", + "dataStoreType": "AzureMySql", + "hasBeenValidated": false, + "tags": null, + "azureStorageSection": null, + "azureDataLakeSection": null, + "azureSqlDatabaseSection": null, + "azurePostgreSqlSection": null, + "azureMySqlSection": { + "serverName": "dataset-mysql-srv", + "databaseName": "dataset", + "endpoint": "mysql.database.azure.com", + "userId": "demo_user@dataset-mysql-srv", + "userPassword": "dataset#1234", + "portNumber": "3306", + "credentialType": "SqlAuthentication", + "clientId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "isCertAuth": false, + "certificate": null, + "thumbprint": null, + "clientSecret": null, + "authorityUrl": "https://login.microsoftonline.com", + "resourceUri": null, + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroup": "acjain-mleastUS2", + "serviceDataAccessAuthIdentity": "None" + }, + "glusterFsSection": null, + "createdBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "Achal Jain" + }, + "modifiedBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "Achal Jain" + }, + "createdTime": "2020-09-08T05:43:00.3090624Z", + "modifiedTime": "2020-09-08T05:43:02.2118144Z", + "linkedInfo": null + }, + "identity": null, + "sku": null + } + }, + "201": { + "description": "The request was accepted.", + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdatePostgreSqlDatastore.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdatePostgreSqlDatastore.json new file mode 100644 index 000000000000..d5db92d62e38 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdatePostgreSqlDatastore.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroupName": "acjain-mleastUS2", + "workspaceName": "acjain-mleastUS2", + "api-version": "2020-05-01-preview", + "datastoreName": "postgreSqlDatastore", + "properties": { + "dataStoreType": "psqldb", + "databaseName": "dataset", + "serverName": "dataset-pgsql-srv", + "userId": "demo_user@dataset-pgsql-srv", + "password": "swfwwfwf#1234" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/35f16a99-532a-4a47-9e93-00305f6c40f2/resourceGroups/acjain-mleastUS2/providers/Microsoft.MachineLearningServices/workspaces/acjain-mleastUS2/datastores/postgreSqlDatastore", + "name": "postgreSqlDatastore", + "type": "Microsoft.MachineLearningServices/workspaces/datastores", + "location": "eastus2", + "tags": null, + "properties": { + "name": "postgresqldatastore", + "dataStoreType": "AzurePostgreSql", + "hasBeenValidated": false, + "tags": null, + "azureStorageSection": null, + "azureDataLakeSection": null, + "azureSqlDatabaseSection": null, + "azurePostgreSqlSection": { + "enableSsl": true, + "serverName": "dataset-pgsql-srv", + "databaseName": "dataset", + "endpoint": "postgres.database.azure.com", + "userId": "demo_user@dataset-pgsql-srv", + "userPassword": "dataset#1234", + "portNumber": "5432", + "credentialType": "SqlAuthentication", + "clientId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "isCertAuth": false, + "certificate": null, + "thumbprint": null, + "clientSecret": null, + "authorityUrl": "https://login.microsoftonline.com", + "resourceUri": null, + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroup": "acjain-mleastUS2", + "serviceDataAccessAuthIdentity": "None" + }, + "azureMySqlSection": null, + "glusterFsSection": null, + "createdBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "Achal Jain" + }, + "modifiedBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "Achal Jain" + }, + "createdTime": "2020-09-08T05:45:46.8987749Z", + "modifiedTime": "2020-09-08T05:45:49.6476211Z", + "linkedInfo": null + }, + "identity": null, + "sku": null + } + }, + "201": { + "description": "The request was accepted.", + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateSqlDatastore.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateSqlDatastore.json new file mode 100644 index 000000000000..d63b9e62d7e9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateSqlDatastore.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroupName": "acjain-mleastUS2", + "workspaceName": "acjain-mleastUS2", + "api-version": "2020-05-01-preview", + "datastoreName": "sqlDatastore", + "properties": { + "dataStoreType": "sqldb", + "databaseName": "dataset", + "serverName": "dataset-azsql-srv", + "userName": "demo_user", + "password": "fwesfwfwf" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/35f16a99-532a-4a47-9e93-00305f6c40f2/resourceGroups/acjain-mleastUS2/providers/Microsoft.MachineLearningServices/workspaces/acjain-mleastUS2/datastores/sqlDatastore", + "name": "sqlDatastore", + "type": "Microsoft.MachineLearningServices/workspaces/datastores", + "location": "eastus2", + "tags": null, + "properties": { + "name": "sqldatastore", + "dataStoreType": "AzureSqlDatabase", + "hasBeenValidated": false, + "tags": null, + "azureStorageSection": null, + "azureDataLakeSection": null, + "azureSqlDatabaseSection": { + "serverName": "dataset-azsql-srv", + "databaseName": "dataset", + "endpoint": "database.windows.net", + "userId": "demo_user", + "userPassword": "dataset#1234", + "portNumber": null, + "credentialType": "SqlAuthentication", + "clientId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "isCertAuth": false, + "certificate": null, + "thumbprint": null, + "clientSecret": null, + "authorityUrl": "https://login.microsoftonline.com", + "resourceUri": "https://database.windows.net/", + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroup": "acjain-mleastUS2", + "serviceDataAccessAuthIdentity": "None" + }, + "azurePostgreSqlSection": null, + "azureMySqlSection": null, + "glusterFsSection": null, + "createdBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "Achal Jain" + }, + "modifiedBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "Achal Jain" + }, + "createdTime": "2020-09-08T05:35:54.770302Z", + "modifiedTime": "2020-09-08T05:35:55.7948043Z", + "linkedInfo": null + }, + "identity": null, + "sku": null + } + }, + "201": { + "description": "The request was accepted.", + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteDataset.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteDataset.json new file mode 100644 index 000000000000..2422b90bf58b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteDataset.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroupName": "acjain-mleastUS2", + "workspaceName": "acjain-mleastUS2", + "api-version": "2020-05-01-preview", + "datasetName": "filedatasetfromURL" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteDatastore.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteDatastore.json new file mode 100644 index 000000000000..35cece01460a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteDatastore.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroupName": "acjain-mleastUS2", + "workspaceName": "acjain-mleastUS2", + "api-version": "2020-05-01-preview", + "datastoreName": "testdagrtgtoresddddd" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getDataset.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getDataset.json new file mode 100644 index 000000000000..dde44e3cfe6d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getDataset.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroupName": "acjain-mleastUS2", + "workspaceName": "acjain-mleastUS2", + "api-version": "2020-05-01-preview", + "datasetName": "filedatasetfromURL" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/35f16a99-532a-4a47-9e93-00305f6c40f2/resourceGroups/acjain-mleastUS2/providers/Microsoft.MachineLearningServices/workspaces/acjain-mleastUS2/datasets/filedatasetfromURL", + "name": "filedatasetfromURL", + "type": "Microsoft.MachineLearningServices/workspaces/datasets", + "location": "eastus2", + "tags": null, + "properties": { + "datasetId": "3ebe138f-0933-4718-9178-f05a733d1bb3", + "datasetState": { + "state": "active", + "deprecatedBy": null, + "etag": null + }, + "latest": { + "datasetId": "3ebe138f-0933-4718-9178-f05a733d1bb3", + "versionId": "1", + "datasetDefinitionState": { + "state": "active", + "deprecatedBy": null, + "etag": null + }, + "dataflow": null, + "dataPath": { + "datastoreName": null, + "relativePath": "", + "azureFilePath": null, + "paths": null, + "sqlDataPath": null, + "httpUrl": "https://gist.githubusercontent.com/achalachal2003/da4886b7aec40bdd11a7613d664857c0/raw/7ca4ee355b5ee772a1fa73d5125d9cf018d868b9/banktest.csv", + "additionalProperties": {}, + "partitionFormat": null, + "partitionFormatIgnoreError": false + }, + "partitionFormatInPath": null, + "notes": "Auto generated from https://gist.githubusercontent.com/achalachal2003/da4886b7aec40bdd11a7613d664857c0/raw/7ca4ee355b5ee772a1fa73d5125d9cf018d868b9/banktest.csv", + "etag": "\"5c018cd9-0000-0200-0000-5f1630a40000\"", + "createdTime": "2020-07-21T00:02:44.9360911Z", + "modifiedTime": "2020-07-21T00:02:44.9360911Z", + "createdBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "c44b4083-3bb0-49c1-b47d-974e53cbdf3c" + }, + "fileType": "Unknown", + "properties": {}, + "savedDatasetId": "22fdf6fa-61a4-4f74-8ce2-57e6374998a6", + "telemetryInfo": {}, + "useDescriptionTagsFromDefinition": true, + "description": "", + "tags": {} + }, + "createdTime": "2020-07-21T00:02:44.9523499Z", + "modifiedTime": "2020-07-21T00:02:44.9523499Z", + "etag": "\"5c0198d9-0000-0200-0000-5f1630a40000\"", + "name": "filedatasetfromURL", + "description": "", + "tags": {}, + "isVisible": true, + "defaultCompute": null, + "datasetType": "file" + }, + "identity": null, + "sku": null + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getDatasets.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getDatasets.json new file mode 100644 index 000000000000..17631e8ed8d5 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getDatasets.json @@ -0,0 +1,156 @@ +{ + "parameters": { + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroupName": "acjain-mleastUS2", + "workspaceName": "acjain-mleastUS2", + "api-version": "2020-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/35f16a99-532a-4a47-9e93-00305f6c40f2/resourceGroups/acjain-mleastUS2/providers/Microsoft.MachineLearningServices/workspaces/acjain-mleastUS2/datasets/filedatasetfromURL", + "name": "filedatasetfromURL", + "type": "Microsoft.MachineLearningServices/workspaces/datasets", + "location": "eastus2", + "tags": null, + "properties": { + "datasetId": "3ebe138f-0933-4718-9178-f05a733d1bb3", + "datasetState": { + "state": "active", + "deprecatedBy": null, + "etag": null + }, + "latest": { + "datasetId": "3ebe138f-0933-4718-9178-f05a733d1bb3", + "versionId": "1", + "datasetDefinitionState": { + "state": "active", + "deprecatedBy": null, + "etag": null + }, + "dataflow": null, + "dataPath": { + "datastoreName": null, + "relativePath": "", + "azureFilePath": null, + "paths": null, + "sqlDataPath": null, + "httpUrl": "https://gist.githubusercontent.com/achalachal2003/da4886b7aec40bdd11a7613d664857c0/raw/7ca4ee355b5ee772a1fa73d5125d9cf018d868b9/banktest.csv", + "additionalProperties": {}, + "partitionFormat": null, + "partitionFormatIgnoreError": false + }, + "partitionFormatInPath": null, + "notes": "Auto generated from https://gist.githubusercontent.com/achalachal2003/da4886b7aec40bdd11a7613d664857c0/raw/7ca4ee355b5ee772a1fa73d5125d9cf018d868b9/banktest.csv", + "etag": "\"5c018cd9-0000-0200-0000-5f1630a40000\"", + "createdTime": "2020-07-21T00:02:44.9360911Z", + "modifiedTime": "2020-07-21T00:02:44.9360911Z", + "createdBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "c44b4083-3bb0-49c1-b47d-974e53cbdf3c" + }, + "fileType": "Unknown", + "properties": {}, + "savedDatasetId": "22fdf6fa-61a4-4f74-8ce2-57e6374998a6", + "telemetryInfo": {}, + "useDescriptionTagsFromDefinition": true, + "description": "", + "tags": {} + }, + "createdTime": "2020-07-21T00:02:44.9523499Z", + "modifiedTime": "2020-07-21T00:02:44.9523499Z", + "etag": "\"5c0198d9-0000-0200-0000-5f1630a40000\"", + "name": "filedatasetfromURL", + "description": "", + "tags": {}, + "isVisible": true, + "defaultCompute": null, + "datasetType": "file" + }, + "identity": null, + "sku": null + }, + { + "id": "/subscriptions/35f16a99-532a-4a47-9e93-00305f6c40f2/resourceGroups/acjain-mleastUS2/providers/Microsoft.MachineLearningServices/workspaces/acjain-mleastUS2/datasets/TABUALRFROMRELETIVEPATH", + "name": "TABUALRFROMRELETIVEPATH", + "type": "Microsoft.MachineLearningServices/workspaces/datasets", + "location": "eastus2", + "tags": null, + "properties": { + "datasetId": "2b241d0b-2a57-4cbb-8961-6f6b413c4029", + "datasetState": { + "state": "active", + "deprecatedBy": null, + "etag": null + }, + "latest": { + "datasetId": "2b241d0b-2a57-4cbb-8961-6f6b413c4029", + "versionId": "1", + "datasetDefinitionState": { + "state": "active", + "deprecatedBy": null, + "etag": null + }, + "dataflow": null, + "dataPath": { + "datastoreName": "testblobfromarm", + "relativePath": "UI/03-26-2020_083359_UTC/latin1encoding.csv", + "azureFilePath": "https://acjainmleastus9484093746.blob.core.windows.net/azureml-blobstore-5da947c5-53aa-41a5-bb2b-074074e73b76/UI/03-26-2020_083359_UTC/latin1encoding.csv", + "paths": null, + "sqlDataPath": null, + "httpUrl": null, + "additionalProperties": {}, + "partitionFormat": "", + "partitionFormatIgnoreError": false + }, + "partitionFormatInPath": null, + "notes": "Auto generated from UI/03-26-2020_083359_UTC/latin1encoding.csv.", + "etag": "\"5c01c275-0000-0200-0000-5f162fab0000\"", + "createdTime": "2020-07-20T23:58:35.221224Z", + "modifiedTime": "2020-07-20T23:58:35.221224Z", + "createdBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "c44b4083-3bb0-49c1-b47d-974e53cbdf3c" + }, + "fileType": "GenericCSVNoHeader", + "properties": { + "_TimeSeries_Column:CoarseGrainTimestamp_": "stabbr", + "_TimeSeries_Column:FineGrainTimestamp_": "city" + }, + "savedDatasetId": "d2845be6-786e-4419-b049-5887a2ef4ed8", + "telemetryInfo": {}, + "useDescriptionTagsFromDefinition": true, + "description": "", + "tags": {} + }, + "createdTime": "2020-07-20T23:58:35.2303194Z", + "modifiedTime": "2020-07-20T23:58:35.2303194Z", + "etag": "\"5c01c475-0000-0200-0000-5f162fab0000\"", + "name": "TABUALRFROMRELETIVEPATH", + "description": "", + "tags": {}, + "isVisible": true, + "defaultCompute": null, + "datasetType": "tabular" + }, + "identity": null, + "sku": null + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getDatastore.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getDatastore.json new file mode 100644 index 000000000000..42168acb8b3d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getDatastore.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroupName": "acjain-mleastUS2", + "workspaceName": "acjain-mleastUS2", + "api-version": "2020-05-01-preview", + "datastoreName": "testdatastore" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/35f16a99-532a-4a47-9e93-00305f6c40f2/resourceGroups/acjain-mleastUS2/providers/Microsoft.MachineLearningServices/workspaces/acjain-mleastUS2/datastores/testdatastore", + "name": "testdatastore", + "type": "Microsoft.MachineLearningServices/workspaces/datastores", + "location": "eastus2", + "tags": null, + "properties": { + "name": "testdatastore", + "dataStoreType": "AzureBlob", + "hasBeenValidated": true, + "tags": null, + "azureStorageSection": { + "accountName": "acjainmleastus9484093746", + "containerName": "azureml-blobstore-5da947c5-53aa-41a5-bb2b-074074e73b76", + "endpoint": "core.windows.net", + "protocol": "https", + "credentialType": "AccountKey", + "credential": "", + "clientCredentials": null, + "blobCacheTimeout": null, + "isSas": true, + "accountKey": null, + "sasToken": "", + "areWorkspaceManagedIdentitiesAllowed": false, + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroup": "acjain-mleastUS2", + "serviceDataAccessAuthIdentity": "None" + }, + "azureDataLakeSection": null, + "azureSqlDatabaseSection": null, + "azurePostgreSqlSection": null, + "azureMySqlSection": null, + "glusterFsSection": null, + "createdBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "Achal Jain" + }, + "modifiedBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "Achal Jain" + }, + "createdTime": "2020-08-29T01:50:59.2350285Z", + "modifiedTime": "2020-09-01T19:21:58.4173051Z", + "linkedInfo": null + }, + "identity": null, + "sku": null + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getDatastores.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getDatastores.json new file mode 100644 index 000000000000..5f3e3106c048 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getDatastores.json @@ -0,0 +1,485 @@ +{ + "parameters": { + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroupName": "acjain-mleastUS2", + "workspaceName": "acjain-mleastUS2", + "api-version": "2020-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/35f16a99-532a-4a47-9e93-00305f6c40f2/resourceGroups/acjain-mleastUS2/providers/Microsoft.MachineLearningServices/workspaces/acjain-mleastUS2/datastores/testdagrtgtoresddddd", + "name": "testdagrtgtoresddddd", + "type": "Microsoft.MachineLearningServices/workspaces/datastores", + "location": "eastus2", + "tags": null, + "properties": { + "name": "testdagrtgtoresddddd", + "dataStoreType": "AzureBlob", + "hasBeenValidated": true, + "tags": null, + "azureStorageSection": { + "accountName": "acjainmleastus9484093746", + "containerName": "azureml-blobstore-5da947c5-53aa-41a5-bb2b-074074e73b76", + "endpoint": "core.windows.net", + "protocol": "https", + "credentialType": "AccountKey", + "credential": "", + "clientCredentials": null, + "blobCacheTimeout": null, + "isSas": true, + "accountKey": null, + "sasToken": "", + "areWorkspaceManagedIdentitiesAllowed": false, + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroup": "acjain-mleastUS2", + "serviceDataAccessAuthIdentity": "None" + }, + "azureDataLakeSection": null, + "azureSqlDatabaseSection": null, + "azurePostgreSqlSection": null, + "azureMySqlSection": null, + "glusterFsSection": null, + "createdBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "Achal Jain" + }, + "modifiedBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "Achal Jain" + }, + "createdTime": "2020-08-29T01:50:59.2350285Z", + "modifiedTime": "2020-09-01T19:21:58.4173051Z", + "linkedInfo": null + }, + "identity": null, + "sku": null + }, + { + "id": "/subscriptions/35f16a99-532a-4a47-9e93-00305f6c40f2/resourceGroups/acjain-mleastUS2/providers/Microsoft.MachineLearningServices/workspaces/acjain-mleastUS2/datastores/adlsgen111", + "name": "adlsgen111", + "type": "Microsoft.MachineLearningServices/workspaces/datastores", + "location": "eastus2", + "tags": null, + "properties": { + "name": "adlsgen111", + "dataStoreType": "AzureDataLake", + "hasBeenValidated": true, + "tags": null, + "azureStorageSection": null, + "azureDataLakeSection": { + "storeName": "stanley", + "credentialType": "ServicePrincipal", + "clientId": "233d7008-b157-4354-88d1-ba191f06a900", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "isCertAuth": false, + "certificate": null, + "thumbprint": null, + "clientSecret": "", + "authorityUrl": "https://login.microsoftonline.com", + "resourceUri": "https://datalake.azure.net/", + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroup": "acjain-mleastUS2", + "serviceDataAccessAuthIdentity": "None" + }, + "azureSqlDatabaseSection": null, + "azurePostgreSqlSection": null, + "azureMySqlSection": null, + "glusterFsSection": null, + "createdBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "c44b4083-3bb0-49c1-b47d-974e53cbdf3c" + }, + "modifiedBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "c44b4083-3bb0-49c1-b47d-974e53cbdf3c" + }, + "createdTime": "2020-07-21T00:06:39.2747836Z", + "modifiedTime": "2020-07-21T00:06:39.2747836Z", + "linkedInfo": null + }, + "identity": null, + "sku": null + }, + { + "id": "/subscriptions/35f16a99-532a-4a47-9e93-00305f6c40f2/resourceGroups/acjain-mleastUS2/providers/Microsoft.MachineLearningServices/workspaces/acjain-mleastUS2/datastores/swlfromarmdd", + "name": "swlfromarmdd", + "type": "Microsoft.MachineLearningServices/workspaces/datastores", + "location": "eastus2", + "tags": null, + "properties": { + "name": "swlfromarmdd", + "dataStoreType": "AzureSqlDatabase", + "hasBeenValidated": true, + "tags": null, + "azureStorageSection": null, + "azureDataLakeSection": null, + "azureSqlDatabaseSection": { + "serverName": "dataset-azsql-srv", + "databaseName": "dataset", + "endpoint": "database.windows.net", + "userId": "demo_user", + "userPassword": "", + "portNumber": null, + "credentialType": "SqlAuthentication", + "clientId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "isCertAuth": false, + "certificate": null, + "thumbprint": null, + "clientSecret": null, + "authorityUrl": "https://login.microsoftonline.com", + "resourceUri": "https://database.windows.net/", + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroup": "acjain-mleastUS2", + "serviceDataAccessAuthIdentity": "None" + }, + "azurePostgreSqlSection": null, + "azureMySqlSection": null, + "glusterFsSection": null, + "createdBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "c44b4083-3bb0-49c1-b47d-974e53cbdf3c" + }, + "modifiedBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "c44b4083-3bb0-49c1-b47d-974e53cbdf3c" + }, + "createdTime": "2020-07-21T00:04:54.1317421Z", + "modifiedTime": "2020-07-21T00:04:54.1317421Z", + "linkedInfo": null + }, + "identity": null, + "sku": null + }, + { + "id": "/subscriptions/35f16a99-532a-4a47-9e93-00305f6c40f2/resourceGroups/acjain-mleastUS2/providers/Microsoft.MachineLearningServices/workspaces/acjain-mleastUS2/datastores/fileshareds", + "name": "fileshareds", + "type": "Microsoft.MachineLearningServices/workspaces/datastores", + "location": "eastus2", + "tags": null, + "properties": { + "name": "fileshareds", + "dataStoreType": "AzureFile", + "hasBeenValidated": true, + "tags": null, + "azureStorageSection": { + "accountName": "acjainmleastus9484093746", + "containerName": "azureml-filestore-5da947c5-53aa-41a5-bb2b-074074e73b76", + "endpoint": "core.windows.net", + "protocol": "https", + "credentialType": "AccountKey", + "credential": "", + "clientCredentials": null, + "blobCacheTimeout": null, + "isSas": false, + "accountKey": "", + "sasToken": null, + "areWorkspaceManagedIdentitiesAllowed": false, + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroup": "acjain-mleastUS2", + "serviceDataAccessAuthIdentity": "None" + }, + "azureDataLakeSection": null, + "azureSqlDatabaseSection": null, + "azurePostgreSqlSection": null, + "azureMySqlSection": null, + "glusterFsSection": null, + "createdBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "c44b4083-3bb0-49c1-b47d-974e53cbdf3c" + }, + "modifiedBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "c44b4083-3bb0-49c1-b47d-974e53cbdf3c" + }, + "createdTime": "2020-07-21T00:01:42.4401133Z", + "modifiedTime": "2020-07-21T00:01:42.4401133Z", + "linkedInfo": null + }, + "identity": null, + "sku": null + }, + { + "id": "/subscriptions/35f16a99-532a-4a47-9e93-00305f6c40f2/resourceGroups/acjain-mleastUS2/providers/Microsoft.MachineLearningServices/workspaces/acjain-mleastUS2/datastores/dbfssssss", + "name": "dbfssssss", + "type": "Microsoft.MachineLearningServices/workspaces/datastores", + "location": "eastus2", + "tags": null, + "properties": { + "name": "dbfssssss", + "dataStoreType": "DBFS", + "hasBeenValidated": false, + "tags": null, + "azureStorageSection": null, + "azureDataLakeSection": null, + "azureSqlDatabaseSection": null, + "azurePostgreSqlSection": null, + "azureMySqlSection": null, + "glusterFsSection": null, + "createdBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "c44b4083-3bb0-49c1-b47d-974e53cbdf3c" + }, + "modifiedBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "c44b4083-3bb0-49c1-b47d-974e53cbdf3c" + }, + "createdTime": "2020-07-20T23:51:06.8380341Z", + "modifiedTime": "2020-07-20T23:51:06.8380341Z", + "linkedInfo": null + }, + "identity": null, + "sku": null + }, + { + "id": "/subscriptions/35f16a99-532a-4a47-9e93-00305f6c40f2/resourceGroups/acjain-mleastUS2/providers/Microsoft.MachineLearningServices/workspaces/acjain-mleastUS2/datastores/mysqldatastorearm", + "name": "mysqldatastorearm", + "type": "Microsoft.MachineLearningServices/workspaces/datastores", + "location": "eastus2", + "tags": null, + "properties": { + "name": "mysqldatastorearm", + "dataStoreType": "AzureMySql", + "hasBeenValidated": true, + "tags": null, + "azureStorageSection": null, + "azureDataLakeSection": null, + "azureSqlDatabaseSection": null, + "azurePostgreSqlSection": null, + "azureMySqlSection": { + "serverName": "dataset-mysql-srv", + "databaseName": "dataset", + "endpoint": "mysql.database.azure.com", + "userId": "demo_user@dataset-mysql-srv", + "userPassword": "", + "portNumber": "3306", + "credentialType": "SqlAuthentication", + "clientId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "isCertAuth": false, + "certificate": null, + "thumbprint": null, + "clientSecret": null, + "authorityUrl": null, + "resourceUri": null, + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroup": "acjain-mleastUS2", + "serviceDataAccessAuthIdentity": "None" + }, + "glusterFsSection": null, + "createdBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "c44b4083-3bb0-49c1-b47d-974e53cbdf3c" + }, + "modifiedBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "c44b4083-3bb0-49c1-b47d-974e53cbdf3c" + }, + "createdTime": "2020-07-20T23:47:30.8639577Z", + "modifiedTime": "2020-07-20T23:47:30.8639577Z", + "linkedInfo": null + }, + "identity": null, + "sku": null + }, + { + "id": "/subscriptions/35f16a99-532a-4a47-9e93-00305f6c40f2/resourceGroups/acjain-mleastUS2/providers/Microsoft.MachineLearningServices/workspaces/acjain-mleastUS2/datastores/adlsgen2datastorearm", + "name": "adlsgen2datastorearm", + "type": "Microsoft.MachineLearningServices/workspaces/datastores", + "location": "eastus2", + "tags": null, + "properties": { + "name": "adlsgen2datastorearm", + "dataStoreType": "AzureDataLakeGen2", + "hasBeenValidated": true, + "tags": null, + "azureStorageSection": { + "accountName": "nicksadlsgen2storage", + "containerName": "https://nicksadlsgen2storage.blob.core.windows.net/testfs1", + "endpoint": "core.windows.net", + "protocol": "https", + "credentialType": "ClientCredentials", + "credential": null, + "clientCredentials": { + "clientId": "233d7008-b157-4354-88d1-ba191f06a900", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "isCertAuth": false, + "certificate": null, + "thumbprint": null, + "clientSecret": "", + "authorityUrl": "https://login.microsoftonline.com", + "resourceUri": "https://storage.azure.com/", + "subscriptionId": null, + "resourceGroup": null, + "serviceDataAccessAuthIdentity": "None" + }, + "blobCacheTimeout": null, + "isSas": false, + "accountKey": null, + "sasToken": null, + "areWorkspaceManagedIdentitiesAllowed": false, + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroup": "acjain-mleastUS2", + "serviceDataAccessAuthIdentity": "None" + }, + "azureDataLakeSection": null, + "azureSqlDatabaseSection": null, + "azurePostgreSqlSection": null, + "azureMySqlSection": null, + "glusterFsSection": null, + "createdBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "c44b4083-3bb0-49c1-b47d-974e53cbdf3c" + }, + "modifiedBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "c44b4083-3bb0-49c1-b47d-974e53cbdf3c" + }, + "createdTime": "2020-07-20T23:45:09.0121271Z", + "modifiedTime": "2020-07-20T23:45:09.0121271Z", + "linkedInfo": null + }, + "identity": null, + "sku": null + }, + { + "id": "/subscriptions/35f16a99-532a-4a47-9e93-00305f6c40f2/resourceGroups/acjain-mleastUS2/providers/Microsoft.MachineLearningServices/workspaces/acjain-mleastUS2/datastores/postgrearm22", + "name": "postgrearm22", + "type": "Microsoft.MachineLearningServices/workspaces/datastores", + "location": "eastus2", + "tags": null, + "properties": { + "name": "postgrearm22", + "dataStoreType": "AzurePostgreSql", + "hasBeenValidated": true, + "tags": null, + "azureStorageSection": null, + "azureDataLakeSection": null, + "azureSqlDatabaseSection": null, + "azurePostgreSqlSection": { + "enableSsl": true, + "serverName": "dataset-pgsql-srv", + "databaseName": "dataset", + "endpoint": "postgres.database.azure.com", + "userId": "demo_user@dataset-pgsql-srv", + "userPassword": "", + "portNumber": "5432", + "credentialType": "SqlAuthentication", + "clientId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "isCertAuth": false, + "certificate": null, + "thumbprint": null, + "clientSecret": null, + "authorityUrl": null, + "resourceUri": null, + "subscriptionId": "35f16a99-532a-4a47-9e93-00305f6c40f2", + "resourceGroup": "acjain-mleastUS2", + "serviceDataAccessAuthIdentity": "None" + }, + "azureMySqlSection": null, + "glusterFsSection": null, + "createdBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "c44b4083-3bb0-49c1-b47d-974e53cbdf3c" + }, + "modifiedBy": { + "userObjectId": "fa3fb1ee-ab39-4c79-b5ea-9dcb0a0b1a5c", + "userPuId": "100320004068320D", + "userIdp": null, + "userAltSecId": null, + "userIss": "https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/", + "userTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "userName": "c44b4083-3bb0-49c1-b47d-974e53cbdf3c" + }, + "createdTime": "2020-07-20T23:41:33.0368305Z", + "modifiedTime": "2020-07-20T23:41:33.0368305Z", + "linkedInfo": null + }, + "identity": null, + "sku": null + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/machineLearningServices.json index 12dd8bd3a957..a6f3152dd155 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/machineLearningServices.json @@ -1643,6 +1643,423 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datasets": { + "get": { + "tags": [ + "MachineLearningDatasets" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "operationId": "MachineLearningDatasets_ListByWorkspace", + "description": "Gets datasets in specified workspace.", + "x-ms-examples": { + "Get Datasets": { + "$ref": "./examples/getDatasets.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The response includes a paginated array of Machine Learning datasets and a URI to the next set of results, if any. For the more information the limits of the number of items in a resource group, see https://azure.microsoft.com/en-us/documentation/articles/azure-subscription-service-limits/.", + "schema": { + "$ref": "#/definitions/PaginatedDatasetResourcesList" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datasets/{datasetName}": { + "get": { + "tags": [ + "MachineLearningDatasets" + ], + "operationId": "MachineLearningDatasets_Get", + "description": "Get a Dataset by name.", + "x-ms-examples": { + "Get Dataset": { + "$ref": "./examples/getDataset.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/DatasetNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatasetResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "put": { + "tags": [ + "MachineLearningDatasets" + ], + "operationId": "MachineLearningDatasets_CreateOrUpdate", + "description": "Creates or updates dataset. This call will overwrite a dataset if it exists. This is a nonrecoverable operation. If your intent is to create a new dataset, do a GET first to verify that it does not exist yet.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create Dataset": { + "$ref": "./examples/createOrUpdateDataset.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/DatasetNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "in": "body", + "name": "properties", + "description": "The payload that is used to create or update the Dataset.", + "required": true, + "schema": { + "$ref": "#/definitions/DatasetCreateRequest" + } + } + ], + "responses": { + "200": { + "description": "Dataset creation or update initiated.", + "schema": { + "$ref": "#/definitions/DatasetResource" + } + }, + "201": { + "description": "Dataset creation or update initiated.", + "headers": { + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "delete": { + "tags": [ + "MachineLearningDatasets" + ], + "operationId": "MachineLearningDatasets_Delete", + "description": "Deletes specified Machine Learning Dataset.", + "x-ms-examples": { + "Delete Dataset": { + "$ref": "./examples/deleteDataset.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/DatasetNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "204": { + "description": "The resource does not exist and the request was well formed." + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores": { + "get": { + "tags": [ + "MachineLearningDatastores" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "operationId": "MachineLearningDatastores_ListByWorkspace", + "description": "Gets datastores in specified workspace.", + "x-ms-examples": { + "Get Datastores": { + "$ref": "./examples/getDatastores.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The response includes a paginated array of Machine Learning datastores and a URI to the next set of results, if any. For the more information the limits of the number of items in a resource group, see https://azure.microsoft.com/en-us/documentation/articles/azure-subscription-service-limits/.", + "schema": { + "$ref": "#/definitions/PaginatedDatastoreResourcesList" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/datastores/{datastoreName}": { + "get": { + "tags": [ + "MachineLearningDatastores" + ], + "operationId": "MachineLearningDatastores_Get", + "description": "Get a Datastore by name.", + "x-ms-examples": { + "Get Datastore": { + "$ref": "./examples/getDatastore.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/DatastoreNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatastoreResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "put": { + "tags": [ + "MachineLearningDatastores" + ], + "operationId": "MachineLearningDatastores_CreateOrUpdate", + "description": "Creates or updates datastore. This call will overwrite a dataset if it exists. This is a nonrecoverable operation. If your intent is to create a new dataset, do a GET first to verify that it does not exist yet.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create Blob Datastore": { + "$ref": "./examples/createOrUpdateBlobDatastore.json" + }, + "Create File Datastore": { + "$ref": "./examples/createOrUpdateFileDatastore.json" + }, + "Create SQL Datastore": { + "$ref": "./examples/createOrUpdateSqlDatastore.json" + }, + "Create PostgreSQL Datastore": { + "$ref": "./examples/createOrUpdatePostgreSqlDatastore.json" + }, + "Create MySQL Datastore": { + "$ref": "./examples/createOrUpdateMySqlDatastore.json" + }, + "Create ADLS Datastore": { + "$ref": "./examples/createOrUpdateAdlsDatastore.json" + }, + "Create ADLS Gen2 Datastore": { + "$ref": "./examples/createOrUpdateAdlsGen2Datastore.json" + }, + "Create Databricks File System Datastore": { + "$ref": "./examples/createOrUpdateDbfsDatastore.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/DatastoreNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "in": "body", + "name": "properties", + "description": "The payload that is used to create or update the Datastore.", + "required": true, + "schema": { + "$ref": "#/definitions/DatastoreCreateRequest" + } + } + ], + "responses": { + "200": { + "description": "Datastore creation or update initiated.", + "schema": { + "$ref": "#/definitions/DatastoreResource" + } + }, + "201": { + "description": "Datastore creation or update initiated.", + "headers": { + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "delete": { + "tags": [ + "MachineLearningDatastores" + ], + "operationId": "MachineLearningDatastores_Delete", + "description": "Deletes specified Machine Learning Datastore.", + "x-ms-examples": { + "Delete Datastore": { + "$ref": "./examples/deleteDatastore.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/DatastoreNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "204": { + "description": "The resource does not exist and the request was well formed." + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } } }, "parameters": { @@ -1849,6 +2266,22 @@ "modelAsString": true }, "x-ms-parameter-location": "method" + }, + "DatasetNameParameter": { + "in": "path", + "name": "datasetName", + "type": "string", + "description": "The Dataset name.", + "required": true, + "x-ms-parameter-location": "method" + }, + "DatastoreNameParameter": { + "in": "path", + "name": "datastoreName", + "type": "string", + "description": "The Datastore name.", + "required": true, + "x-ms-parameter-location": "method" } }, "definitions": { @@ -1986,627 +2419,1417 @@ "description": "The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace", "readOnly": true }, - "privateLinkCount": { + "privateLinkCount": { + "type": "integer", + "format": "int32", + "description": "Count of private connections in the workspace", + "readOnly": true + }, + "imageBuildCompute": { + "description": "The compute name for image build", + "type": "string" + }, + "allowPublicAccessWhenBehindVnet": { + "type": "boolean", + "description": "The flag to indicate whether to allow public access when behind VNet.", + "default": false + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The list of private endpoint connections in the workspace." + }, + "sharedPrivateLinkResources": { + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "description": "The list of shared private link resources in this workspace." + } + } + }, + "WorkspaceUpdateParameters": { + "description": "The parameters for updating a machine learning workspace.", + "properties": { + "tags": { + "description": "The resource tags for the machine learning workspace.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the workspace." + }, + "properties": { + "$ref": "#/definitions/WorkspacePropertiesUpdateParameters", + "description": "The properties that the machine learning workspace will be updated with.", + "x-ms-client-flatten": true + } + } + }, + "WorkspacePropertiesUpdateParameters": { + "description": "The parameters for updating the properties of a machine learning workspace.", + "properties": { + "description": { + "description": "The description of this workspace.", + "type": "string" + }, + "friendlyName": { + "description": "The friendly name for this workspace.", + "type": "string" + } + } + }, + "AmlUserFeature": { + "description": "Features enabled for a workspace", + "type": "object", + "properties": { + "id": { + "description": "Specifies the feature ID", + "type": "string" + }, + "displayName": { + "description": "Specifies the feature name ", + "type": "string" + }, + "description": { + "description": "Describes the feature for user experience", + "type": "string" + } + } + }, + "ListAmlUserFeatureResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AmlUserFeature" + }, + "description": "The list of AML user facing features." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page of AML user features information. Call ListNext() with this to fetch the next page of AML user features information." + } + }, + "description": "The List Aml user feature operation response." + }, + "UsageName": { + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource ID." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource type." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of usage measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": true + } + }, + "currentValue": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The current usage of the resource." + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "readOnly": true, + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "description": "Describes AML Resource Usage." + }, + "ListUsagesResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of AML resource usages." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page of AML resource usage information. Call ListNext() with this to fetch the next page of AML resource usage information." + } + }, + "description": "The List Usages operation response." + }, + "VirtualMachineSize": { + "properties": { + "name": { + "type": "string", + "title": "Virtual Machine size name", + "description": "The name of the virtual machine size.", + "readOnly": true + }, + "family": { + "type": "string", + "title": "Virtual Machine family name", + "description": "The family name of the virtual machine size.", + "readOnly": true + }, + "vCPUs": { + "type": "integer", + "format": "int32", + "title": "Number of vPUs", + "description": "The number of vCPUs supported by the virtual machine size.", + "readOnly": true + }, + "gpus": { + "type": "integer", + "format": "int32", + "title": "Number of gPUs", + "description": "The number of gPUs supported by the virtual machine size.", + "readOnly": true + }, + "osVhdSizeMB": { + "type": "integer", + "format": "int32", + "title": "OS VHD Disk size", + "description": "The OS VHD disk size, in MB, allowed by the virtual machine size.", + "readOnly": true + }, + "maxResourceVolumeMB": { "type": "integer", "format": "int32", - "description": "Count of private connections in the workspace", + "title": "Resource volume size", + "description": "The resource volume size, in MB, allowed by the virtual machine size.", "readOnly": true }, - "imageBuildCompute": { - "description": "The compute name for image build", - "type": "string" + "memoryGB": { + "type": "number", + "format": "double", + "title": "Memory size", + "description": "The amount of memory, in GB, supported by the virtual machine size.", + "readOnly": true }, - "allowPublicAccessWhenBehindVnet": { + "lowPriorityCapable": { "type": "boolean", - "description": "The flag to indicate whether to allow public access when behind VNet.", - "default": false + "title": "Low priority capable", + "description": "Specifies if the virtual machine size supports low priority VMs.", + "readOnly": true }, - "privateEndpointConnections": { - "readOnly": true, + "premiumIO": { + "type": "boolean", + "title": "Premium IO supported", + "description": "Specifies if the virtual machine size supports premium IO.", + "readOnly": true + } + }, + "description": "Describes the properties of a VM size." + }, + "VirtualMachineSizeListResult": { + "properties": { + "amlCompute": { "type": "array", "items": { - "$ref": "#/definitions/PrivateEndpointConnection" + "$ref": "#/definitions/VirtualMachineSize" }, - "description": "The list of private endpoint connections in the workspace." - }, - "sharedPrivateLinkResources": { + "description": "The list of virtual machine sizes supported by AmlCompute." + } + }, + "description": "The List Virtual Machine size operation response." + }, + "WorkspaceListResult": { + "description": "The result of a request to list machine learning workspaces.", + "properties": { + "value": { + "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", "type": "array", "items": { - "$ref": "#/definitions/SharedPrivateLinkResource" - }, - "description": "The list of shared private link resources in this workspace." + "$ref": "#/definitions/Workspace" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next list of machine learning workspaces.", + "type": "string" } } }, - "WorkspaceUpdateParameters": { - "description": "The parameters for updating a machine learning workspace.", + "QuotaBaseProperties": { "properties": { - "tags": { - "description": "The resource tags for the machine learning workspace.", - "type": "object", - "additionalProperties": { - "type": "string" - } + "id": { + "type": "string", + "description": "Specifies the resource ID." }, - "sku": { - "$ref": "#/definitions/Sku", - "description": "The sku of the workspace." + "type": { + "type": "string", + "description": "Specifies the resource type." }, - "properties": { - "$ref": "#/definitions/WorkspacePropertiesUpdateParameters", - "description": "The properties that the machine learning workspace will be updated with.", - "x-ms-client-flatten": true + "limit": { + "type": "integer", + "format": "int64", + "title": "Limit.", + "description": "The maximum permitted quota of the resource." + }, + "unit": { + "type": "string", + "description": "An enum describing the unit of quota measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "QuotaUnit", + "modelAsString": true + } } - } + }, + "description": "The properties for Quota update or retrieval." }, - "WorkspacePropertiesUpdateParameters": { - "description": "The parameters for updating the properties of a machine learning workspace.", + "QuotaUpdateParameters": { "properties": { - "description": { - "description": "The description of this workspace.", - "type": "string" + "value": { + "description": "The list for update quota.", + "type": "array", + "items": { + "$ref": "#/definitions/QuotaBaseProperties" + } + } + }, + "description": "Quota update parameters." + }, + "UpdateWorkspaceQuotasResult": { + "properties": { + "value": { + "description": "The list of workspace quota update result.", + "items": { + "$ref": "#/definitions/UpdateWorkspaceQuotas" + }, + "readOnly": true, + "type": "array" }, - "friendlyName": { - "description": "The friendly name for this workspace.", + "nextLink": { + "description": "The URI to fetch the next page of workspace quota update result. Call ListNext() with this to fetch the next page of Workspace Quota update result.", + "readOnly": true, "type": "string" } - } + }, + "description": "The result of update workspace quota." }, - "AmlUserFeature": { - "description": "Features enabled for a workspace", - "type": "object", + "UpdateWorkspaceQuotas": { "properties": { "id": { - "description": "Specifies the feature ID", - "type": "string" + "readOnly": true, + "type": "string", + "description": "Specifies the resource ID." }, - "displayName": { - "description": "Specifies the feature name ", - "type": "string" + "type": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource type." }, - "description": { - "description": "Describes the feature for user experience", - "type": "string" + "limit": { + "type": "integer", + "format": "int64", + "title": "Limit.", + "description": "The maximum permitted quota of the resource." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of quota measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "QuotaUnit", + "modelAsString": true + } + }, + "status": { + "type": "string", + "readOnly": false, + "title": "Update Workspace Quota Status.", + "description": "Status of update workspace quota.", + "enum": [ + "Undefined", + "Success", + "Failure", + "InvalidQuotaBelowClusterMinimum", + "InvalidQuotaExceedsSubscriptionLimit", + "InvalidVMFamilyName", + "OperationNotSupportedForSku", + "OperationNotEnabledForRegion" + ], + "x-ms-enum": { + "name": "status", + "modelAsString": true + } } - } + }, + "description": "The properties for update Quota response." }, - "ListAmlUserFeatureResult": { + "ResourceName": { "properties": { "value": { "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/AmlUserFeature" - }, - "description": "The list of AML user facing features." + "type": "string", + "description": "The name of the resource." }, - "nextLink": { + "localizedValue": { "readOnly": true, "type": "string", - "description": "The URI to fetch the next page of AML user features information. Call ListNext() with this to fetch the next page of AML user features information." + "description": "The localized name of the resource." } }, - "description": "The List Aml user feature operation response." + "description": "The Resource Name." }, - "UsageName": { + "ResourceQuota": { "properties": { - "value": { + "id": { "readOnly": true, "type": "string", - "description": "The name of the resource." + "description": "Specifies the resource ID." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource type." + }, + "name": { + "$ref": "#/definitions/ResourceName", + "description": "Name of the resource.", + "readOnly": true + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int64", + "title": "Limit.", + "description": "The maximum permitted quota of the resource." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of quota measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "QuotaUnit", + "modelAsString": true + } + } + }, + "description": "The quota assigned to a resource." + }, + "ListWorkspaceQuotas": { + "properties": { + "value": { + "description": "The list of Workspace Quotas by VM Family", + "items": { + "$ref": "#/definitions/ResourceQuota" + }, + "readOnly": true, + "type": "array" }, - "localizedValue": { + "nextLink": { + "description": "The URI to fetch the next page of workspace quota information by VM Family. Call ListNext() with this to fetch the next page of Workspace Quota information.", "readOnly": true, - "type": "string", - "description": "The localized name of the resource." + "type": "string" } }, - "description": "The Usage Names." + "description": "The List WorkspaceQuotasByVMFamily operation response." }, - "Usage": { - "type": "object", + "Identity": { "properties": { - "id": { + "principalId": { "readOnly": true, "type": "string", - "description": "Specifies the resource ID." + "description": "The principal ID of resource identity." }, - "type": { + "tenantId": { "readOnly": true, "type": "string", - "description": "Specifies the resource type." + "description": "The tenant ID of resource." }, - "unit": { - "readOnly": true, + "type": { "type": "string", - "description": "An enum describing the unit of usage measurement.", + "description": "The identity type.", "enum": [ - "Count" + "SystemAssigned", + "SystemAssigned,UserAssigned", + "UserAssigned", + "None" ], "x-ms-enum": { - "name": "UsageUnit", - "modelAsString": true + "name": "ResourceIdentityType", + "modelAsString": false } }, - "currentValue": { - "readOnly": true, - "type": "integer", - "format": "int64", - "description": "The current usage of the resource." - }, - "limit": { - "readOnly": true, - "type": "integer", - "format": "int64", - "description": "The maximum permitted usage of the resource." - }, - "name": { - "readOnly": true, - "$ref": "#/definitions/UsageName", - "description": "The name of the type of usage." + "userAssignedIdentities": { + "$ref": "#/definitions/UserAssignedIdentities", + "description": "The user assigned identities associated with the resource." } }, - "description": "Describes AML Resource Usage." + "description": "Identity for the resource." }, - "ListUsagesResult": { + "UserAssignedIdentities": { + "description": "dictionary containing all the user assigned identities, with resourceId of the UAI as key.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + } + }, + "UserAssignedIdentity": { + "description": "User Assigned Identity", "properties": { - "value": { + "principalId": { "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/Usage" - }, - "description": "The list of AML resource usages." + "type": "string", + "description": "The principal ID of the user assigned identity." }, - "nextLink": { + "tenantId": { "readOnly": true, "type": "string", - "description": "The URI to fetch the next page of AML resource usage information. Call ListNext() with this to fetch the next page of AML resource usage information." + "description": "The tenant ID of the user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The clientId(aka appId) of the user assigned identity." } - }, - "description": "The List Usages operation response." + } }, - "VirtualMachineSize": { + "Resource": { + "description": "Azure Resource Manager resource envelope.", + "x-ms-azure-resource": true, "properties": { - "name": { + "id": { + "description": "Specifies the resource ID.", "type": "string", - "title": "Virtual Machine size name", - "description": "The name of the virtual machine size.", "readOnly": true }, - "family": { + "name": { + "description": "Specifies the name of the resource.", "type": "string", - "title": "Virtual Machine family name", - "description": "The family name of the virtual machine size.", - "readOnly": true - }, - "vCPUs": { - "type": "integer", - "format": "int32", - "title": "Number of vPUs", - "description": "The number of vCPUs supported by the virtual machine size.", - "readOnly": true - }, - "gpus": { - "type": "integer", - "format": "int32", - "title": "Number of gPUs", - "description": "The number of gPUs supported by the virtual machine size.", "readOnly": true }, - "osVhdSizeMB": { - "type": "integer", - "format": "int32", - "title": "OS VHD Disk size", - "description": "The OS VHD disk size, in MB, allowed by the virtual machine size.", - "readOnly": true + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." }, - "maxResourceVolumeMB": { - "type": "integer", - "format": "int32", - "title": "Resource volume size", - "description": "The resource volume size, in MB, allowed by the virtual machine size.", - "readOnly": true + "location": { + "description": "Specifies the location of the resource.", + "type": "string" }, - "memoryGB": { - "type": "number", - "format": "double", - "title": "Memory size", - "description": "The amount of memory, in GB, supported by the virtual machine size.", + "type": { + "description": "Specifies the type of the resource.", + "type": "string", "readOnly": true }, - "lowPriorityCapable": { - "type": "boolean", - "title": "Low priority capable", - "description": "Specifies if the virtual machine size supports low priority VMs.", - "readOnly": true + "tags": { + "description": "Contains resource tags defined as key/value pairs.", + "type": "object", + "additionalProperties": { + "type": "string" + } }, - "premiumIO": { - "type": "boolean", - "title": "Premium IO supported", - "description": "Specifies if the virtual machine size supports premium IO.", - "readOnly": true + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the workspace." } - }, - "description": "Describes the properties of a VM size." + } }, - "VirtualMachineSizeListResult": { + "ResourceId": { "properties": { - "amlCompute": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineSize" - }, - "description": "The list of virtual machine sizes supported by AmlCompute." + "id": { + "type": "string", + "description": "The ID of the resource" } }, - "description": "The List Virtual Machine size operation response." + "required": [ + "id" + ], + "description": "Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.", + "x-ms-azure-resource": true }, - "WorkspaceListResult": { - "description": "The result of a request to list machine learning workspaces.", + "ListWorkspaceKeysResult": { + "type": "object", "properties": { - "value": { - "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", - "type": "array", - "items": { - "$ref": "#/definitions/Workspace" - } + "userStorageKey": { + "readOnly": true, + "type": "string" }, - "nextLink": { - "description": "The URI that can be used to request the next list of machine learning workspaces.", + "userStorageResourceId": { + "readOnly": true, + "type": "string" + }, + "appInsightsInstrumentationKey": { + "readOnly": true, "type": "string" + }, + "containerRegistryCredentials": { + "readOnly": true, + "$ref": "#/definitions/RegistryListCredentialsResult" } } }, - "QuotaBaseProperties": { + "RegistryListCredentialsResult": { + "type": "object", "properties": { - "id": { - "type": "string", - "description": "Specifies the resource ID." - }, - "type": { - "type": "string", - "description": "Specifies the resource type." + "location": { + "readOnly": true, + "type": "string" }, - "limit": { - "type": "integer", - "format": "int64", - "title": "Limit.", - "description": "The maximum permitted quota of the resource." + "username": { + "readOnly": true, + "type": "string" }, - "unit": { - "type": "string", - "description": "An enum describing the unit of quota measurement.", - "enum": [ - "Count" - ], - "x-ms-enum": { - "name": "QuotaUnit", - "modelAsString": true + "passwords": { + "type": "array", + "items": { + "$ref": "#/definitions/Password" } } - }, - "description": "The properties for Quota update or retrieval." + } }, - "QuotaUpdateParameters": { + "Password": { + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string" + }, + "value": { + "readOnly": true, + "type": "string" + } + } + }, + "PaginatedDatasetResourcesList": { + "type": "object", + "description": "Paginated list of Machine Learning dataset objects wrapped in ARM resource envelope.", "properties": { "value": { - "description": "The list for update quota.", "type": "array", + "description": "An array of Machine Learning dataset objects wrapped in ARM resource envelope.", "items": { - "$ref": "#/definitions/QuotaBaseProperties" + "$ref": "#/definitions/DatasetResource" } + }, + "nextLink": { + "type": "string", + "description": "A continuation link (absolute URI) to the next page of results in the list." } - }, - "description": "Quota update parameters." + } }, - "UpdateWorkspaceQuotasResult": { - "properties": { - "value": { - "description": "The list of workspace quota update result.", - "items": { - "$ref": "#/definitions/UpdateWorkspaceQuotas" - }, - "readOnly": true, - "type": "array" + "DatasetResource": { + "type": "object", + "description": "Machine Learning dataset object wrapped into ARM resource envelope.", + "allOf": [ + { + "$ref": "#/definitions/Resource" }, - "nextLink": { - "description": "The URI to fetch the next page of workspace quota update result. Call ListNext() with this to fetch the next page of Workspace Quota update result.", - "readOnly": true, - "type": "string" + { + "type": "object", + "properties": { + "properties": { + "description": "Dataset properties", + "$ref": "#/definitions/Dataset" + } + } } - }, - "description": "The result of update workspace quota." + ] }, - "UpdateWorkspaceQuotas": { + "Dataset": { + "type": "object", + "description": "Machine Learning dataset object.", "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Specifies the resource ID." - }, - "type": { + "datasetId": { "readOnly": true, "type": "string", - "description": "Specifies the resource type." + "description": "Unique Dataset identifier." }, - "limit": { - "type": "integer", - "format": "int64", - "title": "Limit.", - "description": "The maximum permitted quota of the resource." + "datasetState": { + "type": "object", + "$ref": "#/definitions/DatasetState" }, - "unit": { - "readOnly": true, - "type": "string", - "description": "An enum describing the unit of quota measurement.", - "enum": [ - "Count" - ], - "x-ms-enum": { - "name": "QuotaUnit", - "modelAsString": true + "latest": { + "type": "object", + "description": "Last created Dataset definition.", + "properties": { + "datasetId": { + "readOnly": true, + "type": "string", + "description": "Unique Dataset identifier." + }, + "versionId": { + "readOnly": true, + "type": "string", + "description": "An identifier uniquely identifies a definition change." + }, + "datasetDefinitionState": { + "type": "object", + "$ref": "#/definitions/DatasetState" + }, + "dataflow": { + "readOnly": true, + "type": "string", + "description": "Dataflow Json" + }, + "dataPath": { + "type": "object", + "description": " Datastore and reference to location of data such as relativePath, Sql Query and etc.", + "properties": { + "datastoreName": { + "readOnly": true, + "type": "string", + "description": "Data store Name" + }, + "relativePath": { + "readOnly": true, + "type": "string", + "description": "Relative path in the data store" + }, + "azureFilePath": { + "readOnly": true, + "type": "string", + "description": "Azure path for Azure Blob or File" + }, + "paths": { + "type": "array", + "description": "List of files expanded from a file GLOB specified", + "items": { + "type": "string" + }, + "readOnly": true + }, + "sqlDataPath": { + "type": "object", + "description": "Sql Query/Table/Stored Procedure details.", + "properties": { + "sqlTableName": { + "readOnly": true, + "type": "string", + "description": "SQL table name" + }, + "sqlQuery": { + "readOnly": true, + "type": "string", + "description": "SQL query" + }, + "sqlStoredProcedureName": { + "readOnly": true, + "type": "string", + "description": "SQL storedProcedure name" + }, + "queryTimeout": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "SQL query timeout. Unit in seconds." + } + } + }, + "httpUrl": { + "readOnly": true, + "type": "string", + "description": "HTTP URL." + }, + "additionalProperties": { + "description": "Additional Properties.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "partitionFormat": { + "readOnly": true, + "type": "string", + "description": "Specify the partition format of path. Defaults to None." + }, + "partitionFormatIgnoreError": { + "type": "boolean", + "description": "Whether or not to ignore unmatched path.", + "readOnly": true + } + } + }, + "partitionFormatInPath": { + "type": "boolean", + "description": "Indicates how the source data is partitioned. This is defined to filter on a range of partitioned data before performing actions or materialization.", + "readOnly": true + }, + "notes": { + "type": "string", + "description": "Summary of Definition changes.", + "readOnly": true + }, + "etag": { + "type": "string", + "description": "eTag description", + "readOnly": true + }, + "createdTime": { + "format": "date-time", + "description": "The dataset creation time (UTC).", + "type": "string", + "readOnly": true + }, + "modifiedTime": { + "format": "date-time", + "description": "The dataset last modified time (UTC).", + "type": "string", + "readOnly": true + }, + "createdBy": { + "type": "object", + "$ref": "#/definitions/UserInfo" + }, + "fileType": { + "readOnly": true, + "type": "string", + "description": "Dataset FileType, specified by user." + }, + "properties": { + "description": "Properties stores information like name of time series column for time series dataset.", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "savedDatasetId": { + "readOnly": true, + "type": "string", + "description": "Indicates the saved dataset this definition is mapping to, populated on Get." + }, + "telemetryInfo": { + "description": " Telemetry information about the dataset including information like which service the dataset was created from.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "useDescriptionTagsFromDefinition": { + "type": "boolean", + "description": " Whether to use description and tags from the definition level as opposed to dataset level (old behavior).", + "readOnly": true + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Description about the dataset." + }, + "tags": { + "description": "Tags associated with the dataset.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } } }, - "status": { + "createdTime": { + "format": "date-time", + "description": "The dataset creation time (UTC).", "type": "string", - "readOnly": false, - "title": "Update Workspace Quota Status.", - "description": "Status of update workspace quota.", - "enum": [ - "Undefined", - "Success", - "Failure", - "InvalidQuotaBelowClusterMinimum", - "InvalidQuotaExceedsSubscriptionLimit", - "InvalidVMFamilyName", - "OperationNotSupportedForSku", - "OperationNotEnabledForRegion" - ], - "x-ms-enum": { - "name": "status", - "modelAsString": true - } - } - }, - "description": "The properties for update Quota response." - }, - "ResourceName": { - "properties": { - "value": { - "readOnly": true, + "readOnly": true + }, + "modifiedTime": { + "format": "date-time", + "description": "The dataset last modified time (UTC).", "type": "string", - "description": "The name of the resource." + "readOnly": true }, - "localizedValue": { - "readOnly": true, + "etag": { "type": "string", - "description": "The localized name of the resource." - } - }, - "description": "The Resource Name." - }, - "ResourceQuota": { - "properties": { - "id": { - "readOnly": true, + "description": "eTag description", + "readOnly": true + }, + "name": { "type": "string", - "description": "Specifies the resource ID." + "description": "Unique dataset name", + "readOnly": true }, - "type": { - "readOnly": true, + "description": { "type": "string", - "description": "Specifies the resource type." + "description": "Description about this dataset version.", + "readOnly": true }, - "name": { - "$ref": "#/definitions/ResourceName", - "description": "Name of the resource.", + "tags": { + "description": "Tags for this dataset version.", + "type": "object", + "additionalProperties": { + "type": "string" + }, "readOnly": true }, - "limit": { - "readOnly": true, - "type": "integer", - "format": "int64", - "title": "Limit.", - "description": "The maximum permitted quota of the resource." + "isVisible": { + "type": "boolean", + "description": "Flag to hide Dataset in UI", + "readOnly": true }, - "unit": { - "readOnly": true, + "defaultCompute": { "type": "string", - "description": "An enum describing the unit of quota measurement.", - "enum": [ - "Count" - ], - "x-ms-enum": { - "name": "QuotaUnit", - "modelAsString": true - } + "description": "Name of the default compute to be used for any Dataset actions (such as Profile, Write).", + "readOnly": true + }, + "datasetType": { + "type": "string", + "description": "Dataset Type.", + "readOnly": true } - }, - "description": "The quota assigned to a resource." + } }, - "ListWorkspaceQuotas": { + "DatasetState": { + "type": "object", + "description": "Dataset state", "properties": { - "value": { - "description": "The list of Workspace Quotas by VM Family", - "items": { - "$ref": "#/definitions/ResourceQuota" - }, - "readOnly": true, - "type": "array" + "state": { + "description": "Dataset state", + "type": "string" + }, + "deprecatedBy": { + "description": "Reference to better Dataset or a Definition", + "type": "object", + "properties": { + "datasetId": { + "readOnly": true, + "type": "string", + "description": "Unique Dataset identifier." + }, + "definitionVersion": { + "description": "Definition Version", + "type": "string" + } + } }, - "nextLink": { - "description": "The URI to fetch the next page of workspace quota information by VM Family. Call ListNext() with this to fetch the next page of Workspace Quota information.", - "readOnly": true, - "type": "string" + "etag": { + "type": "string", + "description": "eTag description", + "readOnly": true } - }, - "description": "The List WorkspaceQuotasByVMFamily operation response." + } }, - "Identity": { + "LinkedInfo": { + "type": "object", + "description": "Info about origin if it is linked.", "properties": { - "principalId": { - "readOnly": true, - "type": "string", - "description": "The principal ID of resource identity." - }, - "tenantId": { - "readOnly": true, + "linkedId": { "type": "string", - "description": "The tenant ID of resource." + "description": "LinkedId id." }, - "type": { + "linkedResourceName": { "type": "string", - "description": "The identity type.", - "enum": [ - "SystemAssigned", - "SystemAssigned,UserAssigned", - "UserAssigned", - "None" - ], - "x-ms-enum": { - "name": "ResourceIdentityType", - "modelAsString": false - } + "description": "Linked resource name." }, - "userAssignedIdentities": { - "$ref": "#/definitions/UserAssignedIdentities", - "description": "The user assigned identities associated with the resource." + "origin": { + "$ref": "#/definitions/Origin" } - }, - "description": "Identity for the resource." + } }, - "UserAssignedIdentities": { - "description": "dictionary containing all the user assigned identities, with resourceId of the UAI as key.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/UserAssignedIdentity" + "Origin": { + "description": "Datastore origin", + "enum": [ + "Synapse" + ], + "type": "string", + "x-ms-enum": { + "name": "Origin", + "modelAsString": true } }, - "UserAssignedIdentity": { - "description": "User Assigned Identity", + "UserInfo": { + "type": "object", + "description": "User who created.", "properties": { - "principalId": { - "readOnly": true, + "userObjectId": { "type": "string", - "description": "The principal ID of the user assigned identity." + "description": "A user or service principal's object ID.." }, - "tenantId": { - "readOnly": true, + "userPuId": { "type": "string", - "description": "The tenant ID of the user assigned identity." + "description": "A user or service principal's PuID." }, - "clientId": { - "readOnly": true, + "userIdp": { "type": "string", - "description": "The clientId(aka appId) of the user assigned identity." + "description": "A user identity provider. Eg live.com" + }, + "userAltSecId": { + "type": "string", + "description": "A user alternate sec id. This represents the user in a different identity provider system Eg.1:live.com:puid" + }, + "userIss": { + "type": "string", + "description": "The issuer which issued the token for this user." + }, + "userTenantId": { + "type": "string", + "description": "A user or service principal's tenant ID." + }, + "userName": { + "type": "string", + "description": " A user's full name or a service principal's app ID." } } }, - "Resource": { - "description": "Azure Resource Manager resource envelope.", - "x-ms-azure-resource": true, + "PaginatedDatastoreResourcesList": { + "type": "object", + "description": "Paginated list of Machine Learning datastore objects wrapped in ARM resource envelope.", "properties": { - "id": { - "description": "Specifies the resource ID.", + "value": { + "type": "array", + "description": "An array of Machine Learning datastore objects wrapped in ARM resource envelope.", + "items": { + "$ref": "#/definitions/DatastoreResource" + } + }, + "nextLink": { "type": "string", - "readOnly": true + "description": "A continuation link (absolute URI) to the next page of results in the list." + } + } + }, + "DatastoreResource": { + "type": "object", + "description": "Machine Learning datastore object wrapped into ARM resource envelope.", + "allOf": [ + { + "$ref": "#/definitions/Resource" }, + { + "type": "object", + "properties": { + "properties": { + "description": "Datastore properties", + "$ref": "#/definitions/Datastore" + } + } + } + ] + }, + "Datastore": { + "type": "object", + "description": "Machine Learning datastore object.", + "properties": { "name": { - "description": "Specifies the name of the resource.", "type": "string", - "readOnly": true - }, - "identity": { - "$ref": "#/definitions/Identity", - "description": "The identity of the resource." + "description": "Name of the datastore." }, - "location": { - "description": "Specifies the location of the resource.", - "type": "string" + "description": { + "type": "string", + "description": "Description of the datastore." }, - "type": { - "description": "Specifies the type of the resource.", + "dataStoreType": { + "description": "The datastore type.", + "enum": [ + "AzureBlob", + "AzureFile", + "AzureDataLake", + "AzureSqlDatabase", + "AzurePostgreSql", + "DBFS", + "AzureDataLakeGen2", + "AzureMySql" + ], "type": "string", - "readOnly": true + "x-ms-enum": { + "name": "DataStoreType", + "modelAsString": true + } + }, + "hasBeenValidated": { + "type": "boolean", + "default": false, + "description": "A read only property that denotes whether the service datastore has been validated with credentials." }, "tags": { - "description": "Contains resource tags defined as key/value pairs.", + "description": "Tags for this datastore.", "type": "object", "additionalProperties": { "type": "string" - } + }, + "readOnly": true }, - "sku": { - "$ref": "#/definitions/Sku", - "description": "The sku of the workspace." + "azureStorageSection": { + "type": "object", + "$ref": "#/definitions/AzureStorageSection" + }, + "azureDataLakeSection": { + "type": "object", + "$ref": "#/definitions/AzureDataLakeSection" + }, + "azureSqlDatabaseSection": { + "type": "object", + "$ref": "#/definitions/AzureSqlDatabaseSection" + }, + "azurePostgreSqlSection": { + "type": "object", + "$ref": "#/definitions/AzurePostgreSqlSection" + }, + "azureMySqlSection": { + "type": "object", + "$ref": "#/definitions/AzureMySqlSection" + }, + "glusterFsSection": { + "type": "object", + "$ref": "#/definitions/GlusterFsSection" + }, + "createdBy": { + "type": "object", + "description": "The User who created the datastore.", + "$ref": "#/definitions/UserInfo", + "readOnly": true + }, + "modifiedBy": { + "type": "object", + "description": "The User who modified the datastore.", + "$ref": "#/definitions/UserInfo", + "readOnly": true + }, + "createdTime": { + "type": "string", + "description": "The date and time when the datastore was created.", + "format": "date-time", + "readOnly": true + }, + "modifiedTime": { + "type": "string", + "description": "The date and time when the datastore was last modified.", + "format": "date-time", + "readOnly": true + }, + "linkedInfo": { + "type": "object", + "$ref": "#/definitions/LinkedInfo" } } }, - "ResourceId": { + "AzureResourceDatastore": { + "type": "object", + "description": "Azure resource for datastore.", "properties": { - "id": { + "subscriptionId": { "type": "string", - "description": "The ID of the resource" + "description": "Subscription ID." + }, + "resourceGroup": { + "type": "string", + "description": "Resource Group." + }, + "serviceDataAccessAuthIdentity": { + "description": "Indicates which identity to use to authenticate service data access to customer's storage.", + "enum": [ + "None", + "WorkspaceSystemAssignedIdentity" + ], + "type": "string", + "x-ms-enum": { + "name": "ServiceDataAccessAuthIdentity", + "modelAsString": true + } } - }, - "required": [ - "id" - ], - "description": "Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.", - "x-ms-azure-resource": true + } }, - "ListWorkspaceKeysResult": { - "type": "object", - "properties": { - "userStorageKey": { - "readOnly": true, - "type": "string" + "AzureStorageSection": { + "allOf": [ + { + "$ref": "#/definitions/AzureResourceDatastore" }, - "userStorageResourceId": { - "readOnly": true, - "type": "string" + { + "type": "object", + "description": "Data specific to azure storage.", + "properties": { + "accountName": { + "type": "string", + "description": "Storage Account Name." + }, + "containerName": { + "type": "string", + "description": "The storage container name." + }, + "endpoint": { + "type": "string", + "description": "The host of the container." + }, + "protocol": { + "type": "string", + "description": "The protocol to use. Defaults to https." + }, + "credentialType": { + "type": "object", + "$ref": "#/definitions/AzureStorageCredentialTypes" + }, + "credential": { + "type": "string", + "description": "The credential." + }, + "clientCredentials": { + "type": "object", + "$ref": "#/definitions/ClientCredentials" + }, + "blobCacheTimeout": { + "format": "int32", + "description": " If this is an \"DataStoreType.AzureBlob\", the length of time (in seconds) to cache files locally after they are accessed (downloaded).", + "type": "integer" + }, + "isSas": { + "description": "Indicate if we are using SAS token or Account Key (Deprecated).", + "type": "boolean" + }, + "accountKey": { + "type": "string", + "description": " Storage Account Key (Deprecated)." + }, + "sasToken": { + "type": "string", + "description": " SAS Token for the container (Deprecated)." + }, + "areWorkspaceManagedIdentitiesAllowed": { + "description": "Indicate if we are using Workspace ManagedIdentities/MSI token (Deprecated).", + "type": "boolean" + } + } + } + ] + }, + "AzureDataLakeSection": { + "allOf": [ + { + "$ref": "#/definitions/ClientCredentials" }, - "appInsightsInstrumentationKey": { - "readOnly": true, - "type": "string" + { + "type": "object", + "description": "Data Specific to azure data lake.", + "properties": { + "storeName": { + "type": "string", + "description": "The Azure Data Lake store name." + }, + "credentialType": { + "type": "object", + "$ref": "#/definitions/AzureDataLakeCredentialTypes" + } + } + } + ] + }, + "AzureSqlDatabaseSection": { + "allOf": [ + { + "$ref": "#/definitions/AzureSqlSection" + }, + { + "type": "object", + "description": "Data specific to azure SQL database." + } + ] + }, + "AzurePostgreSqlSection": { + "allOf": [ + { + "$ref": "#/definitions/AzureSqlSection" + }, + { + "type": "object", + "description": " Data specific to azure PostgreSQL.", + "properties": { + "enableSsl": { + "type": "boolean", + "description": "Indicates SSL requirement of Azure Postgresql server." + } + } + } + ] + }, + "AzureMySqlSection": { + "allOf": [ + { + "$ref": "#/definitions/AzureSqlSection" }, - "containerRegistryCredentials": { - "readOnly": true, - "$ref": "#/definitions/RegistryListCredentialsResult" + { + "type": "object", + "description": "Data specific to azure MySQL." } - } + ] }, - "RegistryListCredentialsResult": { + "GlusterFsSection": { "type": "object", + "description": "Data specific to GlusterFS.", "properties": { - "location": { - "readOnly": true, - "type": "string" + "serverAddress": { + "type": "string", + "description": "The server address of one of the servers that hosts the GlusterFS. Can be either the IP address or server name.", + "readOnly": true }, - "username": { - "readOnly": true, - "type": "string" + "volumeName": { + "type": "string", + "description": "The name of the created GlusterFS volume.", + "readOnly": true + } + } + }, + "AzureSqlSection": { + "allOf": [ + { + "$ref": "#/definitions/ClientCredentials" }, - "passwords": { - "type": "array", - "items": { - "$ref": "#/definitions/Password" + { + "type": "object", + "description": "Data specific to Azure SQL.", + "properties": { + "serverName": { + "type": "string", + "description": "The Azure SQL server name." + }, + "databaseName": { + "type": "string", + "description": "The Azure SQL database name." + }, + "endpoint": { + "type": "string", + "description": "The server host endpoint." + }, + "userId": { + "type": "string", + "description": "The Azure SQL user id." + }, + "userPassword": { + "type": "string", + "description": "The Azure SQL user password." + }, + "portNumber": { + "type": "string", + "description": "/ The Azure SQL port number." + }, + "credentialType": { + "type": "object", + "$ref": "#/definitions/SqlCredentialTypes" + } } } - } + ] }, - "Password": { - "type": "object", - "properties": { - "name": { - "readOnly": true, - "type": "string" + "ClientCredentials": { + "allOf": [ + { + "$ref": "#/definitions/AzureResourceDatastore" }, - "value": { - "readOnly": true, - "type": "string" + { + "type": "object", + "description": "Service principal credential when credential type is \"AzureStorageCredentialTypes.ClientCredentials\".", + "properties": { + "clientId": { + "type": "string", + "description": "The Client ID/Application ID" + }, + "tenantId": { + "type": "string", + "description": "The ID of the tenant the service principal/app belongs to." + }, + "isCertAuth": { + "description": " Is it using certificate to authenticate. If false then use client secret.", + "type": "boolean" + }, + "certificate": { + "type": "string", + "description": "The content of the certificate used for authentication." + }, + "thumbprint": { + "type": "string", + "description": "The thumbprint of the certificate above." + }, + "clientSecret": { + "type": "string", + "description": "The client secret." + }, + "authorityUrl": { + "type": "string", + "description": "The authority URL used for authentication." + }, + "resourceUri": { + "type": "string", + "description": "The resource the service principal/app has access to." + } + } } + ] + }, + "AzureStorageCredentialTypes": { + "description": " The credential type.", + "enum": [ + "None", + "Sas", + "AccountKey", + "ClientCredentials" + ], + "type": "string", + "x-ms-enum": { + "name": "AzureStorageCredentialTypes", + "modelAsString": true + } + }, + "AzureDataLakeCredentialTypes": { + "description": "The Azure Data Lake credential type.", + "enum": [ + "None", + "ServicePrincipal" + ], + "type": "string", + "x-ms-enum": { + "name": "AzureDataLakeCredentialTypes", + "modelAsString": true + } + }, + "SqlCredentialTypes": { + "description": "Sql Authentication type.", + "enum": [ + "SqlAuthentication", + "ServicePrincipal", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlCredentialTypes", + "modelAsString": true } }, "PaginatedComputeResourcesList": { @@ -5398,6 +6621,296 @@ } ], "x-ms-discriminator-value": "Custom" + }, + "DatasetCreateRequest": { + "description": "The request for creating dataset.", + "type": "object", + "properties": { + "skipValidation": { + "description": "Skip validation that ensures data can be loaded from the dataset before registration.", + "default": false, + "type": "boolean" + }, + "datasetType": { + "description": "Specifies dataset type.", + "type": "string", + "enum": [ + "tabular", + "file" + ], + "x-ms-enum": { + "name": "DatasetType", + "modelAsString": true + } + }, + "parameters": { + "type": "object", + "properties": { + "header": { + "description": "Header type.", + "type": "string", + "enum": [ + "all_files_have_same_headers", + "only_first_file_has_headers", + "no_headers", + "combine_all_files_headers" + ], + "x-ms-enum": { + "name": "Header", + "modelAsString": true + } + }, + "includePath": { + "description": "Boolean to keep path information as column in the dataset. Defaults to False. This is useful when reading multiple files, and want to know which file a particular record originated from, or to keep useful information in file path.", + "default": false, + "type": "boolean" + }, + "partitionFormat": { + "description": "The partition information of each path will be extracted into columns based on the specified format. Format part '{column_name}' creates string column, and '{column_name:yyyy/MM/dd/HH/mm/ss}' creates datetime column, where 'yyyy', 'MM', 'dd', 'HH', 'mm' and 'ss' are used to extract year, month, day, hour, minute and second for the datetime type. The format should start from the position of first partition key until the end of file path. For example, given the path '../USA/2019/01/01/data.parquet' where the partition is by country/region and time, partition_format='/{CountryOrRegion}/{PartitionDate:yyyy/MM/dd}/data.csv' creates a string column 'CountryOrRegion' with the value 'USA' and a datetime column 'PartitionDate' with the value '2019-01-01", + "type": "string" + }, + "path": { + "type": "object", + "properties": { + "httpUrl": { + "description": "The Http URL.", + "type": "string" + }, + "dataPath": { + "type": "object", + "properties": { + "datastoreName": { + "description": "The datastore name.", + "type": "string" + }, + "relativePath": { + "description": "Path within the datastore.", + "type": "string" + } + } + } + } + }, + "query": { + "type": "object", + "properties": { + "datastoreName": { + "description": "The SQL/PostgreSQL/MySQL datastore name.", + "type": "string" + }, + "query": { + "description": "SQL Quey.", + "type": "string" + } + } + }, + "sourceType": { + "description": "Data source type.", + "type": "string", + "enum": [ + "delimited_files", + "json_lines_files", + "parquet_files" + ], + "x-ms-enum": { + "name": "SourceType", + "modelAsString": true + } + }, + "separator": { + "description": "The separator used to split columns for 'delimited_files' sourceType.", + "type": "string" + } + } + }, + "registration": { + "type": "object", + "properties": { + "description": { + "description": "The description for the dataset.", + "type": "string" + }, + "name": { + "description": "The name of the dataset.", + "type": "string" + }, + "tags": { + "description": "Tags associated with the dataset.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "timeSeries": { + "type": "object", + "properties": { + "fineGrainTimestamp": { + "description": " Column name to be used as FineGrainTimestamp", + "type": "string" + }, + "coarseGrainTimestamp": { + "description": "Column name to be used as CoarseGrainTimestamp. Can only be used if 'fineGrainTimestamp' is specified and cannot be same as 'fineGrainTimestamp'.", + "type": "string" + } + } + } + }, + "required": [ + "datasetType", + "parameters", + "registration" + ] + }, + "DatastoreCreateRequest": { + "description": "The request for creating datastore.", + "type": "object", + "properties": { + "name": { + "description": "The name of the datastore.", + "type": "string" + }, + "description": { + "description": "The description of the datastore.", + "type": "string" + }, + "skipValidation": { + "description": "Skip validation that ensures data can be loaded from the dataset before registration.", + "type": "boolean" + }, + "includeSecret": { + "description": "Include datastore secret in response.", + "default": true, + "type": "boolean" + }, + "dataStoreType": { + "description": "Specifies datastore type.", + "type": "string", + "enum": [ + "blob", + "adls", + "adls-gen2", + "dbfs", + "file", + "mysqldb", + "sqldb", + "psqldb" + ], + "x-ms-enum": { + "name": "DatastoreTypeArm", + "modelAsString": true + } + }, + "accountName": { + "description": "The name of the storage account.", + "type": "string" + }, + "shareName": { + "description": "The name of the file share.", + "type": "string" + }, + "containerName": { + "description": "The name of the azure blob container.", + "type": "string" + }, + "accountKey": { + "description": "Account Key of storage account.", + "type": "string" + }, + "endpoint": { + "description": "The endpoint of the server.", + "type": "string" + }, + "protocol": { + "description": "The protocol to be used", + "type": "string" + }, + "sasToken": { + "description": "Sas Token of storage account.", + "type": "string" + }, + "clientId": { + "description": "The service principal's client/application ID.", + "type": "string" + }, + "clientSecret": { + "description": "The service principal's secret.", + "type": "string" + }, + "storeName": { + "description": "The ADLS store name.", + "type": "string" + }, + "tenantId": { + "description": "The service principal Tenant ID.", + "type": "string" + }, + "authorityUrl": { + "description": "Authority url used to authenticate the user.", + "type": "string" + }, + "resourceUrl": { + "description": "Determines what operations will be performed.", + "type": "string" + }, + "storageAccountSubscriptionId": { + "description": "The subscription ID of the storage account. Defaults to selected subscription", + "type": "string" + }, + "storageAccountResourceGroup": { + "description": "The resource group of the storage account. Defaults to selected resource group", + "type": "string" + }, + "adlsSubscriptionId": { + "description": "The ID of the subscription the ADLS store belongs to. Defaults to selected subscription.", + "type": "string" + }, + "adlsResourceGroup": { + "description": "The resource group the ADLS store belongs to. Defaults to selected resource group.", + "type": "string" + }, + "fileSystem": { + "description": "The file system name of the ADLS Gen2.", + "type": "string" + }, + "databaseName": { + "description": "The database name.", + "type": "string" + }, + "password": { + "description": "The password.", + "type": "string" + }, + "serverName": { + "description": "The SQL/MySQL/PostgreSQL server name", + "type": "string" + }, + "userId": { + "description": "The user ID.", + "type": "string" + }, + "port": { + "description": "The port number.", + "type": "string" + }, + "enforceSSL": { + "description": "This sets the ssl value of the server. Defaults to true if not set.", + "default": true, + "type": "boolean" + }, + "userName": { + "description": "The username of the database user.", + "type": "string" + }, + "workspaceSystemAssignedIdentity": { + "description": "If set to true, datastore support data access authenticated with Workspace MSI.", + "type": "boolean" + } + }, + "required": [ + "dataStoreType" + ] } } } From 693f05974e91d4e91aec0fcab2027155f5b0944f Mon Sep 17 00:00:00 2001 From: Zach Rathbun Date: Fri, 18 Sep 2020 20:39:34 -0700 Subject: [PATCH 086/164] [Hub Generated] Review request for Microsoft.Consumption to add version stable/2019-10-01 (#10669) * Add reservationid and reservationorderid parameters * Fix parameter name * Fix wording * White space fix to trigger new checks --- .../stable/2019-10-01/consumption.json | 40 ++++++++++++++++++- ...etailsByBillingProfileIdReservationId.json | 36 +++++++++++++++++ ...thlyWithBillingProfileIdReservationId.json | 34 ++++++++++++++++ 3 files changed, 109 insertions(+), 1 deletion(-) create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationDetailsByBillingProfileIdReservationId.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileIdReservationId.json diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json index 071d5f14e011..ee96fd1212d6 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json @@ -792,6 +792,9 @@ }, "ReservationSummariesMonthlyWithBillingProfileId": { "$ref": "./examples/ReservationSummariesMonthlyWithBillingProfileId.json" + }, + "ReservationSummariesMonthlyWithBillingProfileIdReservationId": { + "$ref": "./examples/ReservationSummariesMonthlyWithBillingProfileIdReservationId.json" } }, "parameters": [ @@ -824,6 +827,22 @@ "required": false, "type": "string" }, + { + "name": "reservationId", + "in": "query", + "description": "Reservation Id GUID. Only valid if reservationOrderId is also provided. Filter to a specific reservation", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "reservationOrderId", + "in": "query", + "description": "Reservation Order Id GUID. Required if reservationId is provided. Filter to a specific reservation order", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, { "$ref": "#/parameters/apiVersionParameter" } @@ -868,7 +887,7 @@ }, { "name": "$filter", - "description": "Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' ", + "description": "Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'", "in": "query", "required": true, "type": "string" @@ -964,6 +983,9 @@ }, "ReservationDetailsByBillingProfileId": { "$ref": "./examples/ReservationDetailsByBillingProfileId.json" + }, + "ReservationDetailsByBillingProfileIdReservationId": { + "$ref": "./examples/ReservationDetailsByBillingProfileIdReservationId.json" } }, "parameters": [ @@ -993,6 +1015,22 @@ "required": false, "type": "string" }, + { + "name": "reservationId", + "in": "query", + "description": "Reservation Id GUID. Only valid if reservationOrderId is also provided. Filter to a specific reservation", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "reservationOrderId", + "in": "query", + "description": "Reservation Order Id GUID. Required if reservationId is provided. Filter to a specific reservation order", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, { "$ref": "#/parameters/apiVersionParameter" } diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationDetailsByBillingProfileIdReservationId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationDetailsByBillingProfileIdReservationId.json new file mode 100644 index 000000000000..b6c7a8324acf --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationDetailsByBillingProfileIdReservationId.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579", + "startDate": "2019-09-01", + "endDate": "2019-10-31", + "reservationId": "1c6b6358-709f-484c-85f1-72e862a0cf3b", + "reservationOrderId": "9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationDetails/reservationDetails_Id1", + "name": "reservationDetails_Id1", + "type": "Microsoft.Consumption/reservationDetails", + "tags": null, + "properties": { + "reservationOrderId": "9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc", + "reservationId": "1c6b6358-709f-484c-85f1-72e862a0cf3b", + "usageDate": "2019-09-30T00:00:00-08:00", + "skuName": "Standard_D2s_v3", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sqlh1/providers/microsoft.compute/virtualmachines/sqlh1", + "totalReservedQuantity": 0, + "reservedHours": 48, + "usedHours": 0.6, + "instanceFlexibilityGroup": "DSv3 Series", + "instanceFlexibilityRatio": "1" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileIdReservationId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileIdReservationId.json new file mode 100644 index 000000000000..4d7621b008d8 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationSummariesMonthlyWithBillingProfileIdReservationId.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579", + "grain": "monthly", + "reservationId": "1c6b6358-709f-484c-85f1-72e862a0cf3b", + "reservationOrderId": "9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/12345:2468/billingProfiles/13579/providers/Microsoft.Consumption/reservationSummaries/reservationSummaries_Id1", + "name": "reservationSummaries_Id1", + "type": "Microsoft.Consumption/reservationSummaries", + "tags": null, + "properties": { + "reservationOrderId": "9f39ba10-794f-4dcb-8f4b-8d0cb47c27dc", + "reservationId": "1c6b6358-709f-484c-85f1-72e862a0cf3b", + "skuName": "Standard_B1s", + "reservedHours": 720, + "usageDate": "2018-09-01T00:00:00-07:00", + "usedHours": 0, + "minUtilizationPercentage": 0, + "avgUtilizationPercentage": 0, + "maxUtilizationPercentage": 0 + } + } + ] + } + } + } +} From 3e20eea84f0618cfa0b9b455a30b94484ccd6eed Mon Sep 17 00:00:00 2001 From: dochung4 <40577926+dochung4@users.noreply.github.com> Date: Fri, 18 Sep 2020 22:51:34 -0700 Subject: [PATCH 087/164] Removed maximum for DedicatedHostGroup (#10813) --- .../Microsoft.Compute/stable/2020-06-01/compute.json | 2 -- 1 file changed, 2 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json index 817f4c62ac26..7bd220c78877 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json @@ -6739,7 +6739,6 @@ "type": "integer", "format": "int32", "minimum": 1, - "maximum": 3, "description": "Number of fault domains that the host group can span." }, "hosts": { @@ -6907,7 +6906,6 @@ "type": "integer", "format": "int32", "minimum": 0, - "maximum": 2, "description": "Fault domain of the dedicated host within a dedicated host group." }, "autoReplaceOnFailure": { From 50b45006cd046fa89d3e46884332b22867de92d4 Mon Sep 17 00:00:00 2001 From: Liran Chen <1437075+liranc@users.noreply.github.com> Date: Mon, 21 Sep 2020 05:45:36 +0300 Subject: [PATCH 088/164] aligned deivceSecurityGroups to stable (#10774) * aligned deivceSecurityGroups to stable * Fix tests * Fixed api version Co-authored-by: Liran Chen --- .../deviceSecurityGroups.json | 355 +++++++------ .../PutDeviceSecurityGroups_example.json | 5 - .../PutDeviceSecurityGroups_example.json | 473 +++++++----------- 3 files changed, 386 insertions(+), 447 deletions(-) diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/deviceSecurityGroups.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/deviceSecurityGroups.json index fd08950135a9..655474e9e7e8 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/deviceSecurityGroups.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/deviceSecurityGroups.json @@ -37,14 +37,14 @@ "/{resourceId}/providers/Microsoft.Security/deviceSecurityGroups": { "get": { "x-ms-examples": { - "List all device security groups for the specified IoT hub resource": { + "List all device security groups for the specified IoT Hub resource": { "$ref": "./examples/DeviceSecurityGroups/ListDeviceSecurityGroups_example.json" } }, "tags": [ "DeviceSecurityGroups" ], - "description": "Gets the list of device security groups for the specified IoT hub resource.", + "description": "Use this method get the list of device security groups for the specified IoT Hub resource.", "operationId": "DeviceSecurityGroups_List", "parameters": [ { @@ -76,14 +76,14 @@ "/{resourceId}/providers/Microsoft.Security/deviceSecurityGroups/{deviceSecurityGroupName}": { "get": { "x-ms-examples": { - "Get an device security group for the specified IoT hub resource": { + "Get a device security group for the specified IoT Hub resource": { "$ref": "./examples/DeviceSecurityGroups/GetDeviceSecurityGroups_example.json" } }, "tags": [ "DeviceSecurityGroups" ], - "description": "Gets the device security group for the specified IoT hub resource.", + "description": "Use this method to get the device security group for the specified IoT Hub resource.", "operationId": "DeviceSecurityGroups_Get", "parameters": [ { @@ -98,7 +98,7 @@ ], "responses": { "200": { - "description": "Successful request to get security group.", + "description": "Successful request to get device security group.", "schema": { "$ref": "#/definitions/DeviceSecurityGroup" } @@ -120,7 +120,7 @@ "tags": [ "DeviceSecurityGroups" ], - "description": "Creates or updates the device security group on a specified IoT hub resource.", + "description": "Use this method to creates or updates the device security group on a specified IoT Hub resource.", "operationId": "DeviceSecurityGroups_CreateOrUpdate", "parameters": [ { @@ -138,13 +138,13 @@ ], "responses": { "200": { - "description": "Security group was updated", + "description": "Security group was updated.", "schema": { "$ref": "#/definitions/DeviceSecurityGroup" } }, "201": { - "description": "Security group was created", + "description": "Security group was created.", "schema": { "$ref": "#/definitions/DeviceSecurityGroup" } @@ -159,14 +159,14 @@ }, "delete": { "x-ms-examples": { - "Delete a device security group for the specified IoT hub resource": { + "Delete a device security group for the specified IoT Hub resource": { "$ref": "./examples/DeviceSecurityGroups/DeleteDeviceSecurityGroups_example.json" } }, "tags": [ "DeviceSecurityGroups" ], - "description": "Deletes the security group", + "description": "User this method to deletes the device security group.", "operationId": "DeviceSecurityGroups_Delete", "parameters": [ { @@ -238,7 +238,7 @@ "properties": { "thresholdRules": { "type": "array", - "description": "A list of threshold custom alert rules.", + "description": "The list of custom alert threshold rules.", "items": { "type": "object", "$ref": "#/definitions/ThresholdCustomAlertRule" @@ -246,7 +246,7 @@ }, "timeWindowRules": { "type": "array", - "description": "A list of time window custom alert rules.", + "description": "The list of custom alert time-window rules.", "items": { "type": "object", "$ref": "#/definitions/TimeWindowCustomAlertRule" @@ -254,7 +254,7 @@ }, "allowlistRules": { "type": "array", - "description": "A list of allow-list custom alert rules.", + "description": "The allow-list custom alert rules.", "items": { "type": "object", "$ref": "#/definitions/AllowlistCustomAlertRule" @@ -262,7 +262,7 @@ }, "denylistRules": { "type": "array", - "description": "A list of deny-list custom alert rules.", + "description": "The deny-list custom alert rules.", "items": { "type": "object", "$ref": "#/definitions/DenylistCustomAlertRule" @@ -272,7 +272,8 @@ }, "CustomAlertRule": { "type": "object", - "description": "A custom alert rule", + "description": "A custom alert rule.", + "discriminator": "ruleType", "properties": { "displayName": { "type": "string", @@ -286,7 +287,7 @@ }, "isEnabled": { "type": "boolean", - "description": "Whether the custom alert is enabled." + "description": "Status of the custom alert." }, "ruleType": { "type": "string", @@ -300,7 +301,7 @@ }, "ListCustomAlertRule": { "type": "object", - "description": "A List custom alert rule", + "description": "A List custom alert rule.", "allOf": [ { "$ref": "#/definitions/CustomAlertRule" @@ -309,7 +310,7 @@ "properties": { "valueType": { "type": "string", - "description": "The value type of the items in the list", + "description": "The value type of the items in the list.", "enum": [ "IpCidr", "String" @@ -334,7 +335,7 @@ }, "AllowlistCustomAlertRule": { "type": "object", - "description": "A custom alert rule that checks if a value (depends on the custom alert type) is allowed", + "description": "A custom alert rule that checks if a value (depends on the custom alert type) is allowed.", "allOf": [ { "$ref": "#/definitions/ListCustomAlertRule" @@ -347,42 +348,45 @@ "items": { "type": "string" } - }, - "ruleType": { - "type": "string", - "description": "The type of the custom alert rule.", - "enum": [ - "ConnectionToIpNotAllowed", - "LocalUserNotAllowed", - "ProcessNotAllowed" - ], - "x-ms-enum": { - "name": "ruleType", - "modelAsString": true, - "values": [ - { - "value": "ConnectionToIpNotAllowed", - "description": "Outbound connection to an ip that isn't allowed. Allow list consists of ipv4 or ipv6 range in CIDR notation." - }, - { - "value": "LocalUserNotAllowed", - "description": "Login by a local user that isn't allowed. Allow list consists of login names to allow." - }, - { - "value": "ProcessNotAllowed", - "description": "Execution of a process that isn't allowed. Allow list consists of process names to allow." - } - ] - } } }, "required": [ "allowlistValues" ] }, + "ConnectionToIpNotAllowed": { + "type": "object", + "description": "Outbound connection to an ip that isn't allowed. Allow list consists of ipv4 or ipv6 range in CIDR notation.", + "allOf": [ + { + "$ref": "#/definitions/AllowlistCustomAlertRule" + } + ], + "properties": {} + }, + "LocalUserNotAllowed": { + "type": "object", + "description": "Login by a local user that isn't allowed. Allow list consists of login names to allow.", + "allOf": [ + { + "$ref": "#/definitions/AllowlistCustomAlertRule" + } + ], + "properties": {} + }, + "ProcessNotAllowed": { + "type": "object", + "description": "Execution of a process that isn't allowed. Allow list consists of process names to allow.", + "allOf": [ + { + "$ref": "#/definitions/AllowlistCustomAlertRule" + } + ], + "properties": {} + }, "DenylistCustomAlertRule": { "type": "object", - "description": "A custom alert rule that checks if a value (depends on the custom alert type) is denied", + "description": "A custom alert rule that checks if a value (depends on the custom alert type) is denied.", "allOf": [ { "$ref": "#/definitions/ListCustomAlertRule" @@ -428,9 +432,6 @@ "type": "object", "description": "A custom alert rule that checks if the number of activities (depends on the custom alert type) in a time window is within the given range.", "allOf": [ - { - "$ref": "#/definitions/CustomAlertRule" - }, { "$ref": "#/definitions/ThresholdCustomAlertRule" } @@ -440,103 +441,171 @@ "type": "string", "description": "The time window size in iso8601 format.", "format": "duration" - }, - "ruleType": { - "type": "string", - "description": "The type of the custom alert rule.", - "enum": [ - "ActiveConnectionsNotInAllowedRange", - "AmqpC2DMessagesNotInAllowedRange", - "MqttC2DMessagesNotInAllowedRange", - "HttpC2DMessagesNotInAllowedRange", - "AmqpC2DRejectedMessagesNotInAllowedRange", - "MqttC2DRejectedMessagesNotInAllowedRange", - "HttpC2DRejectedMessagesNotInAllowedRange", - "AmqpD2CMessagesNotInAllowedRange", - "MqttD2CMessagesNotInAllowedRange", - "HttpD2CMessagesNotInAllowedRange", - "DirectMethodInvokesNotInAllowedRange", - "FailedLocalLoginsNotInAllowedRange", - "FileUploadsNotInAllowedRange", - "QueuePurgesNotInAllowedRange", - "TwinUpdatesNotInAllowedRange", - "UnauthorizedOperationsNotInAllowedRange" - ], - "x-ms-enum": { - "name": "ruleType", - "modelAsString": true, - "values": [ - { - "value": "ActiveConnectionsNotInAllowedRange", - "description": "Number of active connections is not in allowed range." - }, - { - "value": "AmqpC2DMessagesNotInAllowedRange", - "description": "Number of cloud to device messages (AMQP protocol) is not in allowed range." - }, - { - "value": "MqttC2DMessagesNotInAllowedRange", - "description": "Number of cloud to device messages (MQTT protocol) is not in allowed range." - }, - { - "value": "HttpC2DMessagesNotInAllowedRange", - "description": "Number of cloud to device messages (HTTP protocol) is not in allowed range." - }, - { - "value": "AmqpC2DRejectedMessagesNotInAllowedRange", - "description": "Number of rejected cloud to device messages (AMQP protocol) is not in allowed range." - }, - { - "value": "MqttC2DRejectedMessagesNotInAllowedRange", - "description": "Number of rejected cloud to device messages (MQTT protocol) is not in allowed range." - }, - { - "value": "HttpC2DRejectedMessagesNotInAllowedRange", - "description": "Number of rejected cloud to device messages (HTTP protocol) is not in allowed range." - }, - { - "value": "AmqpD2CMessagesNotInAllowedRange", - "description": "Number of device to cloud messages (AMQP protocol) is not in allowed range." - }, - { - "value": "MqttD2CMessagesNotInAllowedRange", - "description": "Number of device to cloud messages (MQTT protocol) is not in allowed range." - }, - { - "value": "HttpD2CMessagesNotInAllowedRange", - "description": "Number of device to cloud messages (HTTP protocol) is not in allowed range." - }, - { - "value": "DirectMethodInvokesNotInAllowedRange", - "description": "Number of direct method invokes is not in allowed range." - }, - { - "value": "FailedLocalLoginsNotInAllowedRange", - "description": "Number of failed local logins is not in allowed range." - }, - { - "value": "FileUploadsNotInAllowedRange", - "description": "Number of file uploads is not in allowed range." - }, - { - "value": "QueuePurgesNotInAllowedRange", - "description": "Number of device queue purges is not in allowed range." - }, - { - "value": "TwinUpdatesNotInAllowedRange", - "description": "Number of twin updates is not in allowed range." - }, - { - "value": "UnauthorizedOperationsNotInAllowedRange", - "description": "Number of unauthorized operations is not in allowed range." - } - ] - } } }, "required": [ "timeWindowSize" ] + }, + "ActiveConnectionsNotInAllowedRange": { + "type": "object", + "description": "Number of active connections is not in allowed range.", + "allOf": [ + { + "$ref": "#/definitions/TimeWindowCustomAlertRule" + } + ], + "properties": {} + }, + "AmqpC2DMessagesNotInAllowedRange": { + "type": "object", + "description": "Number of cloud to device messages (AMQP protocol) is not in allowed range.", + "allOf": [ + { + "$ref": "#/definitions/TimeWindowCustomAlertRule" + } + ], + "properties": {} + }, + "MqttC2DMessagesNotInAllowedRange": { + "type": "object", + "description": "Number of cloud to device messages (MQTT protocol) is not in allowed range.", + "allOf": [ + { + "$ref": "#/definitions/TimeWindowCustomAlertRule" + } + ], + "properties": {} + }, + "HttpC2DMessagesNotInAllowedRange": { + "type": "object", + "description": "Number of cloud to device messages (HTTP protocol) is not in allowed range.", + "allOf": [ + { + "$ref": "#/definitions/TimeWindowCustomAlertRule" + } + ], + "properties": {} + }, + "AmqpC2DRejectedMessagesNotInAllowedRange": { + "type": "object", + "description": "Number of rejected cloud to device messages (AMQP protocol) is not in allowed range.", + "allOf": [ + { + "$ref": "#/definitions/TimeWindowCustomAlertRule" + } + ], + "properties": {} + }, + "MqttC2DRejectedMessagesNotInAllowedRange": { + "type": "object", + "description": "Number of rejected cloud to device messages (MQTT protocol) is not in allowed range.", + "allOf": [ + { + "$ref": "#/definitions/TimeWindowCustomAlertRule" + } + ], + "properties": {} + }, + "HttpC2DRejectedMessagesNotInAllowedRange": { + "type": "object", + "description": "Number of rejected cloud to device messages (HTTP protocol) is not in allowed range.", + "allOf": [ + { + "$ref": "#/definitions/TimeWindowCustomAlertRule" + } + ], + "properties": {} + }, + "AmqpD2CMessagesNotInAllowedRange": { + "type": "object", + "description": "Number of device to cloud messages (AMQP protocol) is not in allowed range.", + "allOf": [ + { + "$ref": "#/definitions/TimeWindowCustomAlertRule" + } + ], + "properties": {} + }, + "MqttD2CMessagesNotInAllowedRange": { + "type": "object", + "description": "Number of device to cloud messages (MQTT protocol) is not in allowed range.", + "allOf": [ + { + "$ref": "#/definitions/TimeWindowCustomAlertRule" + } + ], + "properties": {} + }, + "HttpD2CMessagesNotInAllowedRange": { + "type": "object", + "description": "Number of device to cloud messages (HTTP protocol) is not in allowed range.", + "allOf": [ + { + "$ref": "#/definitions/TimeWindowCustomAlertRule" + } + ], + "properties": {} + }, + "DirectMethodInvokesNotInAllowedRange": { + "type": "object", + "description": "Number of direct method invokes is not in allowed range.", + "allOf": [ + { + "$ref": "#/definitions/TimeWindowCustomAlertRule" + } + ], + "properties": {} + }, + "FailedLocalLoginsNotInAllowedRange": { + "type": "object", + "description": "Number of failed local logins is not in allowed range.", + "allOf": [ + { + "$ref": "#/definitions/TimeWindowCustomAlertRule" + } + ], + "properties": {} + }, + "FileUploadsNotInAllowedRange": { + "type": "object", + "description": "Number of file uploads is not in allowed range.", + "allOf": [ + { + "$ref": "#/definitions/TimeWindowCustomAlertRule" + } + ], + "properties": {} + }, + "QueuePurgesNotInAllowedRange": { + "type": "object", + "description": "Number of device queue purges is not in allowed range.", + "allOf": [ + { + "$ref": "#/definitions/TimeWindowCustomAlertRule" + } + ], + "properties": {} + }, + "TwinUpdatesNotInAllowedRange": { + "type": "object", + "description": "Number of twin updates is not in allowed range.", + "allOf": [ + { + "$ref": "#/definitions/TimeWindowCustomAlertRule" + } + ], + "properties": {} + }, + "UnauthorizedOperationsNotInAllowedRange": { + "type": "object", + "description": "Number of unauthorized operations is not in allowed range.", + "allOf": [ + { + "$ref": "#/definitions/TimeWindowCustomAlertRule" + } + ], + "properties": {} } }, "parameters": { @@ -545,7 +614,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the security group. Please notice that the name is case insensitive.", + "description": "The name of the device security group. Note that the name of the device security group is case insensitive.", "x-ms-parameter-location": "method" }, "DeviceSecurityGroup": { diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/DeviceSecurityGroups/PutDeviceSecurityGroups_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/DeviceSecurityGroups/PutDeviceSecurityGroups_example.json index 9492bc79ea23..8d2070be53f6 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/DeviceSecurityGroups/PutDeviceSecurityGroups_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/DeviceSecurityGroups/PutDeviceSecurityGroups_example.json @@ -4,15 +4,10 @@ "resourceId": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub", "deviceSecurityGroupName": "samplesecuritygroup", "deviceSecurityGroup": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub/providers/Microsoft.Security/deviceSecurityGroups/samplesecuritygroup", - "name": "samplesecuritygroup", - "type": "Microsoft.Security/deviceSecurityGroups", "properties": { "timeWindowRules": [ { "ruleType": "ActiveConnectionsNotInAllowedRange", - "displayName": "Number of active connections is not in allowed range", - "description": "Get an alert when the number of active connections of a device in the time window is not in the allowed range", "isEnabled": true, "minThreshold": 0, "maxThreshold": 30, diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/DeviceSecurityGroups/PutDeviceSecurityGroups_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/DeviceSecurityGroups/PutDeviceSecurityGroups_example.json index fee633534ef2..357a11a33ef3 100644 --- a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/DeviceSecurityGroups/PutDeviceSecurityGroups_example.json +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/DeviceSecurityGroups/PutDeviceSecurityGroups_example.json @@ -1,22 +1,35 @@ { "parameters": { - "api-version": "2019-08-01", - "resourceId": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub", - "deviceSecurityGroupName": "samplesecuritygroup", - "deviceSecurityGroup": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub/providers/Microsoft.Security/deviceSecurityGroups/samplesecuritygroup", - "name": "samplesecuritygroup", - "type": "Microsoft.Security/deviceSecurityGroups", + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "MyGroup", + "solutionName": "default", + "iotSecuritySolutionData": { + "tags": {}, + "location": "East Us", "properties": { - "timeWindowRules": [ + "workspace": "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1", + "status": "Enabled", + "export": [], + "disabledDataSources": [], + "displayName": "Solution Default", + "iotHubs": [ + "/subscriptions/075423e9-7d33-4166-8bdf-3920b04e3735/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/FirstIotHub" + ], + "userDefinedResources": { + "query": "where type != \"microsoft.devices/iothubs\" | where name contains \"iot\"", + "querySubscriptions": [ + "075423e9-7d33-4166-8bdf-3920b04e3735" + ] + }, + "recommendationsConfiguration": [ { - "ruleType": "ActiveConnectionsNotInAllowedRange", - "displayName": "Number of active connections is not in allowed range", - "description": "Get an alert when the number of active connections of a device in the time window is not in the allowed range", - "isEnabled": true, - "minThreshold": 0, - "maxThreshold": 30, - "timeWindowSize": "PT05M" + "recommendationType": "IoT_OpenPorts", + "status": "Disabled" + }, + { + "recommendationType": "IoT_SharedCredentials", + "status": "Disabled" } ] } @@ -25,361 +38,223 @@ "responses": { "200": { "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub/providers/Microsoft.Security/deviceSecurityGroups/samplesecuritygroup", - "name": "samplesecuritygroup", - "type": "Microsoft.Security/deviceSecurityGroups", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Security/Locations/eastus/IoTSecuritySolutions/default", + "name": "default", + "type": "Microsoft.Security/IoTSecuritySolutions", + "location": "East Us", + "tags": {}, "properties": { - "thresholdRules": [], - "timeWindowRules": [ - { - "ruleType": "ActiveConnectionsNotInAllowedRange", - "displayName": "Number of active connections is not in allowed range", - "description": "Get an alert when the number of active connections of a device in the time window is not in the allowed range", - "isEnabled": true, - "minThreshold": 0, - "maxThreshold": 30, - "timeWindowSize": "PT05M" - }, - { - "ruleType": "AmqpC2DMessagesNotInAllowedRange", - "displayName": "Number of cloud to device messages (AMQP protocol) is not in allowed range", - "description": "Get an alert when the number of cloud to device messages (AMQP protocol) in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" - }, + "workspace": "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1", + "status": "Enabled", + "export": [], + "disabledDataSources": [], + "displayName": "Solution Default", + "iotHubs": [ + "/subscriptions/075423e9-7d33-4166-8bdf-3920b04e3735/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/FirstIotHub" + ], + "userDefinedResources": { + "query": "where type != \"microsoft.devices/iothubs\" | where name contains \"iot\"", + "querySubscriptions": [ + "075423e9-7d33-4166-8bdf-3920b04e3735" + ] + }, + "autoDiscoveredResources": [ + "/subscriptions/075423e9-7d33-4166-8bdf-3920b04e3735", + "/subscriptions/075423e9-7d33-4166-8bdf-3920b04e3735/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/FirstIotHub" + ], + "recommendationsConfiguration": [ { - "ruleType": "MqttC2DMessagesNotInAllowedRange", - "displayName": "Number of cloud to device messages (MQTT protocol) is not in allowed range", - "description": "Get an alert when the number of cloud to device messages (MQTT protocol) in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_ACRAuthentication", + "name": "Service Principal Not Used with ACR", + "status": "Enabled" }, { - "ruleType": "HttpC2DMessagesNotInAllowedRange", - "displayName": "Number of cloud to device messages (HTTP protocol) is not in allowed range", - "description": "Get an alert when the number of cloud to device messages (HTTP protocol) in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_AgentSendsUnutilizedMessages", + "name": "Agent sending underutilized messages", + "status": "TurnedOn" }, { - "ruleType": "AmqpC2DRejectedMessagesNotInAllowedRange", - "displayName": "Number of rejected cloud to device messages (AMQP protocol) is not in allowed range", - "description": "Get an alert when the number of cloud to device messages (AMQP protocol) that were rejected by the device in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_Baseline", + "name": "Operating system (OS) baseline validation failure", + "status": "Enabled" }, { - "ruleType": "MqttC2DRejectedMessagesNotInAllowedRange", - "displayName": "Number of rejected cloud to device messages (MQTT protocol) is not in allowed range", - "description": "Get an alert when the number of cloud to device messages (MQTT protocol) that were rejected by the device in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_EdgeHubMemOptimize", + "name": "Edge Hub memory can be optimized", + "status": "Enabled" }, { - "ruleType": "HttpC2DRejectedMessagesNotInAllowedRange", - "displayName": "Number of rejected cloud to device messages (HTTP protocol) is not in allowed range", - "description": "Get an alert when the number of cloud to device messages (HTTP protocol) that were rejected by the device in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_EdgeLoggingOptions", + "name": "No Logging Configured for Edge Module", + "status": "Enabled" }, { - "ruleType": "AmqpD2CMessagesNotInAllowedRange", - "displayName": "Number of device to cloud messages (AMQP protocol) is not in allowed range", - "description": "Get an alert when the number of device to cloud messages (AMQP protocol) in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_InconsistentModuleSettings", + "name": "Module Settings Inconsistent in SecurityGroup", + "status": "Enabled" }, { - "ruleType": "MqttD2CMessagesNotInAllowedRange", - "displayName": "Number of device to cloud messages (MQTT protocol) is not in allowed range", - "description": "Get an alert when the number of device to cloud messages (MQTT protocol) in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_InstallAgent", + "name": "Install the Azure Security of Things Agent", + "status": "Enabled" }, { - "ruleType": "HttpD2CMessagesNotInAllowedRange", - "displayName": "Number of device to cloud messages (HTTP protocol) is not in allowed range", - "description": "Get an alert when the number of device to cloud messages (HTTP protocol) in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_IPFilter_DenyAll", + "name": "Default IP Filter Policy should be Deny", + "status": "Enabled" }, { - "ruleType": "DirectMethodInvokesNotInAllowedRange", - "displayName": "Number of direct method invokes is not in allowed range", - "description": "Get an alert when the number of direct method invokes in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_IPFilter_PermissiveRule", + "name": "IP Filter rule includes large IP range", + "status": "Enabled" }, { - "ruleType": "FailedLocalLoginsNotInAllowedRange", - "displayName": "Number of failed local logins is not in allowed range", - "description": "Get an alert when the number of failed local logins on the device in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_OpenPorts", + "name": "Open Ports On Device", + "status": "Disabled" }, { - "ruleType": "FileUploadsNotInAllowedRange", - "displayName": "Number of file uploads is not in allowed range", - "description": "Get an alert when the number of file uploads from the device to the cloud in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_PermissiveFirewallPolicy", + "name": "Permissive firewall policy in one of the chains was found", + "status": "Enabled" }, { - "ruleType": "QueuePurgesNotInAllowedRange", - "displayName": "Number of device queue purges is not in allowed range", - "description": "Get an alert when the number of device queue purges in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_PermissiveInputFirewallRules", + "name": "Permissive firewall rule in the input chain was found", + "status": "Enabled" }, { - "ruleType": "TwinUpdatesNotInAllowedRange", - "displayName": "Number of twin updates is not in allowed range", - "description": "Get an alert when the number of twin updates (by the device or the service) in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_PermissiveOutputFirewallRules", + "name": "Permissive firewall rule in the output chain was found", + "status": "Enabled" }, { - "ruleType": "UnauthorizedOperationsNotInAllowedRange", - "displayName": "Number of unauthorized operations is not in allowed range", - "description": "Get an alert when the number unauthorized operations in the time window is not in the allowed range. Unauthorized operations are operations that affect the device (or done by it) that fail because of an unauthorized error", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" - } - ], - "allowlistRules": [ - { - "ruleType": "ConnectionToIpNotAllowed", - "displayName": "Outbound connection to an ip that isn't allowed", - "description": "Get an alert when an outbound connection is created between your device and an ip that isn't allowed", - "isEnabled": false, - "allowlistValues": [] + "recommendationType": "IoT_PrivilegedDockerOptions", + "name": "High level permissions configured in Edge model twin for Edge module", + "status": "Enabled" }, { - "ruleType": "LocalUserNotAllowed", - "displayName": "Login by a local user that isn't allowed", - "description": "Get an alert when a local user that isn't allowed logins to the device", - "isEnabled": false, - "allowlistValues": [] + "recommendationType": "IoT_SharedCredentials", + "name": "Same Authentication Credentials used by multiple devices", + "status": "Disabled" }, { - "ruleType": "ProcessNotAllowed", - "displayName": "Execution of a process that isn't allowed", - "description": "Get an alert when a process that isn't allowed is executed", - "isEnabled": false, - "allowlistValues": [] + "recommendationType": "IoT_VulnerableTLSCipherSuite", + "name": "TLS cipher suite upgrade", + "status": "Enabled" } - ], - "denylistRules": [] + ] } } }, "201": { "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub/providers/Microsoft.Security/deviceSecurityGroups/samplesecuritygroup", - "name": "samplesecuritygroup", - "type": "Microsoft.Security/deviceSecurityGroups", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Security/Locations/eastus/IoTSecuritySolutions/default", + "name": "default", + "type": "Microsoft.Security/IoTSecuritySolutions", + "location": "East Us", + "tags": {}, "properties": { - "thresholdRules": [], - "timeWindowRules": [ - { - "ruleType": "ActiveConnectionsNotInAllowedRange", - "displayName": "Number of active connections is not in allowed range", - "description": "Get an alert when the number of active connections of a device in the time window is not in the allowed range", - "isEnabled": true, - "minThreshold": 0, - "maxThreshold": 30, - "timeWindowSize": "PT05M" - }, + "workspace": "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1", + "status": "Enabled", + "export": [], + "disabledDataSources": [], + "displayName": "Solution Default", + "iotHubs": [ + "/subscriptions/075423e9-7d33-4166-8bdf-3920b04e3735/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/FirstIotHub" + ], + "userDefinedResources": { + "query": "where type != \"microsoft.devices/iothubs\" | where name contains \"iot\"", + "querySubscriptions": [ + "075423e9-7d33-4166-8bdf-3920b04e3735" + ] + }, + "autoDiscoveredResources": [ + "/subscriptions/075423e9-7d33-4166-8bdf-3920b04e3735", + "/subscriptions/075423e9-7d33-4166-8bdf-3920b04e3735/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/FirstIotHub" + ], + "recommendationsConfiguration": [ { - "ruleType": "AmqpC2DMessagesNotInAllowedRange", - "displayName": "Number of cloud to device messages (AMQP protocol) is not in allowed range", - "description": "Get an alert when the number of cloud to device messages (AMQP protocol) in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_ACRAuthentication", + "name": "Service Principal Not Used with ACR", + "status": "Enabled" }, { - "ruleType": "MqttC2DMessagesNotInAllowedRange", - "displayName": "Number of cloud to device messages (MQTT protocol) is not in allowed range", - "description": "Get an alert when the number of cloud to device messages (MQTT protocol) in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_AgentSendsUnutilizedMessages", + "name": "Agent sending underutilized messages", + "status": "TurnedOn" }, { - "ruleType": "HttpC2DMessagesNotInAllowedRange", - "displayName": "Number of cloud to device messages (HTTP protocol) is not in allowed range", - "description": "Get an alert when the number of cloud to device messages (HTTP protocol) in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_Baseline", + "name": "Operating system (OS) baseline validation failure", + "status": "Enabled" }, { - "ruleType": "AmqpC2DRejectedMessagesNotInAllowedRange", - "displayName": "Number of rejected cloud to device messages (AMQP protocol) is not in allowed range", - "description": "Get an alert when the number of cloud to device messages (AMQP protocol) that were rejected by the device in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_EdgeHubMemOptimize", + "name": "Edge Hub memory can be optimized", + "status": "Enabled" }, { - "ruleType": "MqttC2DRejectedMessagesNotInAllowedRange", - "displayName": "Number of rejected cloud to device messages (MQTT protocol) is not in allowed range", - "description": "Get an alert when the number of cloud to device messages (MQTT protocol) that were rejected by the device in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_EdgeLoggingOptions", + "name": "No Logging Configured for Edge Module", + "status": "Enabled" }, { - "ruleType": "HttpC2DRejectedMessagesNotInAllowedRange", - "displayName": "Number of rejected cloud to device messages (HTTP protocol) is not in allowed range", - "description": "Get an alert when the number of cloud to device messages (HTTP protocol) that were rejected by the device in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_InconsistentModuleSettings", + "name": "Module Settings Inconsistent in SecurityGroup", + "status": "Enabled" }, { - "ruleType": "AmqpD2CMessagesNotInAllowedRange", - "displayName": "Number of device to cloud messages (AMQP protocol) is not in allowed range", - "description": "Get an alert when the number of device to cloud messages (AMQP protocol) in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_InstallAgent", + "name": "Install the Azure Security of Things Agent", + "status": "Enabled" }, { - "ruleType": "MqttD2CMessagesNotInAllowedRange", - "displayName": "Number of device to cloud messages (MQTT protocol) is not in allowed range", - "description": "Get an alert when the number of device to cloud messages (MQTT protocol) in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_IPFilter_DenyAll", + "name": "Default IP Filter Policy should be Deny", + "status": "Enabled" }, { - "ruleType": "HttpD2CMessagesNotInAllowedRange", - "displayName": "Number of device to cloud messages (HTTP protocol) is not in allowed range", - "description": "Get an alert when the number of device to cloud messages (HTTP protocol) in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_IPFilter_PermissiveRule", + "name": "IP Filter rule includes large IP range", + "status": "Enabled" }, { - "ruleType": "DirectMethodInvokesNotInAllowedRange", - "displayName": "Number of direct method invokes is not in allowed range", - "description": "Get an alert when the number of direct method invokes in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_OpenPorts", + "name": "Open Ports On Device", + "status": "Disabled" }, { - "ruleType": "FailedLocalLoginsNotInAllowedRange", - "displayName": "Number of failed local logins is not in allowed range", - "description": "Get an alert when the number of failed local logins on the device in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_PermissiveFirewallPolicy", + "name": "Permissive firewall policy in one of the chains was found", + "status": "Enabled" }, { - "ruleType": "FileUploadsNotInAllowedRange", - "displayName": "Number of file uploads is not in allowed range", - "description": "Get an alert when the number of file uploads from the device to the cloud in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_PermissiveInputFirewallRules", + "name": "Permissive firewall rule in the input chain was found", + "status": "Enabled" }, { - "ruleType": "QueuePurgesNotInAllowedRange", - "displayName": "Number of device queue purges is not in allowed range", - "description": "Get an alert when the number of device queue purges in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_PermissiveOutputFirewallRules", + "name": "Permissive firewall rule in the output chain was found", + "status": "Enabled" }, { - "ruleType": "TwinUpdatesNotInAllowedRange", - "displayName": "Number of twin updates is not in allowed range", - "description": "Get an alert when the number of twin updates (by the device or the service) in the time window is not in the allowed range", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" + "recommendationType": "IoT_PrivilegedDockerOptions", + "name": "High level permissions configured in Edge model twin for Edge module", + "status": "Enabled" }, { - "ruleType": "UnauthorizedOperationsNotInAllowedRange", - "displayName": "Number of unauthorized operations is not in allowed range", - "description": "Get an alert when the number unauthorized operations in the time window is not in the allowed range. Unauthorized operations are operations that affect the device (or done by it) that fail because of an unauthorized error", - "isEnabled": false, - "minThreshold": 0, - "maxThreshold": 0, - "timeWindowSize": "PT15M" - } - ], - "allowlistRules": [ - { - "ruleType": "ConnectionToIpNotAllowed", - "displayName": "Outbound connection to an ip that isn't allowed", - "description": "Get an alert when an outbound connection is created between your device and an ip that isn't allowed", - "isEnabled": false, - "allowlistValues": [] - }, - { - "ruleType": "LocalUserNotAllowed", - "displayName": "Login by a local user that isn't allowed", - "description": "Get an alert when a local user that isn't allowed logins to the device", - "isEnabled": false, - "allowlistValues": [] + "recommendationType": "IoT_SharedCredentials", + "name": "Same Authentication Credentials used by multiple devices", + "status": "Disabled" }, { - "ruleType": "ProcessNotAllowed", - "displayName": "Execution of a process that isn't allowed", - "description": "Get an alert when a process that isn't allowed is executed", - "isEnabled": false, - "allowlistValues": [] + "recommendationType": "IoT_VulnerableTLSCipherSuite", + "name": "TLS cipher suite upgrade", + "status": "Enabled" } - ], - "denylistRules": [] + ] } } } From 4d4c60bf93268cccb0a8f95bbfba65659d4f6607 Mon Sep 17 00:00:00 2001 From: Roman Khotsyn Date: Sun, 20 Sep 2020 19:45:59 -0700 Subject: [PATCH 089/164] [SQL][V20200801] Adding new API version with named replica and maintenance (#10432) * [SQL][V20200801] Adding new API version with named replica and maintenance * Various fixed and enhancements * Removed extra examples * Removing last extra example * AsBefore * AsAfter + restart CI --- .../preview/2020-08-01-preview/databases.json | 1110 +++++++++++++++++ .../2020-08-01-preview/elasticPools.json | 632 ++++++++++ .../examples/CreateDatabaseCopyMode.json | 91 ++ .../examples/CreateDatabaseDefaultMode.json | 92 ++ .../examples/CreateDatabaseMin.json | 83 ++ .../examples/CreateDatabaseNamedReplica.json | 103 ++ .../examples/CreateDatabasePITRMode.json | 70 ++ .../examples/CreateDatabaseRecoveryMode.json | 69 + .../examples/CreateDatabaseRestoreMode.json | 70 ++ .../examples/CreateDatabaseRestoreMode2.json | 69 + .../examples/CreateDatabaseSecondaryMode.json | 94 ++ .../CreateDwDatabaseByServiceObjective.json | 80 ++ ...CreateVCoreDatabaseByServiceObjective.json | 92 ++ .../CreateVCoreDatabaseBySkuNameCapacity.json | 91 ++ .../examples/DeleteDatabase.json | 14 + .../ElasticPoolCreateOrUpdateMax.json | 72 ++ .../ElasticPoolCreateOrUpdateMin.json | 61 + .../examples/ElasticPoolDelete.json | 14 + .../examples/ElasticPoolGet.json | 36 + .../examples/ElasticPoolListByServer.json | 81 ++ .../examples/ElasticPoolUpdateMax.json | 52 + .../examples/ElasticPoolUpdateMin.json | 36 + .../examples/FailoverDatabase.json | 14 + .../examples/FailoverElasticPool.json | 13 + .../examples/GetVCoreDatabase.json | 47 + .../examples/ListDatabasesByElasticPool.json | 61 + .../examples/ListVCoreDatabasesByServer.json | 81 ++ .../examples/PatchVCoreDatabase.json | 57 + .../examples/PauseDatabase.json | 34 + .../examples/RenameDatabase.json | 15 + .../examples/ResumeDatabase.json | 34 + .../examples/UpgradeDataWarehouse.json | 13 + specification/sql/resource-manager/readme.md | 20 + 33 files changed, 3501 insertions(+) create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/databases.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/elasticPools.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseCopyMode.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseDefaultMode.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseMin.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseNamedReplica.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabasePITRMode.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseRecoveryMode.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseRestoreMode.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseRestoreMode2.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseSecondaryMode.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDwDatabaseByServiceObjective.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateVCoreDatabaseByServiceObjective.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateVCoreDatabaseBySkuNameCapacity.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/DeleteDatabase.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolCreateOrUpdateMax.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolCreateOrUpdateMin.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolDelete.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolGet.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolListByServer.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolUpdateMax.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolUpdateMin.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/FailoverDatabase.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/FailoverElasticPool.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/GetVCoreDatabase.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ListDatabasesByElasticPool.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ListVCoreDatabasesByServer.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/PatchVCoreDatabase.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/PauseDatabase.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/RenameDatabase.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ResumeDatabase.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/UpgradeDataWarehouse.json diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/databases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/databases.json new file mode 100644 index 000000000000..531c0d3f3d97 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/databases.json @@ -0,0 +1,1110 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-08-01-preview", + "title": "SqlManagementClient", + "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases": { + "get": { + "tags": [ + "Databases" + ], + "description": "Gets a list of databases.", + "operationId": "Databases_ListByServer", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of databases.", + "schema": { + "$ref": "#/definitions/DatabaseListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets a list of databases.": { + "$ref": "./examples/ListVCoreDatabasesByServer.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}": { + "get": { + "tags": [ + "Databases" + ], + "description": "Gets a database.", + "operationId": "Databases_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified database.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-examples": { + "Gets a database.": { + "$ref": "./examples/GetVCoreDatabase.json" + } + } + }, + "put": { + "tags": [ + "Databases" + ], + "description": "Creates a new database or updates an existing database.", + "operationId": "Databases_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested database resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/Database" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the database.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingMaxSizeBytes - MaxSizeBytes is required.\n\n * 400 MissingSkuName - Sku name is required.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 InvalidLicenseType - The specified license type is invalid.\n\n * 400 InvalidSkuName - Invalid SKU name.\n\n * 400 MismatchedSkuNameAndCapacity - Mismatch between SKU name and capacity.\n\n * 400 MismatchedSkuNameAndTier - Mismatch between SKU name and tier.\n\n * 400 MismatchedSkuNameAndFamily - Mismatch between SKU name and family.\n\n * 400 DatabaseNameDoesNotMatchSourceDatabaseId - The database name specified doesn’t match the database name in sourceDatabaseId.\n\n * 400 ElasticPoolNotSupportedForExternalBackupRestore - Elastic pool is not supported for external backup restore\n\n * 400 InvalidRecoverableDatabaseId - Invalid recoverable database identifier.\n\n * 400 InvalidRecoveryServicesRecoveryPointId - Invalid recovery services recovery point identifier.\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 MissingRecoverableDatabaseId - Missing recoverable database identifier.\n\n * 400 MissingRecoveryServicesRecoveryPointId - Missing recovery services recovery point Id.\n\n * 400 MissingRestorableDroppedDatabaseId - Missing restorableDroppedDatabaseId\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingSourceDatabaseDeletionDate - Missing source database deletion date\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 InvalidDatabaseCreateMode - Invalid request to create a database.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 TargetElasticPoolDoesNotExist - The elastic pool does not exist on a server.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolNameRequired - User tried to create or update database to elastic pool service objective without specifying the name of the elastic pool.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 InvalidReadScaleEdition - User attempted to enable read scale on a database type that does not support it.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 RequestedDatabaseSizeRequiresShrink - User attempted to ALTER DATABASE MODIFY MAXSIZE to modify the MAXSIZE for a database to a smaller size then the current size.\n\n * 400 CurrentDatabaseSizeExceedsDbMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 UnsupportedCapacity - User tried to create or update database with capacity which is not supported.\n\n * 400 RestoreToFreeEditionNotSupported - Restore and GeoRestore target cannot be free database.\n\n * 400 RestoreNotSupportedForFreeEdition - Restore and GeoRestore are not supported for free database.\n\n * 400 InvalidDroppedDatabase - Source database dropped does not exist on server within the supported recovery period.\n\n * 400 InvalidLiveDatabase - Source database does not exist on server within the supported recovery period. If restoring a dropped database, please specify its deletion date.\n\n * 400 InvalidVldbRecoverySlo - The Hyperscale edition recovery requires both source and target databases to use Hyperscale service level objective.\n\n * 400 InvalidVldbRestoreSlo - The Hyperscale edition Point-In-Time restore requires both source and target databases to use Hyperscale service level objective.\n\n * 400 CannotSpecifyPoolOrSlo - Specifying an elastic pool and/or changing the service level objective or edition is not supported for edition.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidBackupStorageAccountType - User passed zrs/lrs during create/update of a database but it failed either because the customer is not whitelisted or because zrs is not available in the specified region.\n\n * 400 DatabaseInvalidSkuPropertyCombination - The properties of the requested sku are inconsistent. Please check that a valid combination is specified. See https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability for more details.\n\n * 400 DatabaseNamedReplicaPerDatabaseLimitExceeded - User tried create a named replica that would exceed the allowed number per primary database\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 FreeDbAlreadyExists - Only one free database can exist for a subscription per region.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 TargetElasticPoolBeingUpdated - The update of elastic pool cannot be started because there is copy operation in progress for one of the databases in this elastic pool\n\n * 409 DatabaseCopyLimitPerReplicaReached - User reached the limit of concurrent database copies.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + }, + "202": { + "description": "Creating or updating the database is in progress." + }, + "201": { + "description": "Successfully created the database.", + "schema": { + "$ref": "#/definitions/Database" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates a database with default mode.": { + "$ref": "./examples/CreateDatabaseDefaultMode.json" + }, + "Creates a VCore database by specifying service objective name.": { + "$ref": "./examples/CreateVCoreDatabaseByServiceObjective.json" + }, + "Creates a VCore database by specifying sku name and capacity.": { + "$ref": "./examples/CreateVCoreDatabaseBySkuNameCapacity.json" + }, + "Creates a data warehouse by specifying service objective name.": { + "$ref": "./examples/CreateDwDatabaseByServiceObjective.json" + }, + "Creates a database with minimum number of parameters.": { + "$ref": "./examples/CreateDatabaseMin.json" + }, + "Creates a database as a copy.": { + "$ref": "./examples/CreateDatabaseCopyMode.json" + }, + "Creates a database as an on-line secondary.": { + "$ref": "./examples/CreateDatabaseSecondaryMode.json" + }, + "Creates a database as named replica secondary.": { + "$ref": "./examples/CreateDatabaseNamedReplica.json" + }, + "Creates a database from PointInTimeRestore.": { + "$ref": "./examples/CreateDatabasePITRMode.json" + }, + "Creates a database from restore with database deletion time.": { + "$ref": "./examples/CreateDatabaseRestoreMode.json" + }, + "Creates a database from restore with restorableDroppedDatabaseId.": { + "$ref": "./examples/CreateDatabaseRestoreMode2.json" + }, + "Creates a database from recoverableDatabaseId.": { + "$ref": "./examples/CreateDatabaseRecoveryMode.json" + } + } + }, + "delete": { + "tags": [ + "Databases" + ], + "description": "Deletes the database.", + "operationId": "Databases_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the database." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources." + }, + "202": { + "description": "Deleting the database is in progress." + }, + "204": { + "description": "The specified database does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes a database.": { + "$ref": "./examples/DeleteDatabase.json" + } + } + }, + "patch": { + "tags": [ + "Databases" + ], + "description": "Updates an existing database.", + "operationId": "Databases_Update", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested database resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseUpdate" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the database.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingMaxSizeBytes - MaxSizeBytes is required.\n\n * 400 MissingSkuName - Sku name is required.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 InvalidLicenseType - The specified license type is invalid.\n\n * 400 InvalidSkuName - Invalid SKU name.\n\n * 400 MismatchedSkuNameAndCapacity - Mismatch between SKU name and capacity.\n\n * 400 MismatchedSkuNameAndTier - Mismatch between SKU name and tier.\n\n * 400 MismatchedSkuNameAndFamily - Mismatch between SKU name and family.\n\n * 400 DatabaseNameDoesNotMatchSourceDatabaseId - The database name specified doesn’t match the database name in sourceDatabaseId.\n\n * 400 ElasticPoolNotSupportedForExternalBackupRestore - Elastic pool is not supported for external backup restore\n\n * 400 InvalidRecoverableDatabaseId - Invalid recoverable database identifier.\n\n * 400 InvalidRecoveryServicesRecoveryPointId - Invalid recovery services recovery point identifier.\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 MissingRecoverableDatabaseId - Missing recoverable database identifier.\n\n * 400 MissingRecoveryServicesRecoveryPointId - Missing recovery services recovery point Id.\n\n * 400 MissingRestorableDroppedDatabaseId - Missing restorableDroppedDatabaseId\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingSourceDatabaseDeletionDate - Missing source database deletion date\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 InvalidDatabaseCreateMode - Invalid request to create a database.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 TargetElasticPoolDoesNotExist - The elastic pool does not exist on a server.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolNameRequired - User tried to create or update database to elastic pool service objective without specifying the name of the elastic pool.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 InvalidReadScaleEdition - User attempted to enable read scale on a database type that does not support it.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 RequestedDatabaseSizeRequiresShrink - User attempted to ALTER DATABASE MODIFY MAXSIZE to modify the MAXSIZE for a database to a smaller size then the current size.\n\n * 400 CurrentDatabaseSizeExceedsDbMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 UnsupportedCapacity - User tried to create or update database with capacity which is not supported.\n\n * 400 RestoreToFreeEditionNotSupported - Restore and GeoRestore target cannot be free database.\n\n * 400 RestoreNotSupportedForFreeEdition - Restore and GeoRestore are not supported for free database.\n\n * 400 InvalidDroppedDatabase - Source database dropped does not exist on server within the supported recovery period.\n\n * 400 InvalidLiveDatabase - Source database does not exist on server within the supported recovery period. If restoring a dropped database, please specify its deletion date.\n\n * 400 InvalidVldbRecoverySlo - The Hyperscale edition recovery requires both source and target databases to use Hyperscale service level objective.\n\n * 400 InvalidVldbRestoreSlo - The Hyperscale edition Point-In-Time restore requires both source and target databases to use Hyperscale service level objective.\n\n * 400 CannotSpecifyPoolOrSlo - Specifying an elastic pool and/or changing the service level objective or edition is not supported for edition.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidBackupStorageAccountType - User passed zrs/lrs during create/update of a database but it failed either because the customer is not whitelisted or because zrs is not available in the specified region.\n\n * 400 DatabaseInvalidSkuPropertyCombination - The properties of the requested sku are inconsistent. Please check that a valid combination is specified. See https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability for more details.\n\n * 400 DatabaseNamedReplicaPerDatabaseLimitExceeded - User tried create a named replica that would exceed the allowed number per primary database\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 FreeDbAlreadyExists - Only one free database can exist for a subscription per region.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 TargetElasticPoolBeingUpdated - The update of elastic pool cannot be started because there is copy operation in progress for one of the databases in this elastic pool\n\n * 409 DatabaseCopyLimitPerReplicaReached - User reached the limit of concurrent database copies.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + }, + "202": { + "description": "Updating the database is in progress." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates a database.": { + "$ref": "./examples/PatchVCoreDatabase.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}/databases": { + "get": { + "tags": [ + "Databases" + ], + "description": "Gets a list of databases in an elastic pool.", + "operationId": "Databases_ListByElasticPool", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "elasticPoolName", + "in": "path", + "description": "The name of the elastic pool.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a list of databases in an elastic pool.", + "schema": { + "$ref": "#/definitions/DatabaseListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets a list of databases in an elastic pool.": { + "$ref": "./examples/ListDatabasesByElasticPool.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/failover": { + "post": { + "tags": [ + "Databases" + ], + "description": "Failovers a database.", + "operationId": "Databases_Failover", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "databaseName", + "in": "path", + "description": "The name of the database to failover.", + "required": true, + "type": "string" + }, + { + "name": "replicaType", + "in": "query", + "description": "The type of replica to be failed over.", + "required": false, + "type": "string", + "enum": [ + "Primary", + "ReadableSecondary" + ], + "x-ms-enum": { + "name": "ReplicaType", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully completed database failover." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 DatabaseFailoverThrottled - There was a recent failover on the database or pool if database belongs in an elastic pool.\n\n * 400 DatabaseFailoverNotSupportedOnSKU - This type of customer initiated failover is not supported on the given SKU.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 DatabaseNotInStateToFailover - The database is currently in a state such that failover cannot be issued." + }, + "202": { + "description": "Database failover is in progress." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Failover an database": { + "$ref": "./examples/FailoverDatabase.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/pause": { + "post": { + "tags": [ + "Databases" + ], + "description": "Pauses a database.", + "operationId": "Databases_Pause", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "databaseName", + "in": "path", + "description": "The name of the database to be paused.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully paused the database.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 CannotDeactivateWhenDeactivatingInProgress - Deactivation workflow failed because there is a deactivate workflow already running.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows" + }, + "202": { + "description": "Pausing the database is in progress." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Pauses a database.": { + "$ref": "./examples/PauseDatabase.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/resume": { + "post": { + "tags": [ + "Databases" + ], + "description": "Resumes a database.", + "operationId": "Databases_Resume", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "databaseName", + "in": "path", + "description": "The name of the database to be resumed.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully resumed the database.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows" + }, + "202": { + "description": "Resuming the database is in progress." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Resumes a database.": { + "$ref": "./examples/ResumeDatabase.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/upgradeDataWarehouse": { + "post": { + "tags": [ + "Databases" + ], + "description": "Upgrades a data warehouse.", + "operationId": "Databases_UpgradeDataWarehouse", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "databaseName", + "in": "path", + "description": "The name of the database to be upgraded.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully upgraded the data warehouse." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 InvalidDatabaseCreateMode - Invalid request to create a database.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 TargetElasticPoolDoesNotExist - The elastic pool does not exist on a server.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolNameRequired - User tried to create or update database to elastic pool service objective without specifying the name of the elastic pool.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 InvalidReadScaleEdition - User attempted to enable read scale on a database type that does not support it.\n\n * 400 InvalidReadScaleUnits - User attempted to provide a read scale value that is not supported.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 RequestedDatabaseSizeRequiresShrink - User attempted to ALTER DATABASE MODIFY MAXSIZE to modify the MAXSIZE for a database to a smaller size then the current size.\n\n * 400 CurrentDatabaseSizeExceedsDbMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 SourceDatabaseEditionCouldNotBeUpgraded - The source database cannot have higher edition than the target database.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 or 3072 and Key Type is RSA or RSA-HSM.\n\n * 400 TargetDatabaseEditionCouldNotBeDowngraded - The target database cannot have lower edition than the source database.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 SecurityAzureKeyVaultGeoChainError - Creating secondary of secondary (a process known as chaining) is not supported when enabling Transparent Data Encryption using Azure Key Vault (BYOK).\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 UnsupportedCapacity - User tried to create or update database with capacity which is not supported.\n\n * 400 RestoreToFreeEditionNotSupported - Restore and GeoRestore target cannot be free database.\n\n * 400 RestoreNotSupportedForFreeEdition - Restore and GeoRestore are not supported for free database.\n\n * 400 InvalidDroppedDatabase - Source database dropped does not exist on server within the supported recovery period.\n\n * 400 InvalidLiveDatabase - Source database does not exist on server within the supported recovery period. If restoring a dropped database, please specify its deletion date.\n\n * 400 InvalidVldbRecoverySlo - The Hyperscale edition recovery requires both source and target databases to use Hyperscale service level objective.\n\n * 400 InvalidVldbRestoreSlo - The Hyperscale edition Point-In-Time restore requires both source and target databases to use Hyperscale service level objective.\n\n * 400 CannotSpecifyPoolOrSlo - Specifying an elastic pool and/or changing the service level objective or edition is not supported for edition.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidBackupStorageAccountType - User passed zrs/lrs during create/update of a database but it failed either because the customer is not whitelisted or because zrs is not available in the specified region.\n\n * 400 DatabaseInvalidSkuPropertyCombination - The properties of the requested sku are inconsistent. Please check that a valid combination is specified. See https://docs.microsoft.com/en-us/rest/api/sql/capabilities/listbylocation#serviceobjectivecapability for more details.\n\n * 400 DatabaseNamedReplicaPerDatabaseLimitExceeded - User tried create a named replica that would exceed the allowed number per primary database\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 UpgradeOnlyAllowedOnDataWarehouseInstances - User attempted to upgrade non-datawarehouse instance.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 FreeDbAlreadyExists - Only one free database can exist for a subscription per region.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 TargetElasticPoolBeingUpdated - The update of elastic pool cannot be started because there is copy operation in progress for one of the databases in this elastic pool\n\n * 409 DatabaseCopyLimitPerReplicaReached - User reached the limit of concurrent database copies.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + }, + "202": { + "description": "Upgrading the data warehouse is in progress." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upgrades a data warehouse.": { + "$ref": "./examples/UpgradeDataWarehouse.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/move": { + "post": { + "tags": [ + "Databases" + ], + "description": "Renames a database.", + "operationId": "Databases_Rename", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "databaseName", + "in": "path", + "description": "The name of the database to rename.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The resource move definition for renaming this database.", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceMoveDefinition" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully renamed the database." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidResourceMoveRequest - The resource move request is invalid.\n\n * 400 InvalidMoveTargetResourceId - The target resource identifier in move request is invalid.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 DatabaseNameInUse - Database already exists. Choose a different database name.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship." + } + }, + "x-ms-examples": { + "Renames a database.": { + "$ref": "./examples/RenameDatabase.json" + } + } + } + } + }, + "definitions": { + "DatabaseListResult": { + "description": "A list of databases.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Database" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "DatabaseProperties": { + "description": "The database's properties.", + "type": "object", + "properties": { + "createMode": { + "description": "Specifies the mode of database creation.\r\n\r\nDefault: regular database creation.\r\n\r\nCopy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database.\r\n\r\nSecondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database.\r\n\r\nPointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified.\r\n\r\nRecovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore.\r\n\r\nRestore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time.\r\n\r\nRestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID.\r\n\r\nCopy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition.", + "enum": [ + "Default", + "Copy", + "Secondary", + "PointInTimeRestore", + "Restore", + "Recovery", + "RestoreExternalBackup", + "RestoreExternalBackupSecondary", + "RestoreLongTermRetentionBackup", + "OnlineSecondary" + ], + "type": "string", + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": true + }, + "x-ms-mutability": [ + "create" + ] + }, + "collation": { + "description": "The collation of the database.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "maxSizeBytes": { + "format": "int64", + "description": "The max size of the database expressed in bytes.", + "type": "integer" + }, + "sampleName": { + "description": "The name of the sample schema to apply when creating this database.", + "enum": [ + "AdventureWorksLT", + "WideWorldImportersStd", + "WideWorldImportersFull" + ], + "type": "string", + "x-ms-enum": { + "name": "SampleName", + "modelAsString": true + }, + "x-ms-mutability": [ + "create" + ] + }, + "elasticPoolId": { + "description": "The resource identifier of the elastic pool containing this database.", + "type": "string" + }, + "sourceDatabaseId": { + "description": "The resource identifier of the source database associated with create operation of this database.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "status": { + "description": "The status of the database.", + "enum": [ + "Online", + "Restoring", + "RecoveryPending", + "Recovering", + "Suspect", + "Offline", + "Standby", + "Shutdown", + "EmergencyMode", + "AutoClosed", + "Copying", + "Creating", + "Inaccessible", + "OfflineSecondary", + "Pausing", + "Paused", + "Resuming", + "Scaling", + "OfflineChangingDwPerformanceTiers", + "OnlineChangingDwPerformanceTiers", + "Disabled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DatabaseStatus", + "modelAsString": true + } + }, + "databaseId": { + "format": "uuid", + "description": "The ID of the database.", + "type": "string", + "readOnly": true + }, + "creationDate": { + "format": "date-time", + "description": "The creation date of the database (ISO8601 format).", + "type": "string", + "readOnly": true + }, + "currentServiceObjectiveName": { + "description": "The current service level objective name of the database.", + "type": "string", + "readOnly": true + }, + "requestedServiceObjectiveName": { + "description": "The requested service level objective name of the database.", + "type": "string", + "readOnly": true + }, + "defaultSecondaryLocation": { + "description": "The default secondary region for this database.", + "type": "string", + "readOnly": true + }, + "failoverGroupId": { + "description": "Failover Group resource identifier that this database belongs to.", + "type": "string", + "readOnly": true + }, + "restorePointInTime": { + "format": "date-time", + "description": "Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "sourceDatabaseDeletionDate": { + "format": "date-time", + "description": "Specifies the time that the database was deleted.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "recoveryServicesRecoveryPointId": { + "description": "The resource identifier of the recovery point associated with create operation of this database.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "longTermRetentionBackupResourceId": { + "description": "The resource identifier of the long term retention backup associated with create operation of this database.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "recoverableDatabaseId": { + "description": "The resource identifier of the recoverable database associated with create operation of this database.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "restorableDroppedDatabaseId": { + "description": "The resource identifier of the restorable dropped database associated with create operation of this database.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "catalogCollation": { + "description": "Collation of the metadata catalog.", + "enum": [ + "DATABASE_DEFAULT", + "SQL_Latin1_General_CP1_CI_AS" + ], + "type": "string", + "x-ms-enum": { + "name": "CatalogCollationType", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "zoneRedundant": { + "description": "Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.", + "type": "boolean" + }, + "licenseType": { + "description": "The license type to apply for this database. `LicenseIncluded` if you need a license, or `BasePrice` if you have a license and are eligible for the Azure Hybrid Benefit.", + "enum": [ + "LicenseIncluded", + "BasePrice" + ], + "type": "string", + "x-ms-enum": { + "name": "DatabaseLicenseType", + "modelAsString": true + } + }, + "maxLogSizeBytes": { + "format": "int64", + "description": "The max log size for this database.", + "type": "integer", + "readOnly": true + }, + "earliestRestoreDate": { + "format": "date-time", + "description": "This records the earliest start date and time that restore is available for this database (ISO8601 format).", + "type": "string", + "readOnly": true + }, + "readScale": { + "description": "The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "DatabaseReadScale", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "update" + ] + }, + "highAvailabilityReplicaCount": { + "format": "int32", + "description": "The number of secondary replicas associated with the database that are used to provide high availability.", + "type": "integer" + }, + "secondaryType": { + "description": "The secondary type of the database if it is a secondary. Valid values are Geo and Named.", + "enum": [ + "Geo", + "Named" + ], + "type": "string", + "x-ms-enum": { + "name": "SecondaryType", + "modelAsString": true + } + }, + "currentSku": { + "$ref": "../../../common/v1/types.json#/definitions/Sku", + "description": "The name and tier of the SKU.", + "readOnly": true + }, + "autoPauseDelay": { + "format": "int32", + "description": "Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled", + "type": "integer" + }, + "storageAccountType": { + "description": "The storage account type used to store backups for this database. Currently the only supported option is GRS (GeoRedundantStorage).", + "enum": [ + "GRS", + "LRS", + "ZRS" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": true + } + }, + "minCapacity": { + "format": "double", + "description": "Minimal capacity that database will always have allocated, if not paused", + "type": "number" + }, + "pausedDate": { + "format": "date-time", + "description": "The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready.", + "type": "string", + "readOnly": true + }, + "resumedDate": { + "format": "date-time", + "description": "The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused.", + "type": "string", + "readOnly": true + }, + "maintenanceConfigurationId": { + "description": "Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will be rolled out.", + "type": "string" + } + } + }, + "Database": { + "description": "A database resource.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "../../../common/v1/types.json#/definitions/Sku", + "description": "The database SKU.\r\n\r\nThe list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or one of the following commands:\r\n\r\n```azurecli\r\naz sql db list-editions -l -o table\r\n````\r\n\r\n```powershell\r\nGet-AzSqlServerServiceObjective -Location \r\n````\r\n" + }, + "kind": { + "description": "Kind of database. This is metadata used for the Azure portal experience.", + "type": "string", + "readOnly": true + }, + "managedBy": { + "description": "Resource that manages the database.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/DatabaseProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "DatabaseUpdate": { + "description": "A database resource.", + "type": "object", + "properties": { + "sku": { + "$ref": "../../../common/v1/types.json#/definitions/Sku", + "description": "The name and tier of the SKU." + }, + "properties": { + "$ref": "#/definitions/DatabaseProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ResourceMoveDefinition": { + "description": "Contains the information necessary to perform a resource move (rename).", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "The target ID for the resource", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for the request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "description": "The name of the database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "WorkspaceNameParameter": { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlPoolNameParameter": { + "name": "sqlPoolName", + "in": "path", + "description": "The name of the sql pool.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlDatabaseNameParameter": { + "name": "sqlDatabaseName", + "in": "path", + "description": "The name of the sql database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/elasticPools.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/elasticPools.json new file mode 100644 index 000000000000..b3f260843c4a --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/elasticPools.json @@ -0,0 +1,632 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-08-01-preview", + "title": "SqlManagementClient", + "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools": { + "get": { + "tags": [ + "ElasticPools" + ], + "description": "Gets all elastic pools in a server.", + "operationId": "ElasticPools_ListByServer", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "$skip", + "in": "query", + "description": "The number of elements in the collection to skip.", + "required": false, + "type": "integer" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/ElasticPoolListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit.\n\n * 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.\n\n * 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.\n\n * 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.\n\n * 400 InvalidMaxSize - Invalid max size.\n\n * 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.\n\n * 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.\n\n * 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.\n\n * 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get all elastic pools in a server": { + "$ref": "./examples/ElasticPoolListByServer.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}": { + "get": { + "tags": [ + "ElasticPools" + ], + "description": "Gets an elastic pool.", + "operationId": "ElasticPools_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "elasticPoolName", + "in": "path", + "description": "The name of the elastic pool.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/ElasticPool" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit.\n\n * 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.\n\n * 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.\n\n * 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.\n\n * 400 InvalidMaxSize - Invalid max size.\n\n * 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.\n\n * 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.\n\n * 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.\n\n * 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable." + } + }, + "x-ms-examples": { + "Get an elastic pool": { + "$ref": "./examples/ElasticPoolGet.json" + } + } + }, + "put": { + "tags": [ + "ElasticPools" + ], + "description": "Creates or updates an elastic pool.", + "operationId": "ElasticPools_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "elasticPoolName", + "in": "path", + "description": "The name of the elastic pool.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The elastic pool parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticPool" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Updated the elastic pool", + "schema": { + "$ref": "#/definitions/ElasticPool" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit.\n\n * 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.\n\n * 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.\n\n * 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.\n\n * 400 InvalidMaxSize - Invalid max size.\n\n * 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.\n\n * 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.\n\n * 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.\n\n * 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSkuName - Invalid SKU name.\n\n * 400 MismatchedSkuNameAndCapacity - Mismatch between SKU name and capacity.\n\n * 400 MismatchedSkuNameAndTier - Mismatch between SKU name and tier.\n\n * 400 MismatchedSkuNameAndFamily - Mismatch between SKU name and family.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit.\n\n * 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.\n\n * 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.\n\n * 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.\n\n * 400 InvalidMaxSize - Invalid max size.\n\n * 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.\n\n * 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.\n\n * 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.\n\n * 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable." + }, + "202": { + "description": "Accepted" + }, + "201": { + "description": "Created the elastic pool", + "schema": { + "$ref": "#/definitions/ElasticPool" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update elastic pool with minimum parameters": { + "$ref": "./examples/ElasticPoolCreateOrUpdateMin.json" + }, + "Create or update elastic pool with all parameter": { + "$ref": "./examples/ElasticPoolCreateOrUpdateMax.json" + } + } + }, + "delete": { + "tags": [ + "ElasticPools" + ], + "description": "Deletes an elastic pool.", + "operationId": "ElasticPools_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "elasticPoolName", + "in": "path", + "description": "The name of the elastic pool.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Deleted the elastic pool" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit.\n\n * 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.\n\n * 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.\n\n * 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.\n\n * 400 InvalidMaxSize - Invalid max size.\n\n * 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.\n\n * 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.\n\n * 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.\n\n * 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable." + }, + "202": { + "description": "Deleting the elastic pool is in progress." + }, + "204": { + "description": "Elastic pool did not exist" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete an elastic pool": { + "$ref": "./examples/ElasticPoolDelete.json" + } + } + }, + "patch": { + "tags": [ + "ElasticPools" + ], + "description": "Updates an elastic pool.", + "operationId": "ElasticPools_Update", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "elasticPoolName", + "in": "path", + "description": "The name of the elastic pool.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The elastic pool update parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticPoolUpdate" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Updated the elastic pool", + "schema": { + "$ref": "#/definitions/ElasticPool" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit.\n\n * 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.\n\n * 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.\n\n * 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.\n\n * 400 InvalidMaxSize - Invalid max size.\n\n * 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.\n\n * 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.\n\n * 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.\n\n * 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSkuName - Invalid SKU name.\n\n * 400 MismatchedSkuNameAndCapacity - Mismatch between SKU name and capacity.\n\n * 400 MismatchedSkuNameAndTier - Mismatch between SKU name and tier.\n\n * 400 MismatchedSkuNameAndFamily - Mismatch between SKU name and family.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerQuotaExceeded - The server reached its limit for allowed Database Throughput Unit.\n\n * 400 ElasticPoolAlreadyExists - The server already contains an elastic pool with the specified name.\n\n * 400 InvalidInputValueForEdition - Specified edition is not supported for elastic pool provisioning.\n\n * 400 ElasticPoolDtuBelowLimit - The requested DTU value is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDtuAboveLimit - The requested DTU value is too high for the requested elastic pool service tier.\n\n * 400 InvalidMaxSize - Invalid max size.\n\n * 400 ElasticPoolDbDtuMaxBelowLimit - The requested per database DTU max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbDtuMaxAboveLimit - The requested per database DTU max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMax - Attempting to set the DTU max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbDtuMinAboveLimit - The requested DTU min per database is too high for the requested service tier.\n\n * 400 InvalidInputValueForDatabaseDtuMin - Attempting to set the DTU min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolInconsistentDtuGuaranteeSettings - Attempting to provide DTU min for databases in the elastic pool that exceeds requested DTUs of the elastic pool.\n\n * 400 ElasticPoolDtuUnsupported - User tried to create or update an elastic pool with a DTU capacity that is not supported.\n\n * 400 ElasticPoolStorageAboveLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolsNotEnabled - Elastic pools have not been enabled in this region.\n\n * 400 ElasticPoolNotEmpty - Request to delete an elastic pool that is not empty.\n\n * 400 ElasticPoolStorageBelowLimitGB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedGB - Attempting to set the elastic pool storage limit in gb which doesn't match the allowed values.\n\n * 400 ElasticPoolDatabaseLimit - The elastic pool has reached its limit for number of databases.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 ElasticPoolBusy - A management operation was attempted on an elastic pool which is busy.\n\n * 400 InvalidInputValueDatabaseDtuMinLargerThanMax - Attempting to set the DTU min per database higher than the DTU max per database.\n\n * 400 ElasticPoolInconsistentVcoreGuaranteeSettings - The number of databases and VCore min per database cannot exceed requested VCores of the elastic pool.\n\n * 400 ElasticPoolStorageBelowLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 ElasticPoolStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolCapacityStorageNotAllowedMB - Attempting to set the elastic pool storage limit in mb which doesn't match the allowed values.\n\n * 400 ElasticPoolStorageAboveLimitMB - Attempting to set the elastic pool storage limit below the supported limit.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 ElasticPoolUpdateHkNotAllowed - The elastic pool cannot lower its service tier from Premium to Standard or Basic since one or more of its databases use memory-optimized objects.\n\n * 400 RegionDoesNotAllowProvisioning - The selected location is not accepting new Windows Azure SQL Database servers. This may change at a later time.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 ElasticPoolDbDtuMinBelowLimit - The requested per database DTU min is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxBelowLimit - The requested per database VCore max is too low for the requested elastic pool service tier.\n\n * 400 ElasticPoolDbVcoreMaxAboveLimit - The requested per database VCore max is too high for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMax - Attempting to set the VCore max per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 ElasticPoolDbVcoreMinBelowLimit - The requested per database VCore min is too low for the requested elastic pool service tier.\n\n * 400 InvalidInputValueForDatabaseVcoreMin - Attempting to set the VCore min per database for the Resource Pool which doesn't match the allowed values.\n\n * 400 InvalidInputValueDatabaseVcoreMinLargerThanMax - Attempting to set the VCore min per database higher than the VCore max per database.\n\n * 400 InvalidLicenseType - User tried to create or update a database or elastic pool with unsupported license type.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ElasticPoolNotFound - The specified elastic pool does not exist for the specified server.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 405 NotSupported - This functionality is not supported.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ElasticPoolUpdateLinksNotInCatchup - Cannot update elastic pool while one of its databases is performing a copy or geo-replication failover operation.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable.\n\n * 503 ServiceTemporarilyUnavailable - Feature temporarily unavailable." + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update an elastic pool with minimum parameters": { + "$ref": "./examples/ElasticPoolUpdateMin.json" + }, + "Update an elastic pool with all parameter": { + "$ref": "./examples/ElasticPoolUpdateMax.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/elasticPools/{elasticPoolName}/failover": { + "post": { + "tags": [ + "ElasticPools" + ], + "description": "Failovers an elastic pool.", + "operationId": "ElasticPools_Failover", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "elasticPoolName", + "in": "path", + "description": "The name of the elastic pool to failover.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully completed elastic pool failover." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 ElasticPoolFailoverThrottled - There was a recent failover on the elastic pool.\n\n * 400 ElasticPoolFailoverNotSupportedOnSKU - This type of customer initiated failover is not supported on the given SKU.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ElasticPoolNotInStateToFailover - The elastic pool or a database within the elastic pool is currently in a state such that failover cannot be issued." + }, + "202": { + "description": "Elastic pool failover is in progress." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Failover an elastic pool": { + "$ref": "./examples/FailoverElasticPool.json" + } + } + } + } + }, + "definitions": { + "ElasticPoolListResult": { + "description": "The result of an elastic pool list request.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ElasticPool" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ElasticPoolProperties": { + "description": "Properties of an elastic pool", + "type": "object", + "properties": { + "state": { + "description": "The state of the elastic pool.", + "enum": [ + "Creating", + "Ready", + "Disabled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ElasticPoolState", + "modelAsString": true + } + }, + "creationDate": { + "format": "date-time", + "description": "The creation date of the elastic pool (ISO8601 format).", + "type": "string", + "readOnly": true + }, + "maxSizeBytes": { + "format": "int64", + "description": "The storage limit for the database elastic pool in bytes.", + "type": "integer" + }, + "perDatabaseSettings": { + "$ref": "#/definitions/ElasticPoolPerDatabaseSettings", + "description": "The per database settings for the elastic pool." + }, + "zoneRedundant": { + "description": "Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.", + "type": "boolean" + }, + "licenseType": { + "description": "The license type to apply for this elastic pool.", + "enum": [ + "LicenseIncluded", + "BasePrice" + ], + "type": "string", + "x-ms-enum": { + "name": "ElasticPoolLicenseType", + "modelAsString": true + } + }, + "maintenanceConfigurationId": { + "description": "Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will be rolled out.", + "type": "string" + } + } + }, + "ElasticPoolPerDatabaseSettings": { + "description": "Per database settings of an elastic pool.", + "type": "object", + "properties": { + "minCapacity": { + "format": "double", + "description": "The minimum capacity all databases are guaranteed.", + "type": "number" + }, + "maxCapacity": { + "format": "double", + "description": "The maximum capacity any one database can consume.", + "type": "number" + } + } + }, + "ElasticPool": { + "description": "An elastic pool.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "../../../common/v1/types.json#/definitions/Sku", + "description": "The elastic pool SKU.\r\n\r\nThe list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or the following command:\r\n\r\n```azurecli\r\naz sql elastic-pool list-editions -l -o table\r\n````\r\n" + }, + "kind": { + "description": "Kind of elastic pool. This is metadata used for the Azure portal experience.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/ElasticPoolProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ElasticPoolUpdate": { + "description": "An elastic pool update.", + "type": "object", + "properties": { + "sku": { + "$ref": "../../../common/v1/types.json#/definitions/Sku" + }, + "properties": { + "$ref": "#/definitions/ElasticPoolUpdateProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ElasticPoolUpdateProperties": { + "description": "Properties of an elastic pool", + "type": "object", + "properties": { + "maxSizeBytes": { + "format": "int64", + "description": "The storage limit for the database elastic pool in bytes.", + "type": "integer" + }, + "perDatabaseSettings": { + "$ref": "#/definitions/ElasticPoolPerDatabaseSettings", + "description": "The per database settings for the elastic pool." + }, + "zoneRedundant": { + "description": "Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.", + "type": "boolean" + }, + "licenseType": { + "description": "The license type to apply for this elastic pool.", + "enum": [ + "LicenseIncluded", + "BasePrice" + ], + "type": "string", + "x-ms-enum": { + "name": "ElasticPoolLicenseType", + "modelAsString": true + } + }, + "maintenanceConfigurationId": { + "description": "Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will be rolled out.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for the request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "description": "The name of the database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "WorkspaceNameParameter": { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlPoolNameParameter": { + "name": "sqlPoolName", + "in": "path", + "description": "The name of the sql pool.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlDatabaseNameParameter": { + "name": "sqlDatabaseName", + "in": "path", + "description": "The name of the sql database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseCopyMode.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseCopyMode.json new file mode 100644 index 000000000000..bd3f658c3a1d --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseCopyMode.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "dbcopy", + "api-version": "2020-08-01-preview", + "parameters": { + "location": "southeastasia", + "sku": { + "name": "S0", + "tier": "Standard" + }, + "properties": { + "createMode": "Copy", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 10 + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "currentSku": { + "name": "Standard", + "tier": "Standard", + "capacity": 10 + }, + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "S0", + "defaultSecondaryLocation": "North Europe", + "earliestRestoreDate": "2017-06-07T04:51:33.937Z", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "readScale": "Disabled", + "requestedServiceObjectiveName": "S0", + "storageAccountType": "GRS", + "zoneRedundant": false + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "dbcopy", + "type": "Microsoft.Sql/servers/databases" + } + }, + "201": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 10 + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "currentSku": { + "name": "Standard", + "tier": "Standard", + "capacity": 10 + }, + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "S0", + "defaultSecondaryLocation": "North Europe", + "earliestRestoreDate": "2017-06-07T04:51:33.937Z", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "readScale": "Disabled", + "requestedServiceObjectiveName": "S0", + "storageAccountType": "GRS", + "zoneRedundant": false + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "dbcopy", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseDefaultMode.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseDefaultMode.json new file mode 100644 index 000000000000..70b97d09c8d3 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseDefaultMode.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "testdb", + "api-version": "2020-08-01-preview", + "parameters": { + "location": "southeastasia", + "sku": { + "name": "S0", + "tier": "Standard" + }, + "properties": { + "createMode": "Default", + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 1073741824 + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "S0", + "tier": "Standard", + "capacity": 10 + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 1073741824, + "status": "Online", + "currentSku": { + "name": "Standard", + "tier": "Standard", + "capacity": 10 + }, + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "S0", + "defaultSecondaryLocation": "North Europe", + "earliestRestoreDate": "2017-06-07T04:51:33.937Z", + "readScale": "Disabled", + "requestedServiceObjectiveName": "S0", + "storageAccountType": "GRS", + "zoneRedundant": false, + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb", + "type": "Microsoft.Sql/servers/databases" + } + }, + "201": { + "body": { + "sku": { + "name": "S0", + "tier": "Standard", + "capacity": 10 + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 1073741824, + "status": "Online", + "currentSku": { + "name": "Standard", + "tier": "Standard", + "capacity": 10 + }, + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "S0", + "defaultSecondaryLocation": "North Europe", + "earliestRestoreDate": "2017-06-07T04:51:33.937Z", + "readScale": "Disabled", + "requestedServiceObjectiveName": "S0", + "storageAccountType": "GRS", + "zoneRedundant": false, + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseMin.json new file mode 100644 index 000000000000..c79e76a12d12 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseMin.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "testdb", + "api-version": "2020-08-01-preview", + "parameters": { + "location": "southeastasia" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 10 + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "currentSku": { + "name": "Standard", + "tier": "Standard", + "capacity": 10 + }, + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "S0", + "defaultSecondaryLocation": "North Europe", + "earliestRestoreDate": "2017-06-07T04:51:33.937Z", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "readScale": "Disabled", + "requestedServiceObjectiveName": "S0", + "storageAccountType": "GRS", + "zoneRedundant": false + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb", + "type": "Microsoft.Sql/servers/databases" + } + }, + "201": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 10 + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "currentSku": { + "name": "Standard", + "tier": "Standard", + "capacity": 10 + }, + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "S0", + "defaultSecondaryLocation": "North Europe", + "earliestRestoreDate": "2017-06-07T04:51:33.937Z", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "readScale": "Disabled", + "requestedServiceObjectiveName": "S0", + "storageAccountType": "GRS", + "zoneRedundant": false + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseNamedReplica.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseNamedReplica.json new file mode 100644 index 000000000000..3f71f7c4c1ef --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseNamedReplica.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "testdb", + "api-version": "2020-08-01-preview", + "parameters": { + "location": "southeastasia", + "sku": { + "name": "HS_Gen4", + "tier": "Hyperscale", + "capacity": 2 + }, + "properties": { + "createMode": "Secondary", + "secondaryType": "Named", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-NorthEurope/providers/Microsoft.Sql/servers/testsvr1/databases/primarydb" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "HS_Gen4", + "tier": "Hyperscale", + "family": "Gen4", + "capacity": 2 + }, + "kind": "v12.0,user,vcore,hyperscale", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": -1, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "currentSku": { + "name": "HS_Gen4", + "tier": "Hyperscale", + "family": "Gen4", + "capacity": 2 + }, + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "HS_Gen4_2", + "defaultSecondaryLocation": "North Europe", + "earliestRestoreDate": "2017-06-07T04:51:33.937Z", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "readScale": "Disabled", + "requestedServiceObjectiveName": "HS_Gen4_2", + "storageAccountType": "GRS", + "highAvailabilityReplicaCount": 0, + "licenseType": "LicenseIncluded", + "secondaryType": "Named", + "zoneRedundant": false + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb", + "type": "Microsoft.Sql/servers/databases" + } + }, + "201": { + "body": { + "sku": { + "name": "HS_Gen4", + "tier": "Hyperscale", + "family": "Gen4", + "capacity": 2 + }, + "kind": "v12.0,user,vcore,hyperscale", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": -1, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "currentSku": { + "name": "HS_Gen4", + "tier": "Hyperscale", + "family": "Gen4", + "capacity": 2 + }, + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "HS_Gen4_2", + "defaultSecondaryLocation": "North Europe", + "earliestRestoreDate": "2017-06-07T04:51:33.937Z", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "readScale": "Disabled", + "requestedServiceObjectiveName": "HS_Gen4_2", + "storageAccountType": "GRS", + "highAvailabilityReplicaCount": 0, + "licenseType": "LicenseIncluded", + "secondaryType": "Named", + "zoneRedundant": false + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabasePITRMode.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabasePITRMode.json new file mode 100644 index 000000000000..ac1df30711b7 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabasePITRMode.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "dbpitr", + "api-version": "2017-03-01-preview", + "parameters": { + "location": "southeastasia", + "sku": { + "name": "S0", + "tier": "Standard" + }, + "properties": { + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "restorePointInTime": "2017-07-14T05:35:31.503Z" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "S0", + "tier": "Standard" + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "S0", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/dbpitr", + "name": "dbpitr", + "type": "Microsoft.Sql/servers/databases" + } + }, + "201": { + "body": { + "sku": { + "name": "S0", + "tier": "Standard" + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "S0", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/dbpitr", + "name": "dbpitr", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseRecoveryMode.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseRecoveryMode.json new file mode 100644 index 000000000000..a4f8cee34bc7 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseRecoveryMode.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "dbrestore", + "api-version": "2017-03-01-preview", + "parameters": { + "location": "southeastasia", + "sku": { + "name": "S0", + "tier": "Standard" + }, + "properties": { + "createMode": "Restore", + "restorableDroppedDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/restorableDroppedDatabases/testdb2,131444841315030000" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "S0", + "tier": "Standard" + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "S0", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/dbrestore", + "name": "dbrestore", + "type": "Microsoft.Sql/servers/databases" + } + }, + "201": { + "body": { + "sku": { + "name": "S0", + "tier": "Standard" + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "S0", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/dbrestore", + "name": "dbrestore", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseRestoreMode.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseRestoreMode.json new file mode 100644 index 000000000000..93a6d13ce5db --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseRestoreMode.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "dbrestore", + "api-version": "2017-03-01-preview", + "parameters": { + "location": "southeastasia", + "sku": { + "name": "S0", + "tier": "Standard" + }, + "properties": { + "createMode": "Restore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "sourceDatabaseDeletionDate": "2017-07-14T06:41:06.613Z" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "S0", + "tier": "Standard" + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "S0", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/dbrestore", + "name": "dbrestore", + "type": "Microsoft.Sql/servers/databases" + } + }, + "201": { + "body": { + "sku": { + "name": "S0", + "tier": "Standard" + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "S0", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/dbrestore", + "name": "dbrestore", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseRestoreMode2.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseRestoreMode2.json new file mode 100644 index 000000000000..2a86acd6e7dc --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseRestoreMode2.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "dbrestore", + "api-version": "2017-03-01-preview", + "parameters": { + "location": "southeastasia", + "sku": { + "name": "S0", + "tier": "Standard" + }, + "properties": { + "createMode": "Restore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/restorableDroppedDatabases/testdb,131403269876900000" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "S0", + "tier": "Standard" + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "S0", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/dbrestore", + "name": "dbrestore", + "type": "Microsoft.Sql/servers/databases" + } + }, + "201": { + "body": { + "sku": { + "name": "S0", + "tier": "Standard" + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "S0", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/dbrestore", + "name": "dbrestore", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseSecondaryMode.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseSecondaryMode.json new file mode 100644 index 000000000000..e93322c01165 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDatabaseSecondaryMode.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "testdb", + "api-version": "2020-08-01-preview", + "parameters": { + "location": "southeastasia", + "sku": { + "name": "S0", + "tier": "Standard" + }, + "properties": { + "createMode": "Secondary", + "secondaryType": "Geo", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-NorthEurope/providers/Microsoft.Sql/servers/testsvr1/databases/testdb" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 10 + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "currentSku": { + "name": "Standard", + "tier": "Standard", + "capacity": 10 + }, + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "S0", + "defaultSecondaryLocation": "North Europe", + "earliestRestoreDate": "2017-06-07T04:51:33.937Z", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "readScale": "Disabled", + "requestedServiceObjectiveName": "S0", + "storageAccountType": "GRS", + "secondaryType": "Geo", + "zoneRedundant": false + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb", + "type": "Microsoft.Sql/servers/databases" + } + }, + "201": { + "body": { + "sku": { + "name": "Standard", + "tier": "Standard", + "capacity": 10 + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "currentSku": { + "name": "Standard", + "tier": "Standard", + "capacity": 10 + }, + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "S0", + "defaultSecondaryLocation": "North Europe", + "earliestRestoreDate": "2017-06-07T04:51:33.937Z", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "readScale": "Disabled", + "requestedServiceObjectiveName": "S0", + "storageAccountType": "GRS", + "secondaryType": "Geo", + "zoneRedundant": false + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDwDatabaseByServiceObjective.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDwDatabaseByServiceObjective.json new file mode 100644 index 000000000000..24ce51c0777a --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateDwDatabaseByServiceObjective.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "testdw", + "api-version": "2020-08-01-preview", + "parameters": { + "location": "westus", + "sku": { + "name": "DW1000c" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "DataWarehouse", + "tier": "DataWarehouse", + "capacity": 9000 + }, + "kind": "v12.0,user,datawarehouse,gen2", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 263882790666240, + "status": "Online", + "databaseId": "188784c9-d602-4684-86cf-e67b6f03551a", + "creationDate": "2019-04-24T06:46:14.99Z", + "currentServiceObjectiveName": "DW1000c", + "requestedServiceObjectiveName": "DW1000c", + "defaultSecondaryLocation": "eastus", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "readScale": "Disabled", + "currentSku": { + "name": "DataWarehouse", + "tier": "DataWarehouse", + "capacity": 9000 + } + }, + "location": "westus", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdw", + "name": "testdw", + "type": "Microsoft.Sql/servers/databases" + } + }, + "201": { + "body": { + "sku": { + "name": "DataWarehouse", + "tier": "DataWarehouse", + "capacity": 9000 + }, + "kind": "v12.0,user,datawarehouse,gen2", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 263882790666240, + "status": "Online", + "databaseId": "188784c9-d602-4684-86cf-e67b6f03551a", + "creationDate": "2019-04-24T06:46:14.99Z", + "currentServiceObjectiveName": "DW1000c", + "requestedServiceObjectiveName": "DW1000c", + "defaultSecondaryLocation": "eastus", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "readScale": "Disabled", + "currentSku": { + "name": "DataWarehouse", + "tier": "DataWarehouse", + "capacity": 9000 + } + }, + "location": "westus", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdw", + "name": "testdw", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateVCoreDatabaseByServiceObjective.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateVCoreDatabaseByServiceObjective.json new file mode 100644 index 000000000000..c9eebdb8f6ec --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateVCoreDatabaseByServiceObjective.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "testdb", + "api-version": "2020-08-01-preview", + "parameters": { + "location": "southeastasia", + "sku": { + "name": "BC", + "family": "Gen4", + "capacity": 2 + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "BC_Gen4", + "tier": "BusinessCritical", + "family": "Gen4", + "capacity": 2 + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "earliestRestoreDate": "2017-06-07T04:51:33.937Z", + "maxSizeBytes": 1073741824, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "BC_Gen4_2", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "licenseType": "LicenseIncluded", + "maxLogSizeBytes": 104857600, + "readScale": "Enabled", + "storageAccountType": "GRS", + "zoneRedundant": false, + "currentSku": { + "name": "BC_Gen4", + "tier": "BusinessCritical", + "capacity": 2 + } + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb", + "type": "Microsoft.Sql/servers/databases" + } + }, + "201": { + "body": { + "sku": { + "name": "BC_Gen4", + "tier": "BusinessCritical", + "family": "Gen4", + "capacity": 2 + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "earliestRestoreDate": "2017-06-07T04:51:33.937Z", + "maxSizeBytes": 1073741824, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "BC_Gen4_2", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "licenseType": "LicenseIncluded", + "maxLogSizeBytes": 104857600, + "readScale": "Enabled", + "storageAccountType": "GRS", + "zoneRedundant": false, + "currentSku": { + "name": "BC_Gen4", + "tier": "BusinessCritical", + "capacity": 2 + } + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateVCoreDatabaseBySkuNameCapacity.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateVCoreDatabaseBySkuNameCapacity.json new file mode 100644 index 000000000000..c799072075ae --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/CreateVCoreDatabaseBySkuNameCapacity.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "testdb", + "api-version": "2020-08-01-preview", + "parameters": { + "location": "southeastasia", + "sku": { + "name": "BC_Gen4", + "capacity": 2 + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "BC_Gen4", + "tier": "BusinessCritical", + "family": "Gen4", + "capacity": 2 + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "earliestRestoreDate": "2017-06-07T04:51:33.937Z", + "maxSizeBytes": 1073741824, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "BC_Gen4_2", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "licenseType": "LicenseIncluded", + "maxLogSizeBytes": 104857600, + "readScale": "Enabled", + "storageAccountType": "GRS", + "zoneRedundant": false, + "currentSku": { + "name": "BC_Gen4", + "tier": "BusinessCritical", + "capacity": 2 + } + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb", + "type": "Microsoft.Sql/servers/databases" + } + }, + "201": { + "body": { + "sku": { + "name": "BC_Gen4", + "tier": "BusinessCritical", + "family": "Gen4", + "capacity": 2 + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "earliestRestoreDate": "2017-06-07T04:51:33.937Z", + "maxSizeBytes": 1073741824, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "BC_Gen4_2", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "licenseType": "LicenseIncluded", + "maxLogSizeBytes": 104857600, + "readScale": "Enabled", + "storageAccountType": "GRS", + "zoneRedundant": false, + "currentSku": { + "name": "BC_Gen4", + "tier": "BusinessCritical", + "capacity": 2 + } + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/DeleteDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/DeleteDatabase.json new file mode 100644 index 000000000000..c70d7532b66e --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/DeleteDatabase.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "testdb", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolCreateOrUpdateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolCreateOrUpdateMax.json new file mode 100644 index 000000000000..ba7e28028aac --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolCreateOrUpdateMax.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-2369", + "serverName": "sqlcrudtest-8069", + "elasticPoolName": "sqlcrudtest-8102", + "api-version": "2017-10-01", + "parameters": { + "location": "Japan East", + "sku": { + "name": "GP_Gen4_2", + "tier": "GeneralPurpose", + "capacity": 2 + }, + "properties": { + "perDatabaseSettings": { + "minCapacity": 0.25, + "maxCapacity": 2.0 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102", + "name": "sqlcrudtest-8102", + "type": "Microsoft.Sql/servers/elasticPools", + "location": "Japan East", + "kind": null, + "sku": { + "name": "GP_Gen4_2", + "tier": "GeneralPurpose", + "capacity": 2 + }, + "properties": { + "creationDate": "2017-02-10T01:25:25.033Z", + "state": "Ready", + "maxSizeBytes": 5242880000, + "perDatabaseSettings": { + "minCapacity": 0.25, + "maxCapacity": 2.0 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102", + "name": "sqlcrudtest-8102", + "type": "Microsoft.Sql/servers/elasticPools", + "location": "Japan East", + "kind": null, + "sku": { + "name": "GP_Gen4_2", + "tier": "GeneralPurpose", + "capacity": 2 + }, + "properties": { + "creationDate": "2017-02-10T01:25:25.033Z", + "state": "Ready", + "maxSizeBytes": 5242880000, + "perDatabaseSettings": { + "minCapacity": 0.25, + "maxCapacity": 2.0 + } + } + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolCreateOrUpdateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolCreateOrUpdateMin.json new file mode 100644 index 000000000000..25f84bcd695a --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolCreateOrUpdateMin.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-2369", + "serverName": "sqlcrudtest-8069", + "elasticPoolName": "sqlcrudtest-8102", + "api-version": "2017-10-01", + "parameters": { + "location": "Japan East" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102", + "name": "sqlcrudtest-8102", + "type": "Microsoft.Sql/servers/elasticPools", + "location": "Japan East", + "kind": null, + "sku": { + "name": "StandardPool", + "tier": "Standard", + "capacity": 100 + }, + "properties": { + "creationDate": "2017-02-10T01:25:25.033Z", + "state": "Ready", + "maxSizeBytes": 102400, + "perDatabaseSettings": { + "minCapacity": 0, + "maxCapacity": 100 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102", + "name": "sqlcrudtest-8102", + "type": "Microsoft.Sql/servers/elasticPools", + "location": "Japan East", + "kind": null, + "sku": { + "name": "StandardPool", + "tier": "Standard", + "capacity": 100 + }, + "properties": { + "creationDate": "2017-02-10T01:25:25.033Z", + "state": "Ready", + "maxSizeBytes": 102400, + "perDatabaseSettings": { + "minCapacity": 0, + "maxCapacity": 100 + } + } + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolDelete.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolDelete.json new file mode 100644 index 000000000000..51394518bf8a --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-3129", + "serverName": "sqlcrudtest-228", + "elasticPoolName": "sqlcrudtest-3851", + "api-version": "2020-08-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolGet.json new file mode 100644 index 000000000000..cf45ef3e3f45 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-2369", + "serverName": "sqlcrudtest-8069", + "elasticPoolName": "sqlcrudtest-8102", + "api-version": "2020-08-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102", + "name": "sqlcrudtest-8102", + "type": "Microsoft.Sql/servers/elasticPools", + "location": "Japan East", + "kind": null, + "sku": { + "name": "GP_Gen5_2", + "tier": "GeneralPurpose", + "capacity": 2 + }, + "properties": { + "creationDate": "2017-10-10T01:25:25.033Z", + "state": "Ready", + "maxSizeBytes": 5242880000, + "perDatabaseSettings": { + "minCapacity": 0.25, + "maxCapacity": 1.0 + }, + "zoneRedundant": true, + "licenseType": "LicenseIncluded" + } + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolListByServer.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolListByServer.json new file mode 100644 index 000000000000..e0c9401d5e4a --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolListByServer.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-2369", + "serverName": "sqlcrudtest-8069", + "api-version": "2017-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-2729", + "name": "sqlcrudtest-2729", + "type": "Microsoft.Sql/servers/elasticPools", + "location": "Japan East", + "kind": null, + "sku": { + "name": "GP_Gen4_2", + "tier": "GeneralPurpose", + "capacity": 2 + }, + "properties": { + "creationDate": "2017-02-10T01:27:21.32Z", + "state": "Ready", + "maxSizeBytes": 5242880000, + "perDatabaseSettings": { + "minCapacity": 0.25, + "maxCapacity": 1.0 + }, + "zoneRedundant": true, + "licenseType": "LicenseIncluded" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-3191", + "name": "sqlcrudtest-3191", + "type": "Microsoft.Sql/servers/elasticPools", + "location": "Japan East", + "kind": null, + "sku": { + "name": "BasicPool", + "tier": "Basic", + "capacity": 50 + }, + "properties": { + "creationDate": "2017-02-10T01:26:26.45Z", + "state": "Ready", + "maxSizeBytes": 5242880000, + "perDatabaseSettings": { + "minCapacity": 0, + "maxCapacity": 5 + } + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102", + "name": "sqlcrudtest-8102", + "type": "Microsoft.Sql/servers/elasticPools", + "location": "Japan East", + "kind": null, + "sku": { + "name": "BasicPool", + "tier": "Basic", + "capacity": 50 + }, + "properties": { + "creationDate": "2017-02-10T01:25:25.033Z", + "state": "Ready", + "maxSizeBytes": 5242880000, + "perDatabaseSettings": { + "minCapacity": 0, + "maxCapacity": 5 + } + } + } + ] + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolUpdateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolUpdateMax.json new file mode 100644 index 000000000000..50ab53f4d887 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolUpdateMax.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-2369", + "serverName": "sqlcrudtest-8069", + "elasticPoolName": "sqlcrudtest-8102", + "api-version": "2017-10-01", + "parameters": { + "sku": { + "name": "BC_Gen4", + "tier": "BusinessCritical", + "capacity": 2 + }, + "properties": { + "perDatabaseSettings": { + "minCapacity": 0.25, + "maxCapacity": 1.0 + }, + "zoneRedundant": true, + "licenseType": "LicenseIncluded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102", + "name": "sqlcrudtest-8102", + "type": "Microsoft.Sql/servers/elasticPools", + "location": "Japan East", + "kind": null, + "sku": { + "name": "BC_Gen4", + "tier": "BusinessCritical", + "capacity": 2 + }, + "properties": { + "creationDate": "2017-02-10T01:27:21.32Z", + "state": "Ready", + "maxSizeBytes": 5242880000, + "perDatabaseSettings": { + "minCapacity": 0.25, + "maxCapacity": 1.0 + }, + "zoneRedundant": true, + "licenseType": "LicenseIncluded" + } + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolUpdateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolUpdateMin.json new file mode 100644 index 000000000000..798ef7b5c92e --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ElasticPoolUpdateMin.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-2369", + "serverName": "sqlcrudtest-8069", + "elasticPoolName": "sqlcrudtest-8102", + "api-version": "2017-10-01", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-2369/providers/Microsoft.Sql/servers/sqlcrudtest-8069/elasticPools/sqlcrudtest-8102", + "name": "sqlcrudtest-8102", + "type": "Microsoft.Sql/servers/elasticPools", + "location": "Japan East", + "kind": null, + "sku": { + "name": "BasicPool", + "tier": "Basic", + "capacity": 50 + }, + "properties": { + "creationDate": "2017-02-10T01:25:25.033Z", + "state": "Ready", + "maxSizeBytes": 5242880000, + "perDatabaseSettings": { + "minCapacity": 0, + "maxCapacity": 5 + } + } + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/FailoverDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/FailoverDatabase.json new file mode 100644 index 000000000000..c527b9727123 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/FailoverDatabase.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "group1", + "serverName": "testServer", + "databaseName": "testDatabase", + "replicaType": "Primary", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/FailoverElasticPool.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/FailoverElasticPool.json new file mode 100644 index 000000000000..0f1687215bf3 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/FailoverElasticPool.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "group1", + "serverName": "testServer", + "elasticPoolName": "testElasticPool", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/GetVCoreDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/GetVCoreDatabase.json new file mode 100644 index 000000000000..5b11ead71661 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/GetVCoreDatabase.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "testdb", + "api-version": "2020-08-01-preview" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "BC_Gen5", + "tier": "BusinessCritical", + "capacity": 2 + }, + "kind": "v12.0,user,vcore", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "BC_Gen5_2", + "requestedServiceObjectiveName": "BC_Gen5_2", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "licenseType": "LicenseIncluded", + "maxLogSizeBytes": 104857600, + "storageAccountType": "GRS", + "zoneRedundant": false, + "readScale": "Enabled", + "earliestRestoreDate": "2017-06-07T04:51:33.937Z", + "currentSku": { + "name": "BC_Gen5", + "tier": "BusinessCritical", + "capacity": 2 + } + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb", + "type": "Microsoft.Sql/servers/databases" + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ListDatabasesByElasticPool.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ListDatabasesByElasticPool.json new file mode 100644 index 000000000000..80fd7a64f5c8 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ListDatabasesByElasticPool.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "elasticPoolName": "pool1", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "ElasticPool", + "tier": "Standard" + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "elasticPoolId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/elasticPools/Pool1", + "status": "Online", + "databaseId": "bfe0735f-bc87-447f-b2c2-481f4b100614", + "creationDate": "2017-07-12T22:08:39.163Z", + "currentServiceObjectiveName": "ElasticPool", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/DB001", + "name": "DB001", + "type": "Microsoft.Sql/servers/databases" + }, + { + "sku": { + "name": "ElasticPool", + "tier": "Standard" + }, + "kind": "v12.0,user", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "elasticPoolId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/elasticPools/Pool1", + "status": "Online", + "databaseId": "82246152-3177-4357-b81c-a16d87ce3593", + "creationDate": "2017-07-12T22:10:10.773Z", + "currentServiceObjectiveName": "ElasticPool", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/DB002", + "name": "DB002", + "type": "Microsoft.Sql/servers/databases" + } + ] + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ListVCoreDatabasesByServer.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ListVCoreDatabasesByServer.json new file mode 100644 index 000000000000..06adab346f71 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ListVCoreDatabasesByServer.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "api-version": "2020-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "BC_Gen4", + "tier": "BusinessCritical", + "capacity": 2 + }, + "kind": "v12.0,user,vcore", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 268435456000, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "BC_Gen4_2", + "requestedServiceObjectiveName": "BC_Gen4_2", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "licenseType": "LicenseIncluded", + "maxLogSizeBytes": 104857600, + "storageAccountType": "GRS", + "zoneRedundant": false, + "readScale": "Enabled", + "earliestRestoreDate": "2017-06-07T04:51:33.937Z", + "currentSku": { + "name": "BC_Gen4", + "tier": "BusinessCritical", + "capacity": 2 + } + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb", + "type": "Microsoft.Sql/servers/databases" + }, + { + "sku": { + "name": "System0", + "tier": "System", + "capacity": 0 + }, + "kind": "v12.0,system", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 32212254720, + "status": "Online", + "databaseId": "e6be351f-2cc9-4604-9e52-b0b28b2710b0", + "creationDate": "2017-06-07T04:23:42.537Z", + "currentServiceObjectiveName": "System0", + "requestedServiceObjectiveName": "System0", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "storageAccountType": "GRS", + "zoneRedundant": false, + "readScale": "Disabled", + "currentSku": { + "name": "System0", + "tier": "System", + "capacity": 0 + } + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/master", + "name": "master", + "type": "Microsoft.Sql/servers/databases" + } + ] + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/PatchVCoreDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/PatchVCoreDatabase.json new file mode 100644 index 000000000000..7e9119481071 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/PatchVCoreDatabase.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "testdb", + "api-version": "2020-08-01-preview", + "parameters": { + "sku": { + "name": "BC_Gen4_4" + }, + "properties": { + "maxSizeBytes": 1073741824, + "licenseType": "LicenseIncluded" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "BC_Gen4", + "tier": "BusinessCritical", + "capacity": 4 + }, + "kind": "v12.0,user,vcore", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 1073741824, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-06-07T04:41:33.937Z", + "currentServiceObjectiveName": "BC_Gen4_2", + "requestedServiceObjectiveName": "BC_Gen4_2", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS", + "licenseType": "LicenseIncluded", + "maxLogSizeBytes": 104857600, + "storageAccountType": "GRS", + "zoneRedundant": false, + "readScale": "Enabled", + "earliestRestoreDate": "2017-06-07T04:51:33.937Z", + "currentSku": { + "name": "BC_Gen4", + "tier": "BusinessCritical", + "capacity": 4 + } + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/PauseDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/PauseDatabase.json new file mode 100644 index 000000000000..a2b0165e525b --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/PauseDatabase.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "testdwdb", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "DataWarehouse" + }, + "kind": "v12.0,user,datawarehouse", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 10995116277760, + "status": "Paused", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-07-13T02:04:26.187Z", + "currentServiceObjectiveName": "D1", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdwdb", + "name": "testdwdb", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/RenameDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/RenameDatabase.json new file mode 100644 index 000000000000..963ff8794aad --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/RenameDatabase.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "testdb", + "api-version": "2017-03-01-preview", + "parameters": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/newtestdb" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ResumeDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ResumeDatabase.json new file mode 100644 index 000000000000..19265add6d6b --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/ResumeDatabase.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "testdwdb", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "DataWarehouse" + }, + "kind": "v12.0,user,datawarehouse", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 10995116277760, + "status": "Online", + "databaseId": "6c764297-577b-470f-9af4-96d3d41e2ba3", + "creationDate": "2017-07-13T02:04:26.187Z", + "currentServiceObjectiveName": "D1", + "defaultSecondaryLocation": "North Europe", + "catalogCollation": "SQL_Latin1_General_CP1_CI_AS" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdwdb", + "name": "testdwdb", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/UpgradeDataWarehouse.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/UpgradeDataWarehouse.json new file mode 100644 index 000000000000..76aed8cca6eb --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-08-01-preview/examples/UpgradeDataWarehouse.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "serverName": "testsvr", + "databaseName": "testdwdb", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md index 697171636433..0682ecf919c1 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -485,6 +485,26 @@ override-info: The following packages are each composed of all apis from only one api-version. +### Tag: package-pure-2020-08-preview + +These settings apply only when `--tag=package-pure-2020-08-preview` is specified on the command line. + +This section contains all input swagger files for version 2020-08-01-preview. All APIs of that version must be added this section when the API is ready for production. + +APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. + +These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\preview\2020-08-01-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` + +``` yaml $(tag) == 'package-pure-2020-08-preview' +input-file: +- ./Microsoft.Sql/preview/2020-08-01-preview/databases.json +- ./Microsoft.Sql/preview/2020-08-01-preview/elasticPools.json + +# Needed when there is more than one input file +override-info: + title: SqlManagementClient + ``` + ### Tag: package-pure-2020-02-preview These settings apply only when `--tag=package-pure-2020-02-preview` is specified on the command line. From 9ac696a6329fe3ca6aa4dca347a65cc4845c36b0 Mon Sep 17 00:00:00 2001 From: rapatank <69176921+rapatank@users.noreply.github.com> Date: Sun, 20 Sep 2020 20:04:08 -0700 Subject: [PATCH 090/164] Powerplatformrp (#10849) * PowerPlatform RP specifications * PowerPlatform changes * Updating powerplatform json * Update definitions.json * Updating the schema * Updated the schema. * Updates to schema * Schema update * Schema update * Example update * Update description * Updating the swagger * Updating the swagger definition * Swagger update. * Swagger updates * Adding private link changes. * Updates to readme.md * Private link updates * Schema update * private link update * response update * Added systemData * Updated description. * Adding subnet configuration * readme update. * Adding systemData. * Updated example * Update * Update to systemData * Updates * Updates * Updated the version of common types * readme.go update * Update * Updated version * version update * update * update * Updated "enterprisePromise" to "enterprisePolicy". * Updates * Updates * Updating to use common type * updates * Update for lockbox * Update * update * update --- .../2020-10-30-preview/enterprisePolicy.json | 77 +++++++++++-------- 1 file changed, 45 insertions(+), 32 deletions(-) diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json index 677c74402f5c..be9705bbdfad 100644 --- a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json @@ -394,20 +394,58 @@ }, "definitions": { "EnterprisePolicy": { + "type": "object", + "description": "Definition of the EnterprisePolicy.", + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + } + ], "properties": { "identity": { "$ref": "#/definitions/EnterprisePolicyIdentity", "description": "The identity of the EnterprisePolicy." + }, + "properties": { + "$ref": "#/definitions/ConfigurationProperties", + "description": "The properties that define configuration.", + "x-ms-client-flatten": true } - }, - "allOf": [ - { - "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" + } + }, + "ConfigurationProperties": { + "type": "object", + "description": "The properties that define configuration for the enterprise policy.", + "properties": { + "lockbox": { + "type": "object", + "description": "Settings concerning lockbox.", + "properties": { + "status": { + "$ref": "#/definitions/status", + "description": "lockbox configuration" + } + } + }, + "encryption": { + "type": "object", + "description": "The encryption settings for a configuration store.", + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Key vault properties." + } + } + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource." } - ], - "description": "Definition of the EnterprisePolicy." + } }, "EnterprisePolicyIdentity": { + "type": "object", + "description": "The identity of the EnterprisePolicy.", "properties": { "systemAssignedIdentityPrincipalId": { "readOnly": true, @@ -430,33 +468,8 @@ "name": "ResourceIdentityType", "modelAsString": false } - }, - "lockbox": { - "type": "object", - "description": "Settings concerning lockbox.", - "properties": { - "status": { - "$ref": "#/definitions/status", - "description": "lockbox configuration" - } - } - }, - "encryption": { - "type": "object", - "description": "The encryption settings for a configuration store.", - "properties": { - "keyVaultProperties": { - "$ref": "#/definitions/KeyVaultProperties", - "description": "Key vault properties." - } - } - }, - "systemData": { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", - "description": "Metadata for the enterprisePolicy." } - }, - "description": "Identity for the EnterprisePolicy." + } }, "status": { "type": "string", From 0585f3ed2ee1b3fa6b38bf6751b61117222c0b01 Mon Sep 17 00:00:00 2001 From: Xiaoying Zhang Date: Mon, 21 Sep 2020 12:29:48 +0800 Subject: [PATCH 091/164] [datafactory] add support for azure databricks delta lake (#10794) --- .../2018-06-01/entityTypes/Dataset.json | 30 ++++++++ .../2018-06-01/entityTypes/LinkedService.json | 44 +++++++++++ .../2018-06-01/entityTypes/Pipeline.json | 76 +++++++++++++++++++ 3 files changed, 150 insertions(+) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json index 61a6bfadf4a7..e4541926b2ae 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json @@ -3249,6 +3249,36 @@ "description": "The name of the SharePoint Online list. Type: string (or Expression with resultType string)." } } + }, + "AzureDatabricksDeltaLakeDataset": { + "x-ms-discriminator-value": "AzureDatabricksDeltaLakeDataset", + "description": "Azure Databricks Delta Lake dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDatabricksDeltaLakeDatasetTypeProperties" + } + } + }, + "AzureDatabricksDeltaLakeDatasetTypeProperties": { + "description": "Azure Databricks Delta Lake Dataset Properties", + "properties": { + "table": { + "type": "object", + "description": "The name of delta table. Type: string (or Expression with resultType string)." + }, + "database": { + "type": "object", + "description": "The database name of delta table. Type: string (or Expression with resultType string)." + } + } } } } diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index a25553b01b00..11c8aca43d61 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -5322,6 +5322,50 @@ "accessToken" ] }, + "AzureDatabricksDeltaLakeLinkedService": { + "x-ms-discriminator-value": "AzureDatabricksDeltaLake", + "description": "Azure Databricks Delta Lake linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Databricks Delta Lake linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureDatabricksDetltaLakeLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureDatabricksDetltaLakeLinkedServiceTypeProperties": { + "description": "Azure Databricks Delta Lake linked service properties.", + "properties": { + "domain": { + "type": "object", + "description": ".azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string)." + }, + "accessToken": { + "description": "Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string, SecureString or AzureKeyVaultSecretReference.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "clusterId": { + "type": "object", + "description": "The id of an existing interactive cluster that will be used for all runs of this job. Type: string (or Expression with resultType string)." + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "domain" + ] + }, "ResponsysLinkedService": { "x-ms-discriminator-value": "Responsys", "description": "Responsys linked service.", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index be8062d5491d..91f6e3475c66 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -3621,6 +3621,82 @@ } } }, + "AzureDatabricksDeltaLakeSource": { + "description": "A copy activity Azure Databricks Delta Lake source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "Azure Databricks Delta Lake Sql query. Type: string (or Expression with resultType string)." + }, + "exportSettings": { + "$ref": "#/definitions/AzureDatabricksDeltaLakeExportCommand", + "description": "Azure Databricks Delta Lake export settings." + } + } + }, + "AzureDatabricksDeltaLakeExportCommand": { + "description": "Azure Databricks Delta Lake export command settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportSettings" + } + ], + "properties": { + "dateFormat": { + "type": "object", + "description": "Specify the date format for the csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string)." + }, + "timestampFormat": { + "type": "object", + "description": "Specify the timestamp format for the csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string)." + } + } + }, + "AzureDatabricksDeltaLakeSink": { + "description": "A copy activity Azure Databricks Delta Lake sink.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySink" + } + ], + "properties": { + "preCopyScript": { + "type": "object", + "description": "SQL pre-copy script. Type: string (or Expression with resultType string)." + }, + "importSettings": { + "$ref": "#/definitions/AzureDatabricksDeltaLakeImportCommand", + "description": "Azure Databricks Delta Lake import settings." + } + } + }, + "AzureDatabricksDeltaLakeImportCommand": { + "description": "Azure Databricks Delta Lake import command settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ImportSettings" + } + ], + "properties": { + "dateFormat": { + "type": "object", + "description": "Specify the date format for csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string)." + }, + "timestampFormat": { + "type": "object", + "description": "Specify the timestamp format for csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string)." + } + } + }, "StoredProcedureParameter": { "description": "SQL stored procedure parameter.", "type": "object", From 451997a2c7b7ba27196d46835af3311172371340 Mon Sep 17 00:00:00 2001 From: Jingshu923 <52914166+Jingshu923@users.noreply.github.com> Date: Mon, 21 Sep 2020 13:14:12 +0800 Subject: [PATCH 092/164] [Datafactory] update readme.md and DynamicsSinkWriteBehavior resolve the PR has python sdk break change (#10807) * [Datafactory] update readme.md and DynamicsSinkWriteBehavior * update python.md * Fix lint rule errors --- .../2018-06-01/entityTypes/DataFlow.json | 11 +++++ .../2018-06-01/entityTypes/Dataset.json | 11 +++++ .../entityTypes/IntegrationRuntime.json | 11 +++++ .../2018-06-01/entityTypes/LinkedService.json | 11 +++++ .../entityTypes/ManagedPrivateEndpoint.json | 11 +++++ .../entityTypes/ManagedVirtualNetwork.json | 11 +++++ .../2018-06-01/entityTypes/Pipeline.json | 49 ++++++++++--------- .../2018-06-01/entityTypes/Trigger.json | 11 +++++ .../datafactory/resource-manager/readme.md | 7 +++ .../resource-manager/readme.python.md | 1 + 10 files changed, 110 insertions(+), 24 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/DataFlow.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/DataFlow.json index bdac90ebf99b..63e8f1b14468 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/DataFlow.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/DataFlow.json @@ -4,6 +4,17 @@ "title": "DataFactoryManagementClient", "version": "2018-06-01" }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, "paths": {}, "definitions": { "DataFlow": { diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json index e4541926b2ae..a573ecd8bde4 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json @@ -4,6 +4,17 @@ "title": "DataFactoryManagementClient", "version": "2018-06-01" }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, "paths": {}, "definitions": { "Dataset": { diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json index fe1f683bd72c..00dbf932a1d5 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json @@ -4,6 +4,17 @@ "title": "DataFactoryManagementClient", "version": "2018-06-01" }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, "paths": {}, "definitions": { "IntegrationRuntime": { diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index 11c8aca43d61..ac022366955a 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -4,6 +4,17 @@ "title": "DataFactoryManagementClient", "version": "2018-06-01" }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, "paths": {}, "definitions": { "LinkedService": { diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/ManagedPrivateEndpoint.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/ManagedPrivateEndpoint.json index 2aa2ace47536..068ad1370cda 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/ManagedPrivateEndpoint.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/ManagedPrivateEndpoint.json @@ -4,6 +4,17 @@ "title": "DataFactoryManagementClient", "version": "2018-06-01" }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, "paths": {}, "definitions": { "ManagedPrivateEndpoint": { diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/ManagedVirtualNetwork.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/ManagedVirtualNetwork.json index e1a1e226c159..486abeced71c 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/ManagedVirtualNetwork.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/ManagedVirtualNetwork.json @@ -4,6 +4,17 @@ "title": "DataFactoryManagementClient", "version": "2018-06-01" }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, "paths": {}, "definitions": { "ManagedVirtualNetwork": { diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index 91f6e3475c66..ea95f8ea806d 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -4,6 +4,17 @@ "title": "DataFactoryManagementClient", "version": "2018-06-01" }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, "paths": {}, "definitions": { "Pipeline": { @@ -4507,6 +4518,17 @@ } } }, + "DynamicsSinkWriteBehavior": { + "description": "Defines values for DynamicsSinkWriteBehavior.", + "type": "string", + "enum": [ + "Upsert" + ], + "x-ms-enum": { + "name": "DynamicsSinkWriteBehavior", + "modelAsString": true + } + }, "DynamicsSink": { "description": "A copy activity Dynamics sink.", "type": "object", @@ -4518,14 +4540,7 @@ "properties": { "writeBehavior": { "description": "The write behavior for the operation.", - "type": "string", - "enum": [ - "Upsert" - ], - "x-ms-enum": { - "name": "DynamicsSinkWriteBehavior", - "modelAsString": true - } + "$ref": "#/definitions/DynamicsSinkWriteBehavior" }, "ignoreNullValues": { "type": "object", @@ -4551,14 +4566,7 @@ "properties": { "writeBehavior": { "description": "The write behavior for the operation.", - "type": "string", - "enum": [ - "Upsert" - ], - "x-ms-enum": { - "name": "DynamicsSinkWriteBehavior", - "modelAsString": true - } + "$ref": "#/definitions/DynamicsSinkWriteBehavior" }, "ignoreNullValues": { "type": "object", @@ -4584,14 +4592,7 @@ "properties": { "writeBehavior": { "description": "The write behavior for the operation.", - "type": "string", - "enum": [ - "Upsert" - ], - "x-ms-enum": { - "name": "DynamicsSinkWriteBehavior", - "modelAsString": true - } + "$ref": "#/definitions/DynamicsSinkWriteBehavior" }, "ignoreNullValues": { "type": "object", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json index 6423f41ed7d3..b9ff8cce6b89 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json @@ -4,6 +4,17 @@ "title": "DataFactoryManagementClient", "version": "2018-06-01" }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, "paths": {}, "definitions": { "Trigger": { diff --git a/specification/datafactory/resource-manager/readme.md b/specification/datafactory/resource-manager/readme.md index 73ba78baf313..764f413e92bb 100644 --- a/specification/datafactory/resource-manager/readme.md +++ b/specification/datafactory/resource-manager/readme.md @@ -37,6 +37,13 @@ These settings apply only when `--tag=package-2018-06` is specified on the comma ``` yaml $(tag) == 'package-2018-06' input-file: - Microsoft.DataFactory/stable/2018-06-01/datafactory.json +- Microsoft.DataFactory/stable/2018-06-01/entityTypes/DataFlow.json +- Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json +- Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json +- Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +- Microsoft.DataFactory/stable/2018-06-01/entityTypes/ManagedPrivateEndpoint.json +- Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +- Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json ``` ### Tag: package-2017-09-preview diff --git a/specification/datafactory/resource-manager/readme.python.md b/specification/datafactory/resource-manager/readme.python.md index 56d82b37fb7a..51f2c51d2ce3 100644 --- a/specification/datafactory/resource-manager/readme.python.md +++ b/specification/datafactory/resource-manager/readme.python.md @@ -9,6 +9,7 @@ python-mode: create python: azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 namespace: azure.mgmt.datafactory package-name: azure-mgmt-datafactory package-version: 1.0.0 From fce3400431eff281bddd04bed9727e63765b8da0 Mon Sep 17 00:00:00 2001 From: Kayden Wilkinson <69224099+Kawilki-M@users.noreply.github.com> Date: Sun, 20 Sep 2020 23:32:28 -0700 Subject: [PATCH 093/164] Removed object from NatGateway CreateOrUpdate Response (#10833) * Removed object from NatGateway CreateOrUpdate Response * fixed syntax * removed object from example response * ran prettier --- .../examples/NatGatewayCreateOrUpdate.json | 31 +------------------ .../stable/2020-06-01/natGateway.json | 5 +-- 2 files changed, 2 insertions(+), 34 deletions(-) diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-06-01/examples/NatGatewayCreateOrUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-06-01/examples/NatGatewayCreateOrUpdate.json index 4c4763daf114..fe1cc02b707c 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-06-01/examples/NatGatewayCreateOrUpdate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-06-01/examples/NatGatewayCreateOrUpdate.json @@ -84,35 +84,6 @@ "type": "Microsoft.Network/natGateways" } }, - "202": { - "body": { - "name": "test-natGateway", - "sku": { - "name": "Standard" - }, - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", - "location": "westus", - "properties": { - "idleTimeoutInMinutes": 5, - "provisioningState": "Succeeded", - "publicIpAddresses": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" - } - ], - "publicIpPrefixes": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" - } - ], - "subnets": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" - } - ] - }, - "type": "Microsoft.Network/natGateways" - } - } + "202": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-06-01/natGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-06-01/natGateway.json index 76240b24ca24..d2ad3c4d7d54 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-06-01/natGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-06-01/natGateway.json @@ -196,10 +196,7 @@ } }, "202": { - "description": "Accepted and the operation will complete asynchronously.", - "schema": { - "$ref": "#/definitions/NatGateway" - } + "description": "Accepted and the operation will complete asynchronously." }, "default": { "description": "Error response describing why the operation failed.", From fc8fba8a6e7d4ae9a95fab3c5e63dcae131aec08 Mon Sep 17 00:00:00 2001 From: danikaZ Date: Mon, 21 Sep 2020 02:23:02 -0700 Subject: [PATCH 094/164] Add private endpoint names for datasync (#10264) * Add private endpoint names for datasync * fix prettier formatting --- .../2019-06-01-preview/examples/SyncGroupCreate.json | 8 +++++--- .../2019-06-01-preview/examples/SyncGroupGet.json | 3 ++- .../examples/SyncGroupListByDatabase.json | 6 ++++-- .../2019-06-01-preview/examples/SyncGroupPatch.json | 5 +++-- .../2019-06-01-preview/examples/SyncGroupUpdate.json | 5 +++-- .../examples/SyncMemberCreate.json | 12 +++++++----- .../2019-06-01-preview/examples/SyncMemberGet.json | 7 ++++--- .../examples/SyncMemberListBySyncGroup.json | 5 +++-- .../2019-06-01-preview/examples/SyncMemberPatch.json | 7 ++++--- .../examples/SyncMemberUpdate.json | 12 +++++++----- .../preview/2019-06-01-preview/syncGroups.json | 5 +++++ .../preview/2019-06-01-preview/syncMembers.json | 5 +++++ 12 files changed, 52 insertions(+), 28 deletions(-) diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupCreate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupCreate.json index 8a6f8994ec21..4e3e8b72fcb9 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupCreate.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupCreate.json @@ -12,7 +12,7 @@ "conflictResolutionPolicy": "HubWin", "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328", "hubDatabaseUserName": "hubUser", - "usePrivateLinkConnection": false + "usePrivateLinkConnection": true } } }, @@ -26,7 +26,8 @@ "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328", "hubDatabaseUserName": "hubUser", "syncState": "NotReady", - "usePrivateLinkConnection": false + "usePrivateLinkConnection": true, + "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-3187" }, "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187", "name": "syncgroupcrud-3187", @@ -42,7 +43,8 @@ "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328", "hubDatabaseUserName": "hubUser", "syncState": "NotReady", - "usePrivateLinkConnection": false + "usePrivateLinkConnection": true, + "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-3187" }, "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187", "name": "syncgroupcrud-3187", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupGet.json index 8a88e81a9966..e6ef35ca3529 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupGet.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupGet.json @@ -17,7 +17,8 @@ "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328", "hubDatabaseUserName": "hubUser", "syncState": "NotReady", - "usePrivateLinkConnection": false + "usePrivateLinkConnection": true, + "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-3187" }, "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187", "name": "syncgroupcrud-3187", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupListByDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupListByDatabase.json index 4b6924abcdd7..1064d36aa5ff 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupListByDatabase.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupListByDatabase.json @@ -18,7 +18,8 @@ "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328", "hubDatabaseUserName": "hubUser", "syncState": "NotReady", - "usePrivateLinkConnection": false + "usePrivateLinkConnection": true, + "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-3187" }, "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187", "name": "syncgroupcrud-3187", @@ -32,7 +33,8 @@ "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328", "hubDatabaseUserName": "hubUser", "syncState": "NotReady", - "usePrivateLinkConnection": false + "usePrivateLinkConnection": true, + "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-5374" }, "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-5374", "name": "syncgroupcrud-5374", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupPatch.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupPatch.json index 9ac1bb8b2539..3422c3658d7a 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupPatch.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupPatch.json @@ -13,7 +13,7 @@ "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328", "hubDatabaseUserName": "hubUser", "hubDatabasePassword": "hubPassword", - "usePrivateLinkConnection": false + "usePrivateLinkConnection": true } } }, @@ -27,7 +27,8 @@ "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328", "hubDatabaseUserName": "hubUser", "syncState": "NotReady", - "usePrivateLinkConnection": false + "usePrivateLinkConnection": true, + "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-3187" }, "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187", "name": "syncgroup", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupUpdate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupUpdate.json index 8a6f8994ec21..f9b4510c13fc 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupUpdate.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncGroupUpdate.json @@ -12,7 +12,7 @@ "conflictResolutionPolicy": "HubWin", "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328", "hubDatabaseUserName": "hubUser", - "usePrivateLinkConnection": false + "usePrivateLinkConnection": true } } }, @@ -26,7 +26,8 @@ "syncDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328", "hubDatabaseUserName": "hubUser", "syncState": "NotReady", - "usePrivateLinkConnection": false + "usePrivateLinkConnection": true, + "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncgroupcrud-3187" }, "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-3521/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187", "name": "syncgroupcrud-3187", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberCreate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberCreate.json index 1ccc734d27a2..6fe4b6bfa44c 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberCreate.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberCreate.json @@ -5,7 +5,7 @@ "serverName": "syncgroupcrud-8475", "databaseName": "syncgroupcrud-4328", "syncGroupName": "syncgroupcrud-3187", - "syncMemberName": "syncgroupcrud-4879", + "syncMemberName": "syncmembercrud-4879", "api-version": "2019-06-01-preview", "parameters": { "properties": { @@ -30,10 +30,11 @@ "syncDirection": "Bidirectional", "syncState": "UnProvisioned", "usePrivateLinkConnection": true, + "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879", "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328" }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncgroupcrud-4879", - "name": "syncgroupcrud-4879", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879", + "name": "syncmembercrud-4879", "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers" } }, @@ -47,10 +48,11 @@ "syncDirection": "Bidirectional", "syncState": "UnProvisioned", "usePrivateLinkConnection": true, + "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879", "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328" }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncgroupcrud-4879", - "name": "syncgroupcrud-4879", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879", + "name": "syncmembercrud-4879", "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers" } }, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberGet.json index 8a1e356bfa96..a6a3c58866ce 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberGet.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberGet.json @@ -5,7 +5,7 @@ "serverName": "syncgroupcrud-8475", "databaseName": "syncgroupcrud-4328", "syncGroupName": "syncgroupcrud-3187", - "syncMemberName": "syncgroupcrud-4879", + "syncMemberName": "syncmembercrud-4879", "api-version": "2019-06-01-preview" }, "responses": { @@ -19,10 +19,11 @@ "syncDirection": "Bidirectional", "syncState": "UnProvisioned", "usePrivateLinkConnection": true, + "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879", "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328" }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncgroupcrud-4879", - "name": "syncgroupcrud-4879", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879", + "name": "syncmembercrud-4879", "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers" } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberListBySyncGroup.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberListBySyncGroup.json index 11497c9e4d7d..3c575b5481a4 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberListBySyncGroup.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberListBySyncGroup.json @@ -20,10 +20,11 @@ "syncDirection": "Bidirectional", "syncState": "UnProvisioned", "usePrivateLinkConnection": true, + "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879", "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328" }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncgroupcrud-4879", - "name": "syncgroupcrud-4879", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879", + "name": "syncmembercrud-4879", "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers" } ] diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberPatch.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberPatch.json index 1746bb5774c7..1bccaea25d3f 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberPatch.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberPatch.json @@ -5,7 +5,7 @@ "serverName": "syncgroupcrud-8475", "databaseName": "syncgroupcrud-4328", "syncGroupName": "syncgroupcrud-3187", - "syncMemberName": "syncgroupcrud-4879", + "syncMemberName": "syncmembercrud-4879", "api-version": "2019-06-01-preview", "parameters": { "properties": { @@ -30,10 +30,11 @@ "syncDirection": "Bidirectional", "syncState": "UnProvisioned", "usePrivateLinkConnection": true, + "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879", "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328" }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncgroupcrud-4879", - "name": "syncgroupcrud-4879", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879", + "name": "syncmembercrud-4879", "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers" } }, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberUpdate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberUpdate.json index 1ccc734d27a2..6fe4b6bfa44c 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberUpdate.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/SyncMemberUpdate.json @@ -5,7 +5,7 @@ "serverName": "syncgroupcrud-8475", "databaseName": "syncgroupcrud-4328", "syncGroupName": "syncgroupcrud-3187", - "syncMemberName": "syncgroupcrud-4879", + "syncMemberName": "syncmembercrud-4879", "api-version": "2019-06-01-preview", "parameters": { "properties": { @@ -30,10 +30,11 @@ "syncDirection": "Bidirectional", "syncState": "UnProvisioned", "usePrivateLinkConnection": true, + "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879", "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328" }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncgroupcrud-4879", - "name": "syncgroupcrud-4879", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879", + "name": "syncmembercrud-4879", "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers" } }, @@ -47,10 +48,11 @@ "syncDirection": "Bidirectional", "syncState": "UnProvisioned", "usePrivateLinkConnection": true, + "privateEndpointName": "PE_67FDBBD6-B2D8-4014-9CC6-C68ABBCFD481_syncmembercrud-4879", "syncMemberAzureDatabaseResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328" }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncgroupcrud-4879", - "name": "syncgroupcrud-4879", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/syncgroupcrud-65440/providers/Microsoft.Sql/servers/syncgroupcrud-8475/databases/syncgroupcrud-4328/syncGroups/syncgroupcrud-3187/syncMembers/syncmembercrud-4879", + "name": "syncmembercrud-4879", "type": "Microsoft.Sql/servers/databases/syncGroups/syncMembers" } }, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/syncGroups.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/syncGroups.json index ab80ff901950..442a8da5bfa8 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/syncGroups.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/syncGroups.json @@ -932,6 +932,11 @@ "usePrivateLinkConnection": { "description": "If use private link connection is enabled.", "type": "boolean" + }, + "privateEndpointName": { + "description": "Private endpoint name of the sync group if use private link connection is enabled.", + "type": "string", + "readOnly": true } } }, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/syncMembers.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/syncMembers.json index ba60112d1b74..dc905b399be8 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/syncMembers.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/syncMembers.json @@ -504,6 +504,11 @@ "description": "Whether to use private link connection.", "type": "boolean" }, + "privateEndpointName": { + "description": "Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure.", + "type": "string", + "readOnly": true + }, "serverName": { "description": "Server name of the member database in the sync member", "type": "string" From f64d232ce9d05ca4cb06c2ef319df501890e2327 Mon Sep 17 00:00:00 2001 From: changlong-liu <59815250+changlong-liu@users.noreply.github.com> Date: Mon, 21 Sep 2020 17:49:31 +0800 Subject: [PATCH 095/164] track2 GA (#10778) --- documentation/code-gen/configure-python-sdk.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/documentation/code-gen/configure-python-sdk.md b/documentation/code-gen/configure-python-sdk.md index 503f5acb1ec0..ad14782c78e2 100644 --- a/documentation/code-gen/configure-python-sdk.md +++ b/documentation/code-gen/configure-python-sdk.md @@ -86,7 +86,8 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python // for track1 SDK + - repo: azure-sdk-for-python-track2 // for track2 SDK - ... @@ -226,12 +227,13 @@ After configure all the readme files, autorest can be used to generate SDK. Track1 SDK is based on AutoRest version V2 that's going to be replaced by version V3. ~~~ -autorest --keep-version-file --multiapi --no-async --python --python-mode=update --python-sdks-folder=C:\ZZ\projects\codegen\azure-sdk-for-python\sdk --use=@microsoft.azure/autorest.python@~4.0.71 --version=V2 ..\azure-rest-api-specs\specification\appconfiguration\resource-manager\readme.md +> autorest --keep-version-file --multiapi --no-async --python --python-mode=update --python-sdks-folder=C:\ZZ\projects\codegen\azure-sdk-for-python\sdk --use=@microsoft.azure/autorest.python@~4.0.71 --version=V2 ..\azure-rest-api-specs\specification\appconfiguration\resource-manager\readme.md ~~~ ### Track2 (for latest Autorest) Track 2 is based on the latest AutoRest code generator ~~~ -autorest --python --track2 --use=@autorest/python@5.1.0-preview.4 --python-sdks-folder=..\azure-sdk-for-python\sdk --multiapi --python-mode=update ..\azure-rest-api-specs\specification\appconfiguration\resource-manager\readme.md +> autorest --reset +> autorest --python --track2 --use=@autorest/python@5.3.0 --python-sdks-folder=..\azure-sdk-for-python\sdk --multiapi --python-mode=update ..\azure-rest-api-specs\specification\appconfiguration\resource-manager\readme.md ~~~ \ No newline at end of file From 88986734626dd8b11b0a11b3cbb32cfdf3196c36 Mon Sep 17 00:00:00 2001 From: rapatank <69176921+rapatank@users.noreply.github.com> Date: Mon, 21 Sep 2020 05:50:46 -0700 Subject: [PATCH 096/164] Powerplatformrp (#10852) * PowerPlatform RP specifications * PowerPlatform changes * Updating powerplatform json * Update definitions.json * Updating the schema * Updated the schema. * Updates to schema * Schema update * Schema update * Example update * Update description * Updating the swagger * Updating the swagger definition * Swagger update. * Swagger updates * Adding private link changes. * Updates to readme.md * Private link updates * Schema update * private link update * response update * Added systemData * Updated description. * Adding subnet configuration * readme update. * Adding systemData. * Updated example * Update * Update to systemData * Updates * Updates * Updated the version of common types * readme.go update * Update * Updated version * version update * update * update * Updated "enterprisePromise" to "enterprisePolicy". * Updates * Updates * Updating to use common type * updates * Update for lockbox * Update * update * update * update * update * update * update --- .../preview/2020-10-30-preview/enterprisePolicy.json | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json index be9705bbdfad..b9b6ba659420 100644 --- a/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json +++ b/specification/powerplatform/resource-manager/Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json @@ -398,6 +398,7 @@ "description": "Definition of the EnterprisePolicy.", "allOf": [ { + "description": "The resource model definition for a ARM tracked top level resource.", "$ref": "../../common/v1/definitions.json#/definitions/TrackedResource" } ], @@ -407,13 +408,13 @@ "description": "The identity of the EnterprisePolicy." }, "properties": { - "$ref": "#/definitions/ConfigurationProperties", - "description": "The properties that define configuration.", + "$ref": "#/definitions/Properties", + "description": "The properties that define configuration for the enterprise policy", "x-ms-client-flatten": true } } }, - "ConfigurationProperties": { + "Properties": { "type": "object", "description": "The properties that define configuration for the enterprise policy.", "properties": { From 2cb80cf6668074c84cf02cf45b6bb897eff47e9b Mon Sep 17 00:00:00 2001 From: paornela <70660621+paornela@users.noreply.github.com> Date: Mon, 21 Sep 2020 10:48:32 -0700 Subject: [PATCH 097/164] [Hub Generated] Review request for Microsoft.CostManagement to add version stable/2020-06-01 (#10727) * Creating separate swagger file for exports * add exports swagger to readme * edit api version * add "TheLast7Days" to exports timeframes * remove 'TheLast7Days' from export timeframes * prettier fix * prettier fix 2 --- .../2020-06-01/costmanagement.exports.json | 1139 +++++++++++++++++ .../stable/2020-06-01/costmanagement.json | 747 ----------- .../resource-manager/readme.md | 1 + 3 files changed, 1140 insertions(+), 747 deletions(-) create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/costmanagement.exports.json diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/costmanagement.exports.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/costmanagement.exports.json new file mode 100644 index 000000000000..6f5153b995a9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/costmanagement.exports.json @@ -0,0 +1,1139 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-06-01", + "title": "CostManagementClient" + }, + "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": { + "/{scope}/providers/Microsoft.CostManagement/exports": { + "get": { + "tags": [ + "Exports" + ], + "operationId": "Exports_List", + "description": "The operation to list all exports at the given scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportsGetBySubscription": { + "$ref": "./examples/ExportsGetBySubscription.json" + }, + "ExportsGetByResourceGroup": { + "$ref": "./examples/ExportsGetByResourceGroup.json" + }, + "ExportsGetByBillingAccount": { + "$ref": "./examples/ExportsGetByBillingAccount.json" + }, + "ExportsGetByDepartment": { + "$ref": "./examples/ExportsGetByDepartment.json" + }, + "ExportsGetByEnrollmentAccount": { + "$ref": "./examples/ExportsGetByEnrollmentAccount.json" + }, + "ExportsGetByManagementGroup": { + "$ref": "./examples/ExportsGetByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeExportParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties within an export. Currently only 'runHistory' is supported and will return information for the last execution of each export.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ExportListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}": { + "get": { + "tags": [ + "Exports" + ], + "operationId": "Exports_Get", + "description": "The operation to get the export for the defined scope by export name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportGetBySubscription": { + "$ref": "./examples/ExportGetBySubscription.json" + }, + "ExportGetByResourceGroup": { + "$ref": "./examples/ExportGetByResourceGroup.json" + }, + "ExportGetByBillingAccount": { + "$ref": "./examples/ExportGetByBillingAccount.json" + }, + "ExportGetByDepartment": { + "$ref": "./examples/ExportGetByDepartment.json" + }, + "ExportGetByEnrollmentAccount": { + "$ref": "./examples/ExportGetByEnrollmentAccount.json" + }, + "ExportGetByManagementGroup": { + "$ref": "./examples/ExportGetByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeExportParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties within an export. Currently only 'runHistory' is supported and will return information for the last 10 executions of the export.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Export" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Exports" + ], + "operationId": "Exports_CreateOrUpdate", + "description": "The operation to create or update a export. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportCreateOrUpdateBySubscription": { + "$ref": "./examples/ExportCreateOrUpdateBySubscription.json" + }, + "ExportCreateOrUpdateByResourceGroup": { + "$ref": "./examples/ExportCreateOrUpdateByResourceGroup.json" + }, + "ExportCreateOrUpdateByBillingAccount": { + "$ref": "./examples/ExportCreateOrUpdateByBillingAccount.json" + }, + "ExportCreateOrUpdateByDepartment": { + "$ref": "./examples/ExportCreateOrUpdateByDepartment.json" + }, + "ExportCreateOrUpdateByEnrollmentAccount": { + "$ref": "./examples/ExportCreateOrUpdateByEnrollmentAccount.json" + }, + "ExportCreateOrUpdateByManagementGroup": { + "$ref": "./examples/ExportCreateOrUpdateByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeExportParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Export" + }, + "description": "Parameters supplied to the CreateOrUpdate Export operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Export" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/Export" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Exports" + ], + "operationId": "Exports_Delete", + "description": "The operation to delete a export.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportDeleteBySubscription": { + "$ref": "./examples/ExportDeleteBySubscription.json" + }, + "ExportDeleteByResourceGroup": { + "$ref": "./examples/ExportDeleteByResourceGroup.json" + }, + "ExportDeleteByBillingAccount": { + "$ref": "./examples/ExportDeleteByBillingAccount.json" + }, + "ExportDeleteByEnrollmentAccount": { + "$ref": "./examples/ExportDeleteByEnrollmentAccount.json" + }, + "ExportDeleteByDepartment": { + "$ref": "./examples/ExportDeleteByDepartment.json" + }, + "ExportDeleteByManagementGroup": { + "$ref": "./examples/ExportDeleteByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeExportParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run": { + "post": { + "tags": [ + "Exports" + ], + "operationId": "Exports_Execute", + "description": "The operation to execute an export.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportRunBySubscription": { + "$ref": "./examples/ExportRunBySubscription.json" + }, + "ExportRunByResourceGroup": { + "$ref": "./examples/ExportRunByResourceGroup.json" + }, + "ExportRunByBillingAccount": { + "$ref": "./examples/ExportRunByBillingAccount.json" + }, + "ExportRunByDepartment": { + "$ref": "./examples/ExportRunByDepartment.json" + }, + "ExportRunByEnrollmentAccount": { + "$ref": "./examples/ExportRunByEnrollmentAccount.json" + }, + "ExportRunByManagementGroup": { + "$ref": "./examples/ExportRunByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeExportParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory": { + "get": { + "tags": [ + "Exports" + ], + "operationId": "Exports_GetExecutionHistory", + "description": "The operation to get the execution history of an export for the defined scope and export name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportRunHistoryGetBySubscription": { + "$ref": "./examples/ExportRunHistoryGetBySubscription.json" + }, + "ExportRunHistoryGetByResourceGroup": { + "$ref": "./examples/ExportRunHistoryGetByResourceGroup.json" + }, + "ExportRunHistoryGetByBillingAccount": { + "$ref": "./examples/ExportRunHistoryGetByBillingAccount.json" + }, + "ExportRunHistoryGetByDepartment": { + "$ref": "./examples/ExportRunHistoryGetByDepartment.json" + }, + "ExportRunHistoryGetByEnrollmentAccount": { + "$ref": "./examples/ExportRunHistoryGetByEnrollmentAccount.json" + }, + "ExportRunHistoryGetByManagementGroup": { + "$ref": "./examples/ExportRunHistoryGetByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeExportParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ExportExecutionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ReportConfigDefinition": { + "description": "The definition of a report config.", + "properties": { + "type": { + "description": "The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates.", + "type": "string", + "enum": [ + "Usage" + ], + "x-ms-enum": { + "name": "ReportType", + "modelAsString": true + } + }, + "timeframe": { + "description": "The time frame for pulling data for the report. If custom, then a specific time period must be provided.", + "type": "string", + "enum": [ + "WeekToDate", + "MonthToDate", + "YearToDate", + "Custom" + ], + "x-ms-enum": { + "name": "ReportTimeframeType", + "modelAsString": true + } + }, + "timePeriod": { + "description": "Has time period for pulling data for the report.", + "$ref": "#/definitions/ReportConfigTimePeriod" + }, + "dataset": { + "description": "Has definition for data in this report config.", + "$ref": "#/definitions/ReportConfigDataset" + } + }, + "required": [ + "type", + "timeframe" + ] + }, + "ReportConfigTimePeriod": { + "description": "The start and end date for pulling data for the report.", + "properties": { + "from": { + "description": "The start date to pull data from.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date to pull data to.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from", + "to" + ] + }, + "ReportConfigDataset": { + "description": "The definition of data present in the report.", + "properties": { + "granularity": { + "description": "The granularity of rows in the report.", + "type": "string", + "enum": [ + "Daily", + "Monthly" + ], + "x-ms-enum": { + "name": "ReportGranularityType", + "modelAsString": true + } + }, + "configuration": { + "description": "Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided.", + "$ref": "#/definitions/ReportConfigDatasetConfiguration" + }, + "aggregation": { + "type": "object", + "description": "Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses.", + "additionalProperties": { + "type": "object", + "$ref": "#/definitions/ReportConfigAggregation" + }, + "maxItems": 2 + }, + "grouping": { + "description": "Array of group by expression to use in the report. Report can have up to 2 group by clauses.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigGrouping" + }, + "maxItems": 2 + }, + "sorting": { + "description": "Array of order by expression to use in the report.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigSorting" + } + }, + "filter": { + "type": "object", + "description": "Has filter expression to use in the report.", + "$ref": "#/definitions/ReportConfigFilter" + } + } + }, + "ReportConfigDatasetConfiguration": { + "description": "The configuration of dataset in the report.", + "properties": { + "columns": { + "description": "Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ReportConfigAggregation": { + "description": "The aggregation expression to be used in the report.", + "properties": { + "name": { + "description": "The name of the column to aggregate.", + "type": "string" + }, + "function": { + "description": "The name of the aggregation function to use.", + "type": "string", + "enum": [ + "Sum" + ], + "x-ms-enum": { + "name": "FunctionType", + "modelAsString": true + } + } + }, + "required": [ + "name", + "function" + ] + }, + "ReportConfigSorting": { + "description": "The order by expression to be used in the report.", + "properties": { + "direction": { + "description": "Direction of sort.", + "type": "string", + "enum": [ + "Ascending", + "Descending" + ] + }, + "name": { + "description": "The name of the column to sort.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "ReportConfigGrouping": { + "description": "The group by expression to be used in the report.", + "properties": { + "type": { + "description": "Has type of the column to group.", + "$ref": "#/definitions/ReportConfigColumnType" + }, + "name": { + "description": "The name of the column to group. This version supports subscription lowest possible grain.", + "type": "string" + } + }, + "required": [ + "type", + "name" + ] + }, + "ReportConfigFilter": { + "description": "The filter expression to be used in the report.", + "properties": { + "and": { + "description": "The logical \"AND\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigFilter" + }, + "minItems": 2 + }, + "or": { + "description": "The logical \"OR\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigFilter" + }, + "minItems": 2 + }, + "not": { + "description": "The logical \"NOT\" expression.", + "$ref": "#/definitions/ReportConfigFilter" + }, + "dimension": { + "description": "Has comparison expression for a dimension", + "$ref": "#/definitions/ReportConfigComparisonExpression" + }, + "tag": { + "description": "Has comparison expression for a tag", + "$ref": "#/definitions/ReportConfigComparisonExpression" + } + } + }, + "ReportConfigColumnType": { + "description": "The type of the column in the report.", + "type": "string", + "enum": [ + "Tag", + "Dimension" + ], + "x-ms-enum": { + "name": "ReportConfigColumnType", + "modelAsString": true + } + }, + "ReportConfigComparisonExpression": { + "description": "The comparison expression to be used in the report.", + "properties": { + "name": { + "description": "The name of the column to use in comparison.", + "type": "string" + }, + "operator": { + "description": "The operator to use for comparison.", + "type": "string", + "enum": [ + "In", + "Contains" + ], + "x-ms-enum": { + "name": "OperatorType", + "modelAsString": true + } + }, + "values": { + "description": "Array of values to use for comparison", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "name", + "operator", + "values" + ] + }, + "ErrorResponse": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. \n\nSome Error responses: \n\n * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the \"x-ms-ratelimit-microsoft.consumption-retry-after\" header. \n\n * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the \"Retry-After\" header.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "ErrorDetails": { + "description": "The details of the error.", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + } + } + }, + "Resource": { + "description": "The Resource model definition.", + "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." + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "x-ms-azure-resource": true + }, + "ProxyResource": { + "description": "The Resource model definition.", + "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." + }, + "eTag": { + "type": "string", + "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not." + } + }, + "x-ms-azure-resource": true + }, + "ExportListResult": { + "description": "Result of listing exports. It contains a list of available exports in the scope provided.", + "type": "object", + "properties": { + "value": { + "description": "The list of exports.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Export" + } + } + } + }, + "Export": { + "description": "An export resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExportProperties", + "title": "Export properties" + } + } + }, + "ExportProperties": { + "description": "The properties of the export.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CommonExportProperties" + } + ], + "properties": { + "schedule": { + "description": "Has schedule information for the export.", + "$ref": "#/definitions/ExportSchedule" + } + } + }, + "CommonExportProperties": { + "description": "The common properties of the export.", + "type": "object", + "properties": { + "format": { + "description": "The format of the export being delivered. Currently only 'Csv' is supported.", + "type": "string", + "enum": [ + "Csv" + ], + "x-ms-enum": { + "name": "FormatType", + "modelAsString": true + } + }, + "deliveryInfo": { + "description": "Has delivery information for the export.", + "$ref": "#/definitions/ExportDeliveryInfo" + }, + "definition": { + "description": "Has the definition for the export.", + "$ref": "#/definitions/ExportDefinition" + }, + "runHistory": { + "description": "If requested, has the most recent execution history for the export.", + "$ref": "#/definitions/ExportExecutionListResult" + }, + "nextRunTimeEstimate": { + "description": "If the export has an active schedule, provides an estimate of the next execution time.", + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "required": [ + "deliveryInfo", + "definition" + ] + }, + "ExportSchedule": { + "description": "The schedule associated with the export.", + "type": "object", + "properties": { + "status": { + "description": "The status of the export's schedule. If 'Inactive', the export's schedule is paused.", + "type": "string", + "enum": [ + "Active", + "Inactive" + ], + "x-ms-enum": { + "name": "StatusType", + "modelAsString": true + } + }, + "recurrence": { + "description": "The schedule recurrence.", + "type": "string", + "enum": [ + "Daily", + "Weekly", + "Monthly", + "Annually" + ], + "x-ms-enum": { + "name": "RecurrenceType", + "modelAsString": true + } + }, + "recurrencePeriod": { + "description": "Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date.", + "$ref": "#/definitions/ExportRecurrencePeriod" + } + }, + "required": [ + "recurrence" + ] + }, + "ExportDeliveryInfo": { + "description": "The delivery information associated with a export.", + "type": "object", + "properties": { + "destination": { + "description": "Has destination for the export being delivered.", + "$ref": "#/definitions/ExportDeliveryDestination" + } + }, + "required": [ + "destination" + ] + }, + "ExportRecurrencePeriod": { + "description": "The start and end date for recurrence schedule.", + "type": "object", + "properties": { + "from": { + "description": "The start date of recurrence.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date of recurrence.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from" + ] + }, + "ExportDeliveryDestination": { + "description": "The destination information for the delivery of the export. To allow access to a storage account, you must register the account's subscription with the Microsoft.CostManagementExports resource provider. This is required once per subscription. When creating an export in the Azure portal, it is done automatically, however API users need to register the subscription. For more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services .", + "type": "object", + "properties": { + "resourceId": { + "description": "The resource id of the storage account where exports will be delivered.", + "type": "string" + }, + "container": { + "description": "The name of the container where exports will be uploaded.", + "type": "string" + }, + "rootFolderPath": { + "description": "The name of the directory where exports will be uploaded.", + "type": "string" + } + }, + "required": [ + "resourceId", + "container" + ] + }, + "ExportDefinition": { + "description": "The definition of an export.", + "type": "object", + "properties": { + "type": { + "description": "The type of the export. Note that 'Usage' is equivalent to 'ActualCost' and is applicable to exports that do not yet provide data for charges or amortization for service reservations.", + "type": "string", + "enum": [ + "Usage", + "ActualCost", + "AmortizedCost" + ], + "x-ms-enum": { + "name": "ExportType", + "modelAsString": true + } + }, + "timeframe": { + "description": "The time frame for pulling data for the export. If custom, then a specific time period must be provided.", + "type": "string", + "enum": [ + "MonthToDate", + "BillingMonthToDate", + "TheLastMonth", + "TheLastBillingMonth", + "WeekToDate", + "Custom" + ], + "x-ms-enum": { + "name": "TimeframeType", + "modelAsString": true + } + }, + "timePeriod": { + "description": "Has time period for pulling data for the export.", + "$ref": "#/definitions/ExportTimePeriod" + }, + "dataSet": { + "description": "The definition for data in the export.", + "$ref": "#/definitions/ExportDataset" + } + }, + "required": [ + "type", + "timeframe" + ] + }, + "ExportDataset": { + "description": "The definition for data in the export.", + "type": "object", + "properties": { + "granularity": { + "description": "The granularity of rows in the export. Currently only 'Daily' is supported.", + "type": "string", + "enum": [ + "Daily" + ], + "x-ms-enum": { + "name": "GranularityType", + "modelAsString": true + } + }, + "configuration": { + "description": "The export dataset configuration.", + "$ref": "#/definitions/ExportDatasetConfiguration" + } + } + }, + "ExportDatasetConfiguration": { + "description": "The export dataset configuration. Allows columns to be selected for the export. If not provided then the export will include all available columns.", + "type": "object", + "properties": { + "columns": { + "description": "Array of column names to be included in the export. If not provided then the export will include all available columns. The available columns can vary by customer channel (see examples).", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ExportTimePeriod": { + "description": "The date range for data in the export. This should only be specified with timeFrame set to 'Custom'. The maximum date range is 3 months.", + "type": "object", + "properties": { + "from": { + "description": "The start date for export data.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date for export data.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from", + "to" + ] + }, + "ExportExecutionListResult": { + "description": "Result of listing the execution history of an export.", + "type": "object", + "properties": { + "value": { + "description": "A list of export executions.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ExportExecution" + } + } + } + }, + "ExportExecution": { + "description": "An export execution.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExportExecutionProperties", + "title": "Export execution properties" + } + } + }, + "ExportExecutionProperties": { + "description": "The properties of the export execution.", + "type": "object", + "properties": { + "executionType": { + "description": "The type of the export execution.", + "type": "string", + "enum": [ + "OnDemand", + "Scheduled" + ], + "x-ms-enum": { + "name": "ExecutionType", + "modelAsString": true + } + }, + "status": { + "description": "The last known status of the export execution.", + "type": "string", + "enum": [ + "Queued", + "InProgress", + "Completed", + "Failed", + "Timeout", + "NewDataNotAvailable", + "DataNotAvailable" + ], + "x-ms-enum": { + "name": "ExecutionStatus", + "modelAsString": true + } + }, + "submittedBy": { + "description": "The identifier for the entity that executed the export. For OnDemand executions it is the user email. For scheduled executions it is 'System'.", + "type": "string" + }, + "submittedTime": { + "description": "The time when export was queued to be executed.", + "type": "string", + "format": "date-time" + }, + "processingStartTime": { + "description": "The time when export was picked up to be executed.", + "type": "string", + "format": "date-time" + }, + "processingEndTime": { + "description": "The time when the export execution finished.", + "type": "string", + "format": "date-time" + }, + "fileName": { + "description": "The name of the exported file.", + "type": "string" + }, + "runSettings": { + "description": "The export settings that were in effect for this execution.", + "$ref": "#/definitions/CommonExportProperties" + }, + "error": { + "description": "The details of any error.", + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. The current version is 2020-06-01." + }, + "scopeExportParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with export operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "exportNameParameter": { + "name": "exportName", + "in": "path", + "description": "Export Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/costmanagement.json index b08ae42f80d7..1bf76b2ce885 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/costmanagement.json @@ -1098,364 +1098,6 @@ } } }, - "/{scope}/providers/Microsoft.CostManagement/exports": { - "get": { - "tags": [ - "Exports" - ], - "operationId": "Exports_List", - "description": "The operation to list all exports at the given scope.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "ExportsGetBySubscription": { - "$ref": "./examples/ExportsGetBySubscription.json" - }, - "ExportsGetByResourceGroup": { - "$ref": "./examples/ExportsGetByResourceGroup.json" - }, - "ExportsGetByBillingAccount": { - "$ref": "./examples/ExportsGetByBillingAccount.json" - }, - "ExportsGetByDepartment": { - "$ref": "./examples/ExportsGetByDepartment.json" - }, - "ExportsGetByEnrollmentAccount": { - "$ref": "./examples/ExportsGetByEnrollmentAccount.json" - }, - "ExportsGetByManagementGroup": { - "$ref": "./examples/ExportsGetByManagementGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeQueryParameter" - }, - { - "$ref": "#/parameters/apiVersion20200601Parameter" - }, - { - "name": "$expand", - "description": "May be used to expand the properties within an export. Currently only 'runHistory' is supported and will return information for the last execution of each export.", - "in": "query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/ExportListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}": { - "get": { - "tags": [ - "Exports" - ], - "operationId": "Exports_Get", - "description": "The operation to get the export for the defined scope by export name.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "ExportGetBySubscription": { - "$ref": "./examples/ExportGetBySubscription.json" - }, - "ExportGetByResourceGroup": { - "$ref": "./examples/ExportGetByResourceGroup.json" - }, - "ExportGetByBillingAccount": { - "$ref": "./examples/ExportGetByBillingAccount.json" - }, - "ExportGetByDepartment": { - "$ref": "./examples/ExportGetByDepartment.json" - }, - "ExportGetByEnrollmentAccount": { - "$ref": "./examples/ExportGetByEnrollmentAccount.json" - }, - "ExportGetByManagementGroup": { - "$ref": "./examples/ExportGetByManagementGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeQueryParameter" - }, - { - "$ref": "#/parameters/apiVersion20200601Parameter" - }, - { - "$ref": "#/parameters/exportNameParameter" - }, - { - "name": "$expand", - "description": "May be used to expand the properties within an export. Currently only 'runHistory' is supported and will return information for the last 10 executions of the export.", - "in": "query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/Export" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "tags": [ - "Exports" - ], - "operationId": "Exports_CreateOrUpdate", - "description": "The operation to create or update a export. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "ExportCreateOrUpdateBySubscription": { - "$ref": "./examples/ExportCreateOrUpdateBySubscription.json" - }, - "ExportCreateOrUpdateByResourceGroup": { - "$ref": "./examples/ExportCreateOrUpdateByResourceGroup.json" - }, - "ExportCreateOrUpdateByBillingAccount": { - "$ref": "./examples/ExportCreateOrUpdateByBillingAccount.json" - }, - "ExportCreateOrUpdateByDepartment": { - "$ref": "./examples/ExportCreateOrUpdateByDepartment.json" - }, - "ExportCreateOrUpdateByEnrollmentAccount": { - "$ref": "./examples/ExportCreateOrUpdateByEnrollmentAccount.json" - }, - "ExportCreateOrUpdateByManagementGroup": { - "$ref": "./examples/ExportCreateOrUpdateByManagementGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeQueryParameter" - }, - { - "$ref": "#/parameters/apiVersion20200601Parameter" - }, - { - "$ref": "#/parameters/exportNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Export" - }, - "description": "Parameters supplied to the CreateOrUpdate Export operation." - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/Export" - } - }, - "201": { - "description": "Created.", - "schema": { - "$ref": "#/definitions/Export" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Exports" - ], - "operationId": "Exports_Delete", - "description": "The operation to delete a export.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "ExportDeleteBySubscription": { - "$ref": "./examples/ExportDeleteBySubscription.json" - }, - "ExportDeleteByResourceGroup": { - "$ref": "./examples/ExportDeleteByResourceGroup.json" - }, - "ExportDeleteByBillingAccount": { - "$ref": "./examples/ExportDeleteByBillingAccount.json" - }, - "ExportDeleteByEnrollmentAccount": { - "$ref": "./examples/ExportDeleteByEnrollmentAccount.json" - }, - "ExportDeleteByDepartment": { - "$ref": "./examples/ExportDeleteByDepartment.json" - }, - "ExportDeleteByManagementGroup": { - "$ref": "./examples/ExportDeleteByManagementGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeQueryParameter" - }, - { - "$ref": "#/parameters/apiVersion20200601Parameter" - }, - { - "$ref": "#/parameters/exportNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run": { - "post": { - "tags": [ - "Exports" - ], - "operationId": "Exports_Execute", - "description": "The operation to execute an export.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "ExportRunBySubscription": { - "$ref": "./examples/ExportRunBySubscription.json" - }, - "ExportRunByResourceGroup": { - "$ref": "./examples/ExportRunByResourceGroup.json" - }, - "ExportRunByBillingAccount": { - "$ref": "./examples/ExportRunByBillingAccount.json" - }, - "ExportRunByDepartment": { - "$ref": "./examples/ExportRunByDepartment.json" - }, - "ExportRunByEnrollmentAccount": { - "$ref": "./examples/ExportRunByEnrollmentAccount.json" - }, - "ExportRunByManagementGroup": { - "$ref": "./examples/ExportRunByManagementGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeQueryParameter" - }, - { - "$ref": "#/parameters/apiVersion20200601Parameter" - }, - { - "$ref": "#/parameters/exportNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory": { - "get": { - "tags": [ - "Exports" - ], - "operationId": "Exports_GetExecutionHistory", - "description": "The operation to get the execution history of an export for the defined scope and export name.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" - }, - "x-ms-examples": { - "ExportRunHistoryGetBySubscription": { - "$ref": "./examples/ExportRunHistoryGetBySubscription.json" - }, - "ExportRunHistoryGetByResourceGroup": { - "$ref": "./examples/ExportRunHistoryGetByResourceGroup.json" - }, - "ExportRunHistoryGetByBillingAccount": { - "$ref": "./examples/ExportRunHistoryGetByBillingAccount.json" - }, - "ExportRunHistoryGetByDepartment": { - "$ref": "./examples/ExportRunHistoryGetByDepartment.json" - }, - "ExportRunHistoryGetByEnrollmentAccount": { - "$ref": "./examples/ExportRunHistoryGetByEnrollmentAccount.json" - }, - "ExportRunHistoryGetByManagementGroup": { - "$ref": "./examples/ExportRunHistoryGetByManagementGroup.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/scopeQueryParameter" - }, - { - "$ref": "#/parameters/apiVersion20200601Parameter" - }, - { - "$ref": "#/parameters/exportNameParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/ExportExecutionListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, "/providers/Microsoft.CostManagement/operations": { "get": { "tags": [ @@ -2789,391 +2431,10 @@ "operator", "values" ] - }, - "ExportListResult": { - "description": "Result of listing exports. It contains a list of available exports in the scope provided.", - "type": "object", - "properties": { - "value": { - "description": "The list of exports.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Export" - } - } - } - }, - "Export": { - "description": "An export resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ExportProperties", - "title": "Export properties" - } - } - }, - "ExportProperties": { - "description": "The properties of the export.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CommonExportProperties" - } - ], - "properties": { - "schedule": { - "description": "Has schedule information for the export.", - "$ref": "#/definitions/ExportSchedule" - } - } - }, - "CommonExportProperties": { - "description": "The common properties of the export.", - "type": "object", - "properties": { - "format": { - "description": "The format of the export being delivered. Currently only 'Csv' is supported.", - "type": "string", - "enum": [ - "Csv" - ], - "x-ms-enum": { - "name": "FormatType", - "modelAsString": true - } - }, - "deliveryInfo": { - "description": "Has delivery information for the export.", - "$ref": "#/definitions/ExportDeliveryInfo" - }, - "definition": { - "description": "Has the definition for the export.", - "$ref": "#/definitions/ExportDefinition" - }, - "runHistory": { - "description": "If requested, has the most recent execution history for the export.", - "$ref": "#/definitions/ExportExecutionListResult" - }, - "nextRunTimeEstimate": { - "description": "If the export has an active schedule, provides an estimate of the next execution time.", - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "required": [ - "deliveryInfo", - "definition" - ] - }, - "ExportSchedule": { - "description": "The schedule associated with the export.", - "type": "object", - "properties": { - "status": { - "description": "The status of the export's schedule. If 'Inactive', the export's schedule is paused.", - "type": "string", - "enum": [ - "Active", - "Inactive" - ], - "x-ms-enum": { - "name": "StatusType", - "modelAsString": true - } - }, - "recurrence": { - "description": "The schedule recurrence.", - "type": "string", - "enum": [ - "Daily", - "Weekly", - "Monthly", - "Annually" - ], - "x-ms-enum": { - "name": "RecurrenceType", - "modelAsString": true - } - }, - "recurrencePeriod": { - "description": "Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date.", - "$ref": "#/definitions/ExportRecurrencePeriod" - } - }, - "required": [ - "recurrence" - ] - }, - "ExportDeliveryInfo": { - "description": "The delivery information associated with a export.", - "type": "object", - "properties": { - "destination": { - "description": "Has destination for the export being delivered.", - "$ref": "#/definitions/ExportDeliveryDestination" - } - }, - "required": [ - "destination" - ] - }, - "ExportRecurrencePeriod": { - "description": "The start and end date for recurrence schedule.", - "type": "object", - "properties": { - "from": { - "description": "The start date of recurrence.", - "type": "string", - "format": "date-time" - }, - "to": { - "description": "The end date of recurrence.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "from" - ] - }, - "ExportDeliveryDestination": { - "description": "The destination information for the delivery of the export. To allow access to a storage account, you must register the account's subscription with the Microsoft.CostManagementExports resource provider. This is required once per subscription. When creating an export in the Azure portal, it is done automatically, however API users need to register the subscription. For more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services .", - "type": "object", - "properties": { - "resourceId": { - "description": "The resource id of the storage account where exports will be delivered.", - "type": "string" - }, - "container": { - "description": "The name of the container where exports will be uploaded.", - "type": "string" - }, - "rootFolderPath": { - "description": "The name of the directory where exports will be uploaded.", - "type": "string" - } - }, - "required": [ - "resourceId", - "container" - ] - }, - "ExportDefinition": { - "description": "The definition of an export.", - "type": "object", - "properties": { - "type": { - "description": "The type of the export. Note that 'Usage' is equivalent to 'ActualCost' and is applicable to exports that do not yet provide data for charges or amortization for service reservations.", - "type": "string", - "enum": [ - "Usage", - "ActualCost", - "AmortizedCost" - ], - "x-ms-enum": { - "name": "ExportType", - "modelAsString": true - } - }, - "timeframe": { - "description": "The time frame for pulling data for the export. If custom, then a specific time period must be provided.", - "type": "string", - "enum": [ - "MonthToDate", - "BillingMonthToDate", - "TheLastMonth", - "TheLastBillingMonth", - "WeekToDate", - "Custom" - ], - "x-ms-enum": { - "name": "TimeframeType", - "modelAsString": true - } - }, - "timePeriod": { - "description": "Has time period for pulling data for the export.", - "$ref": "#/definitions/ExportTimePeriod" - }, - "dataSet": { - "description": "The definition for data in the export.", - "$ref": "#/definitions/ExportDataset" - } - }, - "required": [ - "type", - "timeframe" - ] - }, - "ExportDataset": { - "description": "The definition for data in the export.", - "type": "object", - "properties": { - "granularity": { - "description": "The granularity of rows in the export. Currently only 'Daily' is supported.", - "type": "string", - "enum": [ - "Daily" - ], - "x-ms-enum": { - "name": "GranularityType", - "modelAsString": true - } - }, - "configuration": { - "description": "The export dataset configuration.", - "$ref": "#/definitions/ExportDatasetConfiguration" - } - } - }, - "ExportDatasetConfiguration": { - "description": "The export dataset configuration. Allows columns to be selected for the export. If not provided then the export will include all available columns.", - "type": "object", - "properties": { - "columns": { - "description": "Array of column names to be included in the export. If not provided then the export will include all available columns. The available columns can vary by customer channel (see examples).", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ExportTimePeriod": { - "description": "The date range for data in the export. This should only be specified with timeFrame set to 'Custom'. The maximum date range is 3 months.", - "type": "object", - "properties": { - "from": { - "description": "The start date for export data.", - "type": "string", - "format": "date-time" - }, - "to": { - "description": "The end date for export data.", - "type": "string", - "format": "date-time" - } - }, - "required": [ - "from", - "to" - ] - }, - "ExportExecutionListResult": { - "description": "Result of listing the execution history of an export.", - "type": "object", - "properties": { - "value": { - "description": "A list of export executions.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ExportExecution" - } - } - } - }, - "ExportExecution": { - "description": "An export execution.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ExportExecutionProperties", - "title": "Export execution properties" - } - } - }, - "ExportExecutionProperties": { - "description": "The properties of the export execution.", - "type": "object", - "properties": { - "executionType": { - "description": "The type of the export execution.", - "type": "string", - "enum": [ - "OnDemand", - "Scheduled" - ], - "x-ms-enum": { - "name": "ExecutionType", - "modelAsString": true - } - }, - "status": { - "description": "The last known status of the export execution.", - "type": "string", - "enum": [ - "Queued", - "InProgress", - "Completed", - "Failed", - "Timeout", - "NewDataNotAvailable", - "DataNotAvailable" - ], - "x-ms-enum": { - "name": "ExecutionStatus", - "modelAsString": true - } - }, - "submittedBy": { - "description": "The identifier for the entity that executed the export. For OnDemand executions it is the user email. For scheduled executions it is 'System'.", - "type": "string" - }, - "submittedTime": { - "description": "The time when export was queued to be executed.", - "type": "string", - "format": "date-time" - }, - "processingStartTime": { - "description": "The time when export was picked up to be executed.", - "type": "string", - "format": "date-time" - }, - "processingEndTime": { - "description": "The time when the export execution finished.", - "type": "string", - "format": "date-time" - }, - "fileName": { - "description": "The name of the exported file.", - "type": "string" - }, - "runSettings": { - "description": "The export settings that were in effect for this execution.", - "$ref": "#/definitions/CommonExportProperties" - }, - "error": { - "description": "The details of any error.", - "$ref": "#/definitions/ErrorDetails" - } - } } }, "parameters": { "apiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Version of the API to be used with the client request. The current version is 2019-11-01." - }, - "apiVersion20200601Parameter": { "name": "api-version", "in": "query", "required": true, @@ -3279,14 +2540,6 @@ "type": "string", "x-ms-parameter-location": "method" }, - "exportNameParameter": { - "name": "exportName", - "in": "path", - "description": "Export Name.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, "externalCloudProviderTypeParameter": { "name": "externalCloudProviderType", "in": "path", diff --git a/specification/cost-management/resource-manager/readme.md b/specification/cost-management/resource-manager/readme.md index 66b5c5f7d127..505a99a338c0 100644 --- a/specification/cost-management/resource-manager/readme.md +++ b/specification/cost-management/resource-manager/readme.md @@ -50,6 +50,7 @@ These settings apply only when `--tag=package-2020-06` is specified on the comma ```yaml $(tag) == 'package-2020-06' input-file: - Microsoft.CostManagement/stable/2020-06-01/costmanagement.json + - Microsoft.CostManagement/stable/2020-06-01/costmanagement.exports.json ``` From 9ef0d2334aa069e06ce1cca5d5e40324763ba54b Mon Sep 17 00:00:00 2001 From: Eunice Lee Date: Mon, 21 Sep 2020 12:03:16 -0700 Subject: [PATCH 098/164] Migrate existing Azure Maps data plane docs (v1.0) (#10113) * initial-1.0 * Documentation updates * remove tags * Remove CSharp settings * Remove WFS Get Version Info * Weather and route fixes Co-authored-by: Eunice Lee --- cSpell.json | 8 + custom-words.txt | 67 + .../Alias/preview/1.0/alias.json | 416 ++ .../preview/1.0/examples/Alias_Assign.json | 58 + .../preview/1.0/examples/Alias_Create.json | 59 + .../preview/1.0/examples/Alias_Delete.json | 57 + .../preview/1.0/examples/Alias_List.json | 71 + .../Microsoft.Maps/Data/preview/1.0/data.json | 618 +++ .../Data/preview/1.0/examples/Delete.json | 57 + .../Data/preview/1.0/examples/Download.json | 76 + .../Data/preview/1.0/examples/List.json | 77 + .../Data/preview/1.0/examples/Update.json | 100 + .../Data/preview/1.0/examples/Upload.json | 100 + .../Dataset/preview/1.0/dataset.json | 608 +++ .../preview/1.0/examples/Dataset_Create.json | 73 + .../preview/1.0/examples/Dataset_Delete.json | 57 + .../preview/1.0/examples/Dataset_Import.json | 71 + .../preview/1.0/examples/Dataset_List.json | 116 + .../preview/1.0/dwgconversion.json | 474 +++ .../preview/1.0/examples/Conversion.json | 73 + .../preview/1.0/examples/Delete.json | 57 + .../preview/1.0/examples/List.json | 89 + .../preview/1.0/examples/CreateStateset.json | 105 + .../1.0/examples/DeleteFeatureState.json | 66 + .../preview/1.0/examples/DeleteStateset.json | 55 + .../preview/1.0/examples/GetStates.json | 66 + .../preview/1.0/examples/GetStateset.json | 117 + .../preview/1.0/examples/Stateset_List.json | 121 + .../preview/1.0/examples/UpdateStates.json | 65 + .../preview/1.0/examples/UpdateStateset.json | 101 + .../preview/1.0/featurestate.json | 804 ++++ .../Feedback/preview/1.0/feedback.json | 685 ++++ .../1.0/examples/GetLocationByIpAddress.json | 64 + .../Geolocation/preview/1.0/geolocation.json | 249 ++ .../preview/1.0/examples/GetMetroArea.json | 110 + .../1.0/examples/GetMetroAreaInfo.json | 359 ++ .../1.0/examples/GetNearbyTransit.json | 136 + .../1.0/examples/GetRealTimeArrivals.json | 141 + .../1.0/examples/GetTransitItinerary.json | 203 + .../1.0/examples/GetTransitLineInfo.json | 599 +++ .../preview/1.0/examples/GetTransitRoute.json | 230 ++ .../1.0/examples/GetTransitStopInfo.json | 166 + .../Mobility/preview/1.0/mobility.json | 2483 +++++++++++ .../1.0/examples/GetCopyrightCaption.json | 60 + .../1.0/examples/GetCopyrightForTile.json | 125 + .../1.0/examples/GetCopyrightForWorld.json | 384 ++ .../examples/GetCopyrightFromBoundingBox.json | 79 + .../preview/1.0/examples/GetMapImage.json | 62 + .../1.0/examples/GetMapImageryTile.json | 52 + .../preview/1.0/examples/GetMapStateTile.json | 63 + .../preview/1.0/examples/GetMapTile.json | 64 + .../Render/preview/1.0/render.json | 1177 ++++++ .../1.0/examples/GetRouteDirections.json | 156 + .../preview/1.0/examples/GetRouteRange.json | 269 ++ .../examples/PostMatrixRouteCalculate.json | 152 + .../1.0/examples/PostRouteDirections.json | 234 ++ .../examples/PostRouteDirectionsBatch.json | 212 + .../Route/preview/1.0/route.json | 2845 +++++++++++++ .../1.0/examples/GetPOICategoryTree.json | 252 ++ .../1.0/examples/GetSearchAddress.json | 114 + .../1.0/examples/GetSearchAddressReverse.json | 85 + .../GetSearchAddressReverseCrossStreet.json | 84 + .../examples/GetSearchAddressStructured.json | 124 + .../preview/1.0/examples/GetSearchFuzzy.json | 703 ++++ .../preview/1.0/examples/GetSearchNearby.json | 763 ++++ .../preview/1.0/examples/GetSearchPOI.json | 457 +++ .../1.0/examples/GetSearchPOICategory.json | 275 ++ .../1.0/examples/GetSearchPolygon.json | 125 + .../1.0/examples/PostSearchAddressBatch.json | 351 ++ .../PostSearchAddressReverseBatch.json | 190 + .../1.0/examples/PostSearchAlongRoute.json | 249 ++ .../1.0/examples/PostSearchFuzzyBatch.json | 1454 +++++++ .../PostSearchInsideFeatureCollection.json | 261 ++ .../examples/PostSearchInsideGeometry.json | 247 ++ .../PostSearchInsideGeometryCollection.json | 275 ++ .../Search/preview/1.0/search.json | 3580 ++++++++++++++++ .../preview/1.0/examples/GetBuffer.json | 219 + .../preview/1.0/examples/GetClosestPoint.json | 83 + .../preview/1.0/examples/GetGeofence.json | 95 + .../1.0/examples/GetGreatCircleDistance.json | 76 + .../1.0/examples/GetPointInPolygon.json | 79 + .../preview/1.0/examples/PostBuffer.json | 240 ++ .../1.0/examples/PostClosestPoint.json | 126 + .../preview/1.0/examples/PostGeofence.json | 183 + .../1.0/examples/PostPointInPolygon.json | 112 + .../Spatial/preview/1.0/spatial.json | 1604 ++++++++ .../Tileset/preview/1.0/examples/Create.json | 72 + .../Tileset/preview/1.0/examples/Delete.json | 57 + .../Tileset/preview/1.0/examples/List.json | 85 + .../Tileset/preview/1.0/tileset.json | 479 +++ .../examples/GetTimezoneByCoordinates.json | 120 + .../preview/1.0/examples/GetTimezoneByID.json | 107 + .../1.0/examples/GetTimezoneEnumIANA.json | 3231 +++++++++++++++ .../1.0/examples/GetTimezoneEnumWindows.json | 3649 +++++++++++++++++ .../1.0/examples/GetTimezoneIANAVersion.json | 59 + .../examples/GetTimezoneWindowsToIANA.json | 64 + .../Timezone/preview/1.0/timezone.json | 1009 +++++ .../1.0/examples/GetTrafficFlowSegment.json | 83 + .../1.0/examples/GetTrafficFlowTile.json | 61 + .../examples/GetTrafficIncidentDetail.json | 383 ++ .../1.0/examples/GetTrafficIncidentTile.json | 61 + .../examples/GetTrafficIncidentViewport.json | 72 + .../Traffic/preview/1.0/traffic.json | 1154 ++++++ .../WFS/preview/1.0/examples/DeleteItem.json | 57 + .../preview/1.0/examples/GetCollection.json | 78 + .../1.0/examples/GetCollectionDefinition.json | 196 + .../preview/1.0/examples/GetCollections.json | 297 ++ .../preview/1.0/examples/GetConformance.json | 64 + .../WFS/preview/1.0/examples/GetItem.json | 128 + .../WFS/preview/1.0/examples/GetItems.json | 137 + .../preview/1.0/examples/GetLandingPage.json | 85 + .../Microsoft.Maps/WFS/preview/1.0/wfs.json | 984 +++++ .../1.0/examples/GetCurrentConditions.json | 224 + .../1.0/examples/GetDailyForecast.json | 284 ++ .../preview/1.0/examples/GetDailyIndices.json | 251 ++ .../1.0/examples/GetHourlyForecast.json | 1057 +++++ .../1.0/examples/GetMinuteForecast.json | 180 + .../1.0/examples/GetQuarterDayForecast.json | 423 ++ .../1.0/examples/GetSevereWeatherAlerts.json | 112 + .../1.0/examples/GetWeatherAlongRoute.json | 353 ++ .../Weather/preview/1.0/weather.json | 2397 +++++++++++ specification/maps/data-plane/readme.md | 63 + 122 files changed, 46763 insertions(+) create mode 100644 specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/alias.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_Assign.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_Create.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_Delete.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_List.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/data.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Delete.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Download.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/List.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Update.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Upload.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/dataset.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/examples/Dataset_Create.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/examples/Dataset_Delete.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/examples/Dataset_Import.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/examples/Dataset_List.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/dwgconversion.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/examples/Conversion.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/examples/Delete.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/examples/List.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/CreateStateset.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/DeleteFeatureState.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/DeleteStateset.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/GetStates.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/GetStateset.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/Stateset_List.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/UpdateStates.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/UpdateStateset.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/featurestate.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Feedback/preview/1.0/feedback.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Geolocation/preview/1.0/examples/GetLocationByIpAddress.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Geolocation/preview/1.0/geolocation.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetMetroArea.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetMetroAreaInfo.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetNearbyTransit.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetRealTimeArrivals.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitItinerary.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitLineInfo.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitRoute.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitStopInfo.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/mobility.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetCopyrightCaption.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetCopyrightForTile.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetCopyrightForWorld.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetCopyrightFromBoundingBox.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetMapImage.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetMapImageryTile.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetMapStateTile.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetMapTile.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/render.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/examples/GetRouteDirections.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/examples/GetRouteRange.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/examples/PostMatrixRouteCalculate.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/examples/PostRouteDirections.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/examples/PostRouteDirectionsBatch.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/route.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetPOICategoryTree.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchAddress.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchAddressReverse.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchAddressReverseCrossStreet.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchAddressStructured.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchFuzzy.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchNearby.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchPOI.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchPOICategory.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchPolygon.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchAddressBatch.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchAddressReverseBatch.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchAlongRoute.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchFuzzyBatch.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchInsideFeatureCollection.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchInsideGeometry.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchInsideGeometryCollection.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/search.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/GetBuffer.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/GetClosestPoint.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/GetGeofence.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/GetGreatCircleDistance.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/GetPointInPolygon.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/PostBuffer.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/PostClosestPoint.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/PostGeofence.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/PostPointInPolygon.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/spatial.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/examples/Create.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/examples/Delete.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/examples/List.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/tileset.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneByCoordinates.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneByID.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneEnumIANA.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneEnumWindows.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneIANAVersion.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneWindowsToIANA.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/timezone.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/examples/GetTrafficFlowSegment.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/examples/GetTrafficFlowTile.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/examples/GetTrafficIncidentDetail.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/examples/GetTrafficIncidentTile.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/examples/GetTrafficIncidentViewport.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/traffic.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/DeleteItem.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetCollection.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetCollectionDefinition.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetCollections.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetConformance.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetItem.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetItems.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetLandingPage.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/wfs.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetCurrentConditions.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetDailyForecast.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetDailyIndices.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetHourlyForecast.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetMinuteForecast.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetQuarterDayForecast.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetSevereWeatherAlerts.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetWeatherAlongRoute.json create mode 100644 specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/weather.json create mode 100644 specification/maps/data-plane/readme.md diff --git a/cSpell.json b/cSpell.json index 88648ed85612..794394747940 100644 --- a/cSpell.json +++ b/cSpell.json @@ -720,6 +720,14 @@ "mysqldb", "psqldb" ] + }, + { + "filename": "**/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/render.json", + "words": [ + "Chttp", + "Fcontoso", + "Fpushpins" + ] } ] } diff --git a/custom-words.txt b/custom-words.txt index c064b70c886f..602c49385a73 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -58,6 +58,7 @@ AND'ed Annotatable anomalydetector anomalyfinder +antimeridian APAC APACHEAVRO API's @@ -199,6 +200,7 @@ baremetalinfrastructure BATCHAI batchmanaged BAYESIANOPTIMIZATION +bbox BCDR BCWG beider @@ -243,6 +245,8 @@ Bokmaal Bootstrappers bot's botservice +boundingbox +boundingzoom brazilsouth browsable bruceper @@ -276,6 +280,7 @@ certificatescreateorupdate certificatesdelete Certificatethumbprint certverify +Chademo chainer changepoint changestate @@ -364,6 +369,7 @@ Cran creatable createconsumergroup createorupdate +createpreview credativ crossdomain csname @@ -390,6 +396,7 @@ CUTOVER CVEs CVSS Cyrl +darkgrey databox Databricks datacatalog @@ -409,6 +416,7 @@ Datamasking datamigration datapoint Dataset +datasetid datasets dataschema datasource @@ -468,6 +476,7 @@ devicetemplates devspaces devtestlab devtestlabs +dewpoint dhcp diagnosticcontext digitaltwins @@ -509,6 +518,7 @@ Edgenode edgenodes EDIFACT EDMX +Einsteinweg Ekaterinburg ekus Eloqua @@ -530,6 +540,7 @@ entitydocument entitysearch entrypoint environmentsettings +EPSG errordetail errored ErrorMesssage @@ -601,6 +612,7 @@ FPGA fqdn FQDNs Français +freeflow frontdoor fsaction Fulfilment @@ -620,10 +632,16 @@ generatelivetoken generateverificationcode generatevpnclientpackage generatevpnprofile +geobias +geocode +geocodes Geofence +geofences Geofencing +geojson georegions georeplication +geospatial GETACLSTATUS getactivationkey getavailablebillingfeatures @@ -632,8 +650,10 @@ getconsumergroup GETCONTENTSUMMARY GETFILESTATUS getissuers +getitems getjob getkey +getmaptile getprivateendpointconnection getprivatelinkresources getsas @@ -661,10 +681,12 @@ Groupby groupedby GRPC GSMT +GTFS guestconfiguration GUID GUIDs GZRS +Haag haase Había hadoop @@ -695,6 +717,7 @@ Horovod hostnames Hotfix hotfixes +HSLA HSMs Hubspot hybridconnection @@ -766,6 +789,7 @@ isdirectory ishostingenvironmentnameavailable ishostnameavailable isnullable +isochrone isordered issqlcompression istransitioning @@ -806,6 +830,7 @@ keyvaulturi keyversion KHTML Kiswahili +KMPH Knowledgebase knowledgebases koelner @@ -844,6 +869,7 @@ libtrust lifecycle lifetimejobstats lifetimepoolstats +Linestring linkedservices linkexpiryinminutes LISTAFTERID @@ -910,12 +936,14 @@ managementgroups managementpartner managementpolicy manualupgrade +mapbox mapred mapreduce mariadb Marketo marketplaceagreementsapi marketplaceordering +maxcoordinates MAXERRORS maximumblobsize maxmemory @@ -944,9 +972,11 @@ microservices microsofttranslator migratemysql migratetoaad +mincoordinates minidump minimalmetadata ministamps +Minkowski mixedreality Mkdirs mktorest @@ -958,6 +988,7 @@ MODIFYACLENTRIES monitoringconfiguration monitoringconfigurations Monospace +mountainview MPNS MRAN MSAZR @@ -973,6 +1004,8 @@ Multiclass MULTIJSON Multilabel multipart +multipoint +multipoints Multiset multistep multivalued @@ -1005,10 +1038,12 @@ n'recognition nagios namespace's nanoserver +Napoli nbformat Nccl nchar ndjson +Neighbourhood netapp netezza networkruleset @@ -1049,6 +1084,7 @@ notificationchannels notificationhubs notstarted nouploadcache +nowcasts nsdname nsku nsxt @@ -1087,6 +1123,7 @@ operationresults operationsmanagement operationstatuses opid +openlr oplog Optimised Optimiser @@ -1104,6 +1141,8 @@ overprovisioned overprovisioning overridable overriden +overviewbox +overviewzoom OWASP oxxm pageable @@ -1144,6 +1183,7 @@ pkcs playready Plex Pohlmann +pois policyassignments policydefinitions policyinsights @@ -1319,6 +1359,7 @@ Responsys RESTAPI restoreheartbeat Restproxy +restrant restype resumable resync @@ -1352,6 +1393,7 @@ RPKI rpns RSAES RSASSA +rstrnt rscc rscd rsce @@ -1382,6 +1424,7 @@ sawinvm SBEH Scaleset scalesets +Scame scanability SCMS SCOM @@ -1389,6 +1432,7 @@ scopemap SCSV sdks SDWAN +searchbuffer searchindex searchmanagementclient searchservice @@ -1504,6 +1548,9 @@ starttaskfailed starttime startTime stateful +stateset +statesets +statetile staticsite statusdir stderror @@ -1526,6 +1573,7 @@ streamanalytics streamingendpoint streamingjobs streamingservice +subcause subcomponent subdir subdomain @@ -1593,6 +1641,7 @@ templatelink templeton temporarydisk tensorflow +TEPCO's teradata terminatejob Termlist @@ -1607,6 +1656,8 @@ textanalytics TFIDF Tful Tfvc +tileset +tilesets timeframe timegrain timeseries @@ -1622,11 +1673,13 @@ toolset tooltips topqueries topquery +TPEG traceback traceroute trafficmanager trafficmanageranalytics trafficmanagerprofiles +trafficmodelid tráfico transcoding transcodes @@ -1638,8 +1691,11 @@ triggerruns TSVE Turbonomic Txns +typeahead Typeless typeperf +udid +udids UEFI UEBA Uint @@ -1658,6 +1714,7 @@ unexamined Unigrams uniqueidentifier uniquestring +unitless unixtime UNKNOWON unlocalized @@ -1714,8 +1771,11 @@ userid userpreference usersetting usermanaged +usertime USQL +uturn UUCP +UUIDs VAIDK varbinary varchar @@ -1732,6 +1792,7 @@ Vfyc vhds VHDX videosearch +viewp virtualclusters virtualip virtualmachine @@ -1781,6 +1842,8 @@ waitingforstarttask WANAs WANs WASB +waypoint +waypoints WDATP WEBAPICONTAINER webapplicationfirewall @@ -1811,6 +1874,7 @@ Whitelistings whitespaces Whois Widevine +windingness windowsazuremediaservices windowsesu wlmengg @@ -1828,7 +1892,9 @@ XBing Xeon Xero XSMB +Xstr XVCJ +Yazaki Yucatec Ywhk YYMMDD @@ -1837,6 +1903,7 @@ Zerto Zilla ziplist Zoho +zoneinfo zset MSAZRUSGO hypervcollectors diff --git a/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/alias.json b/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/alias.json new file mode 100644 index 000000000000..13630019c12b --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/alias.json @@ -0,0 +1,416 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Alias Service", + "version": "1.0", + "description": "APIs for managing aliases in Azure Maps." + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json", + "application/xml" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "user_impersonation": "Impersonates a user's Azure Active Directory account." + } + }, + "apiKeyQuery": { + "type": "apiKey", + "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + } + }, + "security": [ + { + "azure_auth": [] + }, + { + "apiKeyQuery": [] + } + ], + "responses": { + "202": { + "description": "Request Accepted: The request has been accepted for processing. Please use the URL in the Location Header to retry or access the results.", + "headers": { + "Location": { + "type": "string", + "description": "New URL to check for the results of the long running process." + } + } + }, + "400": { + "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "401": { + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + }, + "headers": { + "WWW-Authenticate": { + "type": "string", + "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" + } + } + }, + "403": { + "description": "Permission, capacity, or authentication issues.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "404": { + "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "500": { + "description": "An error occurred while processing the request. Please try again later.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + } + }, + "parameters": { + "SubscriptionKey": { + "name": "subscription-key", + "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API. Current version is 1.0", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "CreateResourceId": { + "name": "resourceId", + "description": "The unique id that references a resource to be aliased.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + }, + "AssignResourceId": { + "name": "resourceId", + "description": "The unique id that references a resource to be aliased.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "AliasId": { + "name": "aliasId", + "description": "The unique id that references an existing alias.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/alias": { + "post": { + "x-publish": true, + "description": "**Alias - Create API**\n\n**Applies to:** S1 pricing tier.\n
\n\nThis API allows the caller to create an alias.
\nYou can also assign the alias during the create request as well.\n\n\n### Submit Create Request\n\nTo create your alias, you will use a `POST` request. If you would like to assign the alias during the creation, you will pass the `resourceId` query parameter.
\n\n\n### Create Alias Response\n\nThe Create API returns a HTTP `201 Created` response the id of the alias, `aliasId`, in the body.\nThe response will look something like:\n\n```json\n{\n \"aliasId\" : \"d7e5efc8-2239-4387-a286-5bb51aa804e3\"\n}\n```\n\n
", + "operationId": "Alias_CreatePreview", + "x-ms-examples": { + "Create an alias that does not reference any resource": { + "$ref": "./examples/Alias_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "201": { + "description": "Content created successfully. The response body contains the newly created alias id `aliasId`.", + "schema": { + "$ref": "#/definitions/AliasCreateResponse" + }, + "headers": { + "Access-Control-Expose-Headers": { + "type": "string", + "description": "The list of response headers that can be read by the client." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + }, + "get": { + "x-publish": true, + "description": "**Alias - List API**\n\n**Applies to:** S1 pricing tier.\n
\n\nThis API allows the caller to fetch a list of all previously successfully created aliases.\n\n\n### Submit List Request\n\nTo list all your aliases, you will issue a `GET` request with no additional parameters.
\n\n\n### List Data Response\n\nThe List API returns the complete list of all aliases in `json` format. The response contains the following details for each alias resource:\n\n > createdTimestamp - The timestamp that the alias was created.\n > aliasId - The id for the alias.\n > resourceId - The id for the resource that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource.\n\n\nHere's a sample response returning 2 alias resources: \n\n
\n\n```json\n{\n \"aliases\": [\n {\n \"createdTimestamp\": \"2020-02-13T21:19:11+00:00\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"resourceId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22+00:00\"\n },\n {\n \"createdTimestamp\": \"2020-02-18T19:53:33+00:00\",\n \"aliasId\": \"1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6\",\n \"resourceId\": null,\n \"lastUpdatedTimestamp\": \"2020-02-18T19:53:33+00:00\"\n }\n ]\n}\n```\n\n
", + "operationId": "Alias_ListPreview", + "x-ms-examples": { + "List all the previously created aliases": { + "$ref": "./examples/Alias_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "List alias request completed successfully. The response body contains a list of all the previously created aliases.", + "schema": { + "$ref": "#/definitions/AliasListResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/alias/assign/{aliasId}": { + "patch": { + "x-publish": true, + "description": "**Alias - Assign API**\n\n**Applies to:** S1 pricing tier.\n
\n\nThis API allows the caller to assign an alias to reference a resource.
\n\n\n### Submit Assign Request\n\nTo assign your alias to a resource, you will use a `PATCH` request with the `aliasId` in the path and the `resourceId` passed as a query parameter.
\n\n\n### Create Alias Response\n\nThe Assign API returns a HTTP `204 No Content` response with an empty body, if the alias was assigned successfully.
", + "operationId": "Alias_AssignPreview", + "x-ms-examples": { + "Assign an alias to a resource": { + "$ref": "./examples/Alias_Assign.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/AliasId" + }, + { + "$ref": "#/parameters/AssignResourceId" + } + ], + "responses": { + "204": { + "description": "Alias was assigned successfully.", + "schema": { + "$ref": "#/definitions/AliasAssignResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/alias/{aliasId}": { + "delete": { + "x-publish": true, + "description": "**Alias - Delete API**\n\n**Applies to:** S1 pricing tier.\n
\n\nThis API allows the caller to delete a previously created alias.
\nYou can also use this API to delete old/unused aliases to create space for new content.\nThis API does not delete the references resource, only the alias referencing the resource.\n\n\n### Submit Delete Request\n\nTo delete your alias you will issue a `DELETE` request where the path will contain the `aliasId` of the alias to delete.
\n\n\n### Delete Alias Response\n\nThe Delete API returns a HTTP `204 No Content` response with an empty body, if the alias was deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if the alias with the passed-in `aliasId` is not found. ", + "operationId": "Alias_DeletePreview", + "x-ms-examples": { + "Delete previously created alias": { + "$ref": "./examples/Alias_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/AliasId" + } + ], + "responses": { + "204": { + "description": "Alias delete request completed successfully. The content for `aliasId` was deleted on the server.", + "schema": { + "$ref": "#/definitions/AliasDeleteResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + } + }, + "definitions": { + "ODataErrorResponse": { + "type": "object", + "description": "This response object is returned when an error occurs in the Maps API.", + "properties": { + "error": { + "$ref": "#/definitions/ODataError" + } + } + }, + "ODataError": { + "type": "object", + "description": "This object is returned when an error occurs in the Maps API.", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The ODataError code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + } + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the target causing the error." + } + } + }, + "AliasCreateResponse": { + "description": "The response model for the Alias Create API for the case when the alias was successfully created.", + "type": "object", + "properties": { + "aliasId": { + "description": "An alias id `aliasId` for the created alias.", + "type": "string", + "readOnly": true + } + } + }, + "AliasAssignResponse": { + "description": "The response model for the Assign API. The response body will be empty signifying the assign was successful.", + "type": "object" + }, + "AliasDeleteResponse": { + "description": "The response model for the Delete API. The response body will be empty signifying there's alias available with the given `aliasId` anymore.", + "type": "object" + }, + "AliasListResponse": { + "description": "The response model for the List API. Returns a list of all the previously created aliases.", + "type": "object", + "properties": { + "aliases": { + "description": "A list of all the previously created aliases.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AliasListItem" + } + } + } + }, + "AliasListItem": { + "description": "Detailed information for the alias.", + "type": "object", + "properties": { + "createdTimestamp": { + "description": "The created timestamp for the alias.", + "type": "string", + "readOnly": true + }, + "aliasId": { + "description": "The id for the alias.", + "type": "string", + "readOnly": true + }, + "resourceId": { + "description": "The id for the resource that this alias references (could be null if the alias has not been assigned).", + "type": "string", + "readOnly": true + }, + "lastUpdatedTimestamp": { + "description": "The timestamp of the last time the alias was assigned.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_Assign.json b/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_Assign.json new file mode 100644 index 000000000000..352eacf788fc --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_Assign.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "aliasId": "[aliasId]", + "resourceId": "[resourceId]" + }, + "responses": { + "204": { + "body": {} + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request - Error message." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found - The requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "Unknown error - An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_Create.json b/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_Create.json new file mode 100644 index 000000000000..173db30afe23 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_Create.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "aliasId": "25084fb7-307a-4720-8f91-7952a0b91012" + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request - Error message." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found - The requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "Unknown error - An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_Delete.json b/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_Delete.json new file mode 100644 index 000000000000..11adb1e66418 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_Delete.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "aliasId": "[aliasId]" + }, + "responses": { + "204": { + "body": {} + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request - One or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found - The requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "Unknown error - An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_List.json b/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_List.json new file mode 100644 index 000000000000..e74d2c24197f --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_List.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "aliases": [ + { + "createdTimestamp": "2020-02-13T21:19:11+00:00", + "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766", + "resourceId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14", + "lastUpdatedTimestamp": "2020-02-13T21:19:22+00:00" + }, + { + "createdTimestamp": "2020-02-13T21:19:11+00:00", + "aliasId": "1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6", + "resourceId": null, + "lastUpdatedTimestamp": "2020-02-13T21:19:11+00:00" + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request - One or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found - The requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "Unknown error - An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/data.json b/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/data.json new file mode 100644 index 000000000000..3661631adc93 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/data.json @@ -0,0 +1,618 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Data Service", + "version": "1.0", + "description": "APIs for uploading map data to Azure Maps." + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "user_impersonation": "Impersonates a user's Azure Active Directory account." + } + }, + "apiKeyQuery": { + "type": "apiKey", + "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + } + }, + "security": [ + { + "azure_auth": [] + }, + { + "apiKeyQuery": [] + } + ], + "responses": { + "400": { + "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "401": { + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + }, + "headers": { + "WWW-Authenticate": { + "type": "string", + "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" + } + } + }, + "403": { + "description": "Permission, capacity, or authentication issues.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "404": { + "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "500": { + "description": "An error occurred while processing the request. Please try again later.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "201Async": { + "description": "The resource has been created successfully.", + "schema": { + "$ref": "#/definitions/LongRunningOperationResult" + }, + "headers": { + "Location": { + "type": "string", + "description": "A URI where details on the newly created resource can be found." + } + } + }, + "202Async": { + "description": "**Supported only for async request.**\nRequest Accepted: The request has been accepted for processing. Please use the URL in the Location Header to retry or access the results.", + "headers": { + "Location": { + "type": "string", + "description": "New URL to check for the results of the long running process." + } + } + } + }, + "parameters": { + "ClientId": { + "name": "x-ms-client-id", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "client" + }, + "SubscriptionKey": { + "name": "subscription-key", + "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API. Current version is 1.0", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "JsonFormat": { + "name": "format", + "description": "Desired format of the response. Only `json` format is supported.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "json" + ], + "x-ms-enum": { + "name": "JsonFormat", + "modelAsString": false, + "values": [ + { + "value": "json", + "description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "UploadDataFormat": { + "name": "dataFormat", + "description": "Data format of the content being uploaded.", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "geojson", + "zip" + ], + "x-ms-enum": { + "name": "UploadDataFormat", + "modelAsString": false, + "values": [ + { + "value": "geojson", + "description": "[GeoJSON](https://tools.ietf.org/html/rfc7946) is a JSON based geospatial data interchange format." + }, + { + "value": "zip", + "description": "Compressed data format." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "Udid": { + "name": "udid", + "description": "The unique data id for the content. The `udid` must have been obtained from a successful [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadpreview) call.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/mapData/upload": { + "post": { + "x-publish": true, + "description": "**Data Upload API**\n\n**Applies to:** S1 pricing tier.\n\nThe Data Upload API allows the caller to upload data content to the Azure Maps service.\nYou can use this API in a scenario like uploading a collection of Geofences in `GeoJSON` \nformat, for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial).\n\n## Submit Upload Request\n\nTo upload your content you will use a `POST` request. The request body will contain the data to upload. The \n`dataFormat` query parameter will contain the format for the data, the `dataSharingLevel` query parameter \ncan contain the sharing level for the data. The `Content-Type` header will be set to the content type of the \ndata.\n\nFor example, to upload a collection of geofences in `GeoJSON` format, set the request body to the geofence \ncontent. Set the `dataFormat` query parameter to _geojson_, and set the `Content-Type` header to either one \nof the following media types:\n\n- `application/json`\n- `application/vnd.geo+json`\n- `application/octet-stream`\n\nHere's a sample request body for uploading a simple Geofence represented as a circle geometry using a center \npoint and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe Data Upload API performs a \n[long-running request](https://docs.microsoft.com/azure/azure-maps/private-atlas-long-running-operation).\n\n## Data Upload Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). \nOnce the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. \nYou can always use the [Data Delete API](https://docs.microsoft.com/rest/api/maps/data/deletepreview) to \ndelete old/unused content and create space for new uploads.", + "operationId": "Data_UploadPreview", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Upload GeoJSON data containing geometries that represent a collection of geofences": { + "$ref": "./examples/Upload.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/UploadDataFormat" + }, + { + "name": "UploadContent", + "in": "body", + "description": "The content to upload.", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "Data upload failed. The uploaded content did not satisfy all the validation checks. The response body contains all the errors that were encountered.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "201": { + "$ref": "#/responses/201Async" + }, + "202": { + "$ref": "#/responses/202Async" + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/mapData/{udid}": { + "put": { + "x-publish": true, + "description": "**Data Update API**\n\n**Applies to:** S1 pricing tier.\n\nThe Data Update API allows the caller to update a previously uploaded data content.\n\nYou can use this API in a scenario like adding or removing geofences to or from an existing collection of geofences. \nGeofences are uploaded using the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadpreview), for \nuse in the [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial).\n\nPlease note that the Update API will *replace* and *override* the existing data content.\n\n## Submit Update Request\n\nTo update your content you will use a `PUT` request. The request body will contain the new data that will replace \nthe existing data. The `Content-Type` header will be set to the content type of the data, and the path will contain \nthe `udid` of the data to be update.\n\nFor example, to update a collection of geofences that were previously uploaded using the Upload API, place the new \ngeofence content in the request body. Set the `udid` parameter in the path to the `udid` of the data received \npreviously in the upload API response. And set the `Content-Type` header to one of the following media types:\n\n- `application/json`\n- `application/vnd.geo+json`\n- `application/octet-stream`\n\nHere's a sample request body for updating a simple Geofence. It's represented as a circle geometry using a center \npoint and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe previously uploaded geofence had a radius of 100m. The above request will update it to 500m.\n\nThe Data Update API performs a \n[long-running request](https://docs.microsoft.com/azure/azure-maps/private-atlas-long-running-operation).\n\n## Data Update Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). \nOnce the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. \nYou can always use the [Data Delete API](https://docs.microsoft.com/rest/api/maps/data/deletepreview) to \ndelete old/unused content and create space for new uploads.", + "operationId": "Data_UpdatePreview", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Update previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { + "$ref": "./examples/Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/Udid" + }, + { + "name": "UpdateContent", + "in": "body", + "description": "The new content that will update/replace the previously uploaded content.", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "Data update failed. The uploaded content did not satisfy all the validation checks. The response body contains all the errors that were encountered.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "201": { + "$ref": "#/responses/201Async" + }, + "202": { + "$ref": "#/responses/202Async" + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + }, + "get": { + "x-publish": true, + "description": "**Data Download API**\n\n**Applies to:** S1 pricing tier.\n
\n\nThis API allows the caller to download a previously uploaded data content.
\nYou can use this API in a scenario like downloading an existing collection of geofences uploaded previously using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadpreview) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/en-us/rest/api/maps/spatial). \n\n\n### Submit Download Request\n\nTo download your content you will use a `GET` request where the path will contain the `udid` of the data to download. Optionally, you can also pass in an `Accept` header to specify a preference for the `Content-Type` of the data response.
\nFor example, to download a collection of geofences previously uploaded using the Upload API, set the `udid` parameter in the path to the `udid` of the data received previously in the upload API response and set the `Accept` header to either one of the following media types: \n \n - `application/json`\n - `application/vnd.geo+json`\n - `application/octet-stream`\n\n\n### Download Data Response\n\nThe Download API will return a HTTP `200 OK` response if the data resource with the passed-in `udid` is found, where the response body will contain the content of the data resource.
\nA HTTP `400 Bad Request` error response will be returned if the data resource with the passed-in `udid` is not found.
\n\nHere's a sample response body for a simple geofence represented in `GeoJSON` uploaded previously using the Upload API:\n
\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```", + "operationId": "Data_DownloadPreview", + "x-ms-examples": { + "Download previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { + "$ref": "./examples/Download.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/Udid" + } + ], + "responses": { + "200": { + "description": "Data download request completed successfully. The response body will contain the content for the passed in `udid`.", + "schema": { + "$ref": "#/definitions/MapDataDownloadResponse" + }, + "headers": { + "Content-Type": { + "type": "string", + "description": "The content-type for the Download API response." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + }, + "delete": { + "x-publish": true, + "description": "**Data Delete API**\n\n**Applies to:** S1 pricing tier.\n
\n\nThis API allows the caller to delete a previously uploaded data content.
\nYou can use this API in a scenario like removing geofences previously uploaded using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadpreview) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/en-us/rest/api/maps/spatial). You can also use this API to delete old/unused uploaded content and create space for new content.\n\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `udid` of the data to delete.
\nFor example, to delete a collection of geofences previously uploaded using the Upload API, set the `udid` parameter in the path to the `udid` of the data received previously in the upload API response. \n\n\n### Delete Data Response\n\nThe Data Delete API returns a HTTP `204 No Content` response with an empty body, if the data resource was deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if the data resource with the passed-in `udid` is not found. ", + "operationId": "Data_DeletePreview", + "x-ms-examples": { + "Delete previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { + "$ref": "./examples/Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/Udid" + } + ], + "responses": { + "204": { + "description": "Data delete request completed successfully. The content for `udid` was deleted on the server.", + "schema": { + "$ref": "#/definitions/MapDataDeleteResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/mapData": { + "get": { + "x-publish": true, + "description": "**Data List API**\n\n**Applies to:** S1 pricing tier.\n
\n\nThis API allows the caller to fetch a list of all content uploaded previously using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadpreview). \n\n\n### Submit List Request\n\nTo list all your map data content you will issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nThe Data List API returns the complete list of all data in `json` format. The response contains the following details for each data resource:\n\n > udid - The unique data id for the data resource.\n\n > location - The location of the data resource. Execute a HTTP `GET` on this location to download the data.\n\n\nHere's a sample response returning the `udid` and `location` of 3 data resources: \n\n
\n\n```json\n{\n \"mapDataList\": \n [\n {\n \"udid\": \"9a1288fa-1858-4a3b-b68d-13a8j5af7d7c\",\n \"location\": \"https://atlas.microsoft.com/mapData/9a1288fa-1858-4a3b-b68d-13a8j5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 29920,\n \"uploadStatus\": \"Completed\"\n },\n {\n \"udid\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"location\": \"https://atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 1339,\n \"uploadStatus\": \"Completed\"\n },\n {\n \"udid\": \"7c1288fa-2058-4a1b-b68f-13a6h5af7d7c\",\n \"location\": \"https://atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 1650,\n \"uploadStatus\": \"Pending\"\n }]\n}\n```\n\n
", + "operationId": "Data_ListPreview", + "x-ms-examples": { + "List all the previously uploaded data": { + "$ref": "./examples/List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "List data request completed successfully. The response body contains a list of all the previously uploaded data.", + "schema": { + "$ref": "#/definitions/MapDataListResponse" + }, + "headers": { + "Content-Type": { + "type": "string", + "description": "The content-type for the Download API response." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + } + }, + "definitions": { + "ODataErrorResponse": { + "type": "object", + "description": "This response object is returned when an error occurs in the Maps API.", + "properties": { + "error": { + "$ref": "#/definitions/ODataError" + } + } + }, + "ODataError": { + "type": "object", + "description": "This object is returned when an error occurs in the Maps API.", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The ODataError code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + } + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the target causing the error." + } + } + }, + "LongRunningOperationResult": { + "description": "The response model for a Long-Running Operations API.", + "type": "object", + "properties": { + "operationId": { + "description": "The Id for this long-running operation.", + "type": "string" + }, + "status": { + "description": "The status state of the request.", + "type": "string", + "enum": [ + "NotStarted", + "Running", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": false, + "values": [ + { + "value": "NotStarted", + "description": "The request has not started processing yet." + }, + { + "value": "Running", + "description": "The request has started processing." + }, + { + "value": "Failed", + "description": "The request has one or more failures." + }, + { + "value": "Succeeded", + "description": "The request has successfully completed." + } + ] + }, + "readOnly": true + }, + "created": { + "description": "The created timestamp.", + "type": "string", + "readOnly": true + }, + "resourceLocation": { + "description": "The location URI for details about the created resource. This is only provided when the request was successfully completed.", + "type": "string", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/ODataError" + }, + "warning": { + "$ref": "#/definitions/ODataError" + } + } + }, + "MapDataDownloadResponse": { + "description": "The response model for the Data Download API. The response body will contain the content for the passed in `udid`.", + "type": "object" + }, + "MapDataDeleteResponse": { + "description": "The response model for the Data Delete API. The response body will be empty signifying there's no content available for the `udid` anymore.", + "type": "object" + }, + "MapDataListResponse": { + "description": "The response model for the Data List API. Returns a list of all the previously uploaded data.", + "type": "object", + "properties": { + "mapDataList": { + "description": "A list of all the previously uploaded data.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/MapDataDetailInfo" + } + } + } + }, + "MapDataDetailInfo": { + "description": "Detail information for the data.", + "type": "object", + "properties": { + "udid": { + "description": "The unique data id for the data.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "The location of the data. Execute a HTTP `GET` on this location to download the data.", + "type": "string", + "readOnly": true + }, + "sizeInBytes": { + "description": "The size of the content in bytes.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "uploadStatus": { + "description": "The current upload status of the content.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Delete.json b/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Delete.json new file mode 100644 index 000000000000..ccf95148e20a --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Delete.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "udid": "25084fb7-307a-4720-8f91-7952a0b91012" + }, + "responses": { + "204": { + "body": {} + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Download.json b/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Download.json new file mode 100644 index 000000000000..1c065fe041ea --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Download.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "udid": "25084fb7-307a-4720-8f91-7952a0b91012" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.126986, + 47.639754 + ] + }, + "properties": { + "geometryId": "001", + "radius": 500 + } + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/List.json b/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/List.json new file mode 100644 index 000000000000..741fdd026baf --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/List.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "mapDataList": [ + { + "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2", + "location": "https://atlas.microsoft.com/mapData/f6495f62-94f8-0ec2-c252-45626f82fcb2?api-version=1.0", + "sizeInBytes": 29920, + "uploadStatus": "Completed" + }, + { + "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "location": "https://atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0", + "sizeInBytes": 1339, + "uploadStatus": "Completed" + }, + { + "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c", + "location": "https://atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0", + "sizeInBytes": 1650, + "uploadStatus": "Pending" + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Update.json b/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Update.json new file mode 100644 index 000000000000..20caaf53f5d6 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Update.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "udid": "25084fb7-307a-4720-8f91-7952a0b91012", + "UpdateContent": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.126986, + 47.639754 + ] + }, + "properties": { + "geometryId": "001", + "radius": 500 + } + } + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://atlas.microsoft.com/mapData/metadata/{udid}?api-version=1.0", + "Access-Control-Expose-Headers": "Location" + }, + "body": { + "operationId": "{operationId}", + "status": "Succeeded", + "created": "2020-01-02 1:02:03 AM +00:00", + "resourceLocation": "https://atlas.microsoft.com/mapData/metadata/{resourceId}?api-version=1.0" + } + }, + "202": { + "headers": { + "Location": "https://atlas.microsoft.com/mapData/operations/{operationId}?api-version=1.0", + "Access-Control-Expose-Headers": "Location" + } + }, + "200": { + "headers": {}, + "body": { + "error": { + "code": "400 Bad Request", + "message": "Upload request failed. Your data has been removed as we encountered the following problems with it: Map data is not a valid GeoJSON geometry." + } + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Upload.json b/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Upload.json new file mode 100644 index 000000000000..dd663049a9a0 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Upload.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "dataFormat": "geojson", + "UploadContent": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.126986, + 47.639754 + ] + }, + "properties": { + "geometryId": "001", + "radius": 500 + } + } + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://atlas.microsoft.com/mapData/metadata/{udid}?api-version=1.0", + "Access-Control-Expose-Headers": "Location" + }, + "body": { + "operationId": "{operationId}", + "status": "Succeeded", + "created": "2020-01-02 1:02:03 AM +00:00", + "resourceLocation": "https://atlas.microsoft.com/mapData/metadata/{resourceId}?api-version=1.0" + } + }, + "202": { + "headers": { + "Location": "https://atlas.microsoft.com/mapData/operations/{operationId}?api-version=1.0", + "Access-Control-Expose-Headers": "Location" + } + }, + "200": { + "headers": {}, + "body": { + "error": { + "code": "400 Bad Request", + "message": "Upload request failed. Your data has been removed as we encountered the following problems with it: Map data is not a valid GeoJSON geometry." + } + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/dataset.json b/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/dataset.json new file mode 100644 index 000000000000..6f2f381712b8 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/dataset.json @@ -0,0 +1,608 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Dataset Service", + "version": "1.0", + "description": "APIs for managing datasets from uploaded data in Azure Maps." + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json", + "application/xml" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "user_impersonation": "Impersonates a user's Azure Active Directory account." + } + }, + "apiKeyQuery": { + "type": "apiKey", + "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + } + }, + "security": [ + { + "azure_auth": [] + }, + { + "apiKeyQuery": [] + } + ], + "responses": { + "400": { + "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "401": { + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + }, + "headers": { + "WWW-Authenticate": { + "type": "string", + "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" + } + } + }, + "403": { + "description": "Permission, capacity, or authentication issues.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "404": { + "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "500": { + "description": "An error occurred while processing the request. Please try again later.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "200Async": { + "description": "The operation's status response.", + "schema": { + "$ref": "#/definitions/LongRunningOperationResult" + } + }, + "201Async": { + "description": "The resource has been created successfully.", + "schema": { + "$ref": "#/definitions/LongRunningOperationResult" + }, + "headers": { + "Location": { + "type": "string", + "description": "A URI where details on the newly created resource can be found." + } + } + }, + "202Async": { + "description": "**Supported only for async request.**\nRequest Accepted: The request has been accepted for processing. Please use the URL in the Location Header to retry or access the results.", + "headers": { + "Location": { + "type": "string", + "description": "New URL to check for the results of the long running process." + } + } + } + }, + "parameters": { + "SubscriptionKey": { + "name": "subscription-key", + "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API. Current version is 1.0", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "ConversionIdQuery": { + "name": "conversionId", + "description": "The unique ID used to create the dataset. The `conversionId` must have been obtained from a successful call to the Conversion Service Convert API and must be provided with multiple query parameters with same name (if more than one is provided). May not be provided in conjunction with the `udid` query parameter.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + }, + "UdidDataset": { + "name": "udid", + "description": "The unique data ID used to create the dataset. The `udid` must have been obtained from a successful call to the Data Service Upload API and must be provided with multiple query parameters with the same name (if more than one is provided). May not be provided in conjunction with `conversionId` query parameter.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + }, + "DescriptionDataset": { + "name": "description", + "description": "The description to be given to the dataset.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + }, + "DatasetId": { + "name": "datasetId", + "type": "string", + "in": "path", + "description": "The identifier for the dataset to query from.", + "required": true, + "x-ms-parameter-location": "method" + }, + "Type": { + "name": "type", + "type": "string", + "in": "query", + "description": "The type of data to create the dataset with.", + "enum": [ + "facility" + ], + "x-ms-enum": { + "name": "DatasetType", + "modelAsString": false, + "values": [ + { + "value": "facility", + "description": "Facility Maps data type." + } + ] + }, + "required": true, + "x-ms-parameter-location": "method" + }, + "ImportUdid": { + "name": "udid", + "description": "The unique data ID used to import data into the dataset. The `udid` must have been obtained from a successful call to the Data Service Upload API.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + }, + "ImportType": { + "name": "type", + "type": "string", + "in": "query", + "description": "The type of data to import into the dataset with.", + "enum": [ + "fixture" + ], + "x-ms-enum": { + "name": "ImportDataType", + "modelAsString": false, + "values": [ + { + "value": "fixture", + "description": "Area and point element data." + } + ] + }, + "required": true, + "x-ms-parameter-location": "method" + }, + "AppendDatasetId": { + "name": "datasetId", + "type": "string", + "in": "query", + "description": "The ID for the dataset to append to.", + "required": false, + "x-ms-parameter-location": "method" + }, + "StatusId": { + "name": "statusId", + "type": "string", + "in": "path", + "description": "The ID to query the status for the dataset create/import request.", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/dataset/create": { + "post": { + "x-publish": true, + "description": "**Dataset Create API**\n\n**Applies to:** S1 pricing tier.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API \nand SDK. The Dataset APIs are part of Creator. This API allows the caller to create a dataset from data that \nwas uploaded to the Azure Maps Data Service.\n\nYou can use this API in a scenario like uploading a DWG zip package for a building, converting the zip package using \nthe Azure Maps Conversion Service, creating a dataset from the converted zip package. The created dataset can be \nused to create tilesets using the Azure Maps Tileset Service and can be queried via the Azure Maps WFS Service.\n\n## Submit Create Request\n\nTo create your dataset, you will use a `POST` request where the `conversionId` query parameter is an id that represents \nthe converted DWG zip package, the `type` parameter will describe the data type to use for the dataset, the `datasetId`\nparameter will describe if the provided data should be appended to a current dataset and, optionally, the \n`description` query parameter will contain a description (if description is not provided a default description will be \ngiven).\n\nThe Create API is a \n[long-running request](https://aka.ms/am-creator-lrt).", + "operationId": "Dataset_CreatePreview", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Create dataset from a converted CAD file provided by conversionId": { + "$ref": "./examples/Dataset_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ConversionIdQuery" + }, + { + "$ref": "#/parameters/UdidDataset" + }, + { + "$ref": "#/parameters/Type" + }, + { + "$ref": "#/parameters/AppendDatasetId" + }, + { + "$ref": "#/parameters/DescriptionDataset" + } + ], + "responses": { + "201": { + "$ref": "#/responses/201Async" + }, + "202": { + "$ref": "#/responses/202Async" + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/dataset/import/{datasetId}": { + "patch": { + "x-publish": true, + "description": "**Dataset Import API**\n\n**Applies to:** S1 pricing tier.\n
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API \nand SDK. The Dataset APIs are part of Creator. This API allows the caller to bulk import data into a dataset \nfrom data that was uploaded to the Azure Maps Data service.
\n\n### Submit Import Request\n\nTo import data into your dataset, you will use a `PATCH` request where the `datasetId` query parameter is the \ndataset you want to import your data into, the `udid` query parameter is the data you want to import, and the `type` \nparameter will describe the data type to use for the import data.
\n\nThe Import API is a \n[long-running request](https://aka.ms/am-creator-lrt).", + "operationId": "Dataset_ImportPreview", + "x-ms-examples": { + "Import data into previously created dataset": { + "$ref": "./examples/Dataset_Import.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/DatasetId" + }, + { + "$ref": "#/parameters/ImportUdid" + }, + { + "$ref": "#/parameters/ImportType" + } + ], + "responses": { + "200": { + "$ref": "#/responses/200Async" + }, + "202": { + "$ref": "#/responses/202Async" + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/dataset/{datasetId}": { + "delete": { + "x-publish": true, + "description": "**Dataset Delete API**\n\n**Applies to:** S1 pricing tier.\n
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Dataset APIs are part of Creator.\nThis API allows the caller to delete a previously created dataset.
\nYou can also use this API to delete old/unused datasets to create space for new Creator content.\n\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `datasetId` of the dataset to delete.
\n\n\n### Delete Data Response\n\nThe Delete API returns a HTTP `204 No Content` response if the dataset resource was deleted successfully.
", + "operationId": "Dataset_DeletePreview", + "x-ms-examples": { + "Delete previously created dataset": { + "$ref": "./examples/Dataset_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/DatasetId" + } + ], + "responses": { + "204": { + "description": "The dataset delete request completed successfully. The resource referenced by the `datasetId` was deleted from the server.", + "schema": { + "$ref": "#/definitions/DatasetDeleteResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/dataset": { + "get": { + "x-publish": true, + "description": "**Dataset List API**\n\n**Applies to:** S1 pricing tier.\n
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Dataset APIs are part of Creator.\nThis API allows the caller to fetch a list of all previously successfully created datasets.\n\n\n### Submit List Request\n\nTo list all your datasets, you will issue a `GET` request with no additional parameters.
\n\n\n### List Data Response\n\nThe List API returns the complete list of all datasets in `json` format. The response contains the following fields (if they are not null or empty):\n > created - The timestamp the dataset was created.\n > datasetId - The id for the dataset.\n > description - The description for the dataset.\n > datasetSources - The source data that was used when the create request was issued.\n\nThe `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):\n > conversionIds - The list of `conversionId` (null if none were provided).\n > udids - The list of `udid` (null if none were provided).\n > appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n > type - The type of data stored in the dataset that was created.\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, and `datasetSources` of 3 dataset resources:\n\n
\n\n```json\n{\n \"datasets\": [\n {\n \"timestamp\": \"2020-01-01T22:50:48+00:00\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n \"type\": \"facility\"\n },\n \"status\": \"Succeeded\"\n },\n {\n \"timestamp\": \"2020-01-01T22:57:53+00:00\",\n \"datasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"description\": \"Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.\",\n \"datasetSources\": {\n \"udids\": [\n \"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c\"\n ],\n \"type\": \"facility\"\n },\n \"status\": \"Succeeded\"\n },\n {\n \"timestamp\": \"2020-01-01T20:39:36+00:00\",\n \"datasetId\": \"7c1288fa-2058-4a1b-b68f-13a6h5af7d7c\",\n \"description\": \"Some other description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n \"appendDatasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"type\": \"facility\"\n },\n \"status\": \"Succeeded\"\n }\n ]\n}\n```\n
", + "operationId": "Dataset_ListPreview", + "x-ms-examples": { + "List all the previously created datasets": { + "$ref": "./examples/Dataset_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "The list dataset request completed successfully. The response body contains a list of all the previously created datasets.", + "schema": { + "$ref": "#/definitions/DatasetListResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + } + }, + "definitions": { + "ODataErrorResponse": { + "type": "object", + "description": "This response object is returned when an error occurs in the Maps API.", + "properties": { + "error": { + "$ref": "#/definitions/ODataError" + } + } + }, + "ODataError": { + "type": "object", + "description": "This object is returned when an error occurs in the Maps API.", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The ODataError code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + } + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the target causing the error." + } + } + }, + "LongRunningOperationResult": { + "description": "The response model for a Long-Running Operations API.", + "type": "object", + "properties": { + "operationId": { + "description": "The Id for this long-running operation.", + "type": "string" + }, + "status": { + "description": "The status state of the request.", + "type": "string", + "enum": [ + "NotStarted", + "Running", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": false, + "values": [ + { + "value": "NotStarted", + "description": "The request has not started processing yet." + }, + { + "value": "Running", + "description": "The request has started processing." + }, + { + "value": "Failed", + "description": "The request has one or more failures." + }, + { + "value": "Succeeded", + "description": "The request has successfully completed." + } + ] + }, + "readOnly": true + }, + "created": { + "description": "The created timestamp.", + "type": "string", + "readOnly": true + }, + "resourceLocation": { + "description": "The location URI for details about the created resource. This is only provided when the request was successfully completed.", + "type": "string", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/ODataError" + }, + "warning": { + "$ref": "#/definitions/ODataError" + } + } + }, + "DatasetDeleteResponse": { + "description": "The response model for the Dataset Delete API. The response body will be empty signifying there's no content available for the `datasetId` anymore.", + "type": "object" + }, + "DatasetListResponse": { + "description": "The response model for the Dataset List API. The response body will contain a list of all the previously created datasets.", + "type": "object", + "properties": { + "datasets": { + "description": "A list of all the previously created datasets.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/DatasetDetailInfo" + } + } + } + }, + "DatasetDetailInfo": { + "description": "Detail information for the dataset.", + "type": "object", + "properties": { + "created": { + "description": "The created timestamp for the dataset.", + "type": "string", + "readOnly": true + }, + "datasetId": { + "description": "The id for the dataset.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description for the dataset.", + "type": "string", + "readOnly": true + }, + "datasetSources": { + "$ref": "#/definitions/DatasetSources" + }, + "featureCounts": { + "description": "The feature counts for the dataset.", + "type": "object", + "readOnly": true + } + } + }, + "DatasetSources": { + "description": "Information about the details of the create request for the dataset.", + "type": "object", + "properties": { + "conversionIds": { + "description": "The list of `conversionId` that were used to create the dataset.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "udids": { + "description": "The list of `conversionId` that were used to create the dataset.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "appendDatasetId": { + "description": "The dataset that was appended to to create the current dataset.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of data stored in the dataset.", + "type": "string", + "readOnly": true + } + } + }, + "DatasetGetDetailsResponse": { + "$ref": "#/definitions/DatasetDetailInfo" + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/examples/Dataset_Create.json b/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/examples/Dataset_Create.json new file mode 100644 index 000000000000..6d8513252576 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/examples/Dataset_Create.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "conversionId": "[conversionId]", + "type": "facility" + }, + "responses": { + "201": { + "headers": { + "Location": "https://atlas.microsoft.com/dataset/{datasetId}?api-version=1.0", + "Access-Control-Expose-Headers": "Location" + }, + "body": { + "operationId": "{operationId}", + "status": "Succeeded", + "created": "2020-01-02 1:02:03 AM +00:00", + "resourceLocation": "https://atlas.microsoft.com/dataset/{datasetId}?api-version=1.0" + } + }, + "202": { + "headers": { + "Location": "https://atlas.microsoft.com/dataset/operations/{operationId}?api-version=1.0", + "Access-Control-Expose-Headers": "Location" + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request - Error message." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found - The requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "Unknown error - An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/examples/Dataset_Delete.json b/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/examples/Dataset_Delete.json new file mode 100644 index 000000000000..3ad9cf60de1c --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/examples/Dataset_Delete.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "datasetId": "[datasetId]" + }, + "responses": { + "204": { + "body": {} + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request - One or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found - The requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "Unknown error - An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/examples/Dataset_Import.json b/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/examples/Dataset_Import.json new file mode 100644 index 000000000000..fa4cb9ca8950 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/examples/Dataset_Import.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "datasetId": "[conversionId]", + "udid": "[udid]", + "type": "fixture" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "operationId": "{operationId}", + "status": "Succeeded", + "created": "2020-01-02 03:04:05 AM +00:00", + "resourceLocation": "https://atlas.microsoft.com/dataset/{datasetId}?api-version=1.0" + } + }, + "202": { + "headers": { + "Location": "https://atlas.microsoft.com/dataset/operations/{operationId}?api-version=1.0", + "Access-Control-Expose-Headers": "Location" + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request - Error message." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found - The requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "Unknown error - An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/examples/Dataset_List.json b/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/examples/Dataset_List.json new file mode 100644 index 000000000000..4937c40e2e95 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Dataset/preview/1.0/examples/Dataset_List.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "datasets": [ + { + "created": "2020-01-02 3:04:05 AM +00:00", + "datasetId": "f6495f62-94f8-0ec2-c252-45626f82fcb2", + "description": "Some description or comment for the dataset.", + "datasetSources": { + "conversionIds": [ + "15d21452-c9bb-27b6-5e79-743ca5c3205d" + ], + "type": "facility" + }, + "featureCounts": { + "directoryInfo": 1, + "category": 18, + "facility": 1, + "level": 6, + "unit": 775, + "opening": 471, + "areaElement": 496 + } + }, + { + "created": "2020-01-02 3:04:05 PM +00:00", + "datasetId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "description": "Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.", + "datasetSources": { + "udids": [ + "0c1288fa-2058-4a1b-b68d-13a5f5af7d7c" + ], + "type": "facility" + }, + "featureCounts": { + "directoryInfo": 1, + "category": 2, + "facility": 1, + "level": 6, + "unit": 19 + } + }, + { + "created": "2020-01-02 3:04:05 AM +00:00", + "datasetId": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c", + "description": "Some other description or comment for the dataset.", + "datasetSources": { + "conversionIds": [ + "15d21452-c9bb-27b6-5e79-743ca5c3205d" + ], + "appendDatasetId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "type": "facility" + }, + "featureCounts": { + "directoryInfo": 1, + "category": 1, + "facility": 1, + "level": 1, + "unit": 10 + } + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request - One or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found - The requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "Unknown error - An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/dwgconversion.json b/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/dwgconversion.json new file mode 100644 index 000000000000..1d5486f6caba --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/dwgconversion.json @@ -0,0 +1,474 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Conversion Service", + "version": "1.0", + "description": "APIs for converting DWG Packages in Azure Maps." + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "user_impersonation": "Impersonates a user's Azure Active Directory account." + } + }, + "apiKeyQuery": { + "type": "apiKey", + "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + } + }, + "security": [ + { + "azure_auth": [] + }, + { + "apiKeyQuery": [] + } + ], + "responses": { + "400": { + "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "401": { + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + }, + "headers": { + "WWW-Authenticate": { + "type": "string", + "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" + } + } + }, + "403": { + "description": "Permission, capacity, or authentication issues.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "404": { + "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "500": { + "description": "An error occurred while processing the request. Please try again later.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "201Async": { + "description": "The resource has been created successfully.", + "schema": { + "$ref": "#/definitions/LongRunningOperationResult" + }, + "headers": { + "Location": { + "type": "string", + "description": "A URI where details on the newly created resource can be found." + } + } + }, + "202Async": { + "description": "**Supported only for async request.**\nRequest Accepted: The request has been accepted for processing. Please use the URL in the Location Header to retry or access the results.", + "headers": { + "Location": { + "type": "string", + "description": "New URL to check for the results of the long running process." + } + } + } + }, + "parameters": { + "ClientId": { + "name": "x-ms-client-id", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "client" + }, + "SubscriptionKey": { + "name": "subscription-key", + "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API. Current version is 1.0", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "UdidQuery": { + "name": "udid", + "description": "The unique data id for the content. The `udid` must have been obtained from a successful [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadpreview) call.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "ConversionId": { + "name": "conversionId", + "description": "The conversion id for the content. The `conversionId` must have been obtained from a successful [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/conversion/convertpreview) call.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "ConversionInputType": { + "name": "inputType", + "description": "Input type of the content being converted. Currently, only `DWG` type is supported.", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "DWG" + ], + "x-ms-enum": { + "name": "ConversionInputType", + "modelAsString": false, + "values": [ + { + "value": "DWG", + "description": "DWG file format." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "DescriptionDwgConversion": { + "name": "description", + "description": "User provided description of the content being converted.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/conversion/convert": { + "post": { + "x-publish": true, + "description": "**Conversion Create API**\n\n**Applies to:** S1 pricing tier.
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and \nSDK. The Conversion API is part of Creator.
\n\nThe Conversion API lets the caller import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps. The [Drawing Package](https://aka.ms/am-drawing-package) should first be \nuploaded using the [Azure Maps Data Service](https://docs.microsoft.com/rest/api/maps/data). Once uploaded, use the \n`udid` returned by the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data/uploadpreview) to call \nthis Conversion API.\n\n## Convert DWG package\n\nThe Conversion API performs a \n[long-running request](https://aka.ms/am-creator-lrt).\n\n## Debug DWG package issues\n\n\nDuring the Conversion process, if there are any issues with the DWG package [errors and warnings](https://aka.ms/am-conversion-errors) are provided in the response along with a *diagnostic package* to visualize \nand diagnose these issues. In case any issues are encountered with your DWG package, the Conversion operation status process as detailed \n[here](https://aka.ms/am-creator-lrt) returns the location of the *diagnostic\npackage* that can be downloaded by the caller to help them visualize and diagnose these issues. The *diagnostic package* location\ncan be found in the properties section of the conversion operation status response and looks like the following:\n\n```json\n{\n \"properties\": {\n \"diagnosticPackageLocation\": \"https://atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0\" \n } \n}\n```\n\nThe *diagnostic package* can be downloaded by executing a `HTTP GET` request on the `diagnosticPackageLocation`.\nFor more details on how to use the tool to visualize and diagnose all the errors and warnings see [Drawing Error Visualizer](https://aka.ms/am-drawing-errors-visualizer).
\n\nA conversion operation will be marked as *success* if there are zero or more warnings but will be marked as *failed* if any errors are encountered. ", + "operationId": "Conversion_ConvertPreview", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Convert previously uploaded DWG Package": { + "$ref": "./examples/Conversion.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/UdidQuery" + }, + { + "$ref": "#/parameters/ConversionInputType" + }, + { + "$ref": "#/parameters/DescriptionDwgConversion" + } + ], + "responses": { + "201": { + "$ref": "#/responses/201Async" + }, + "202": { + "$ref": "#/responses/202Async" + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/conversion": { + "get": { + "x-publish": true, + "description": "**Conversion List API**\n\n**Applies to:** S1 pricing tier.
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Conversion API is part of Creator.
\n\nThis API allows the caller to fetch a list of all successful data conversions submitted previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/conversion/convertpreview). \n\n### Submit List Request\n\nTo list all successful conversions you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe Conversion List API returns the complete list of all conversion details in `json` format.
\n\nHere is a sample response returning the details of two successful conversion requests: \n\n
\n\n```json\n{\n \"conversions\": \n [\n {\n \"conversionId\": \"54398242-ea6c-1f31-4fa6-79b1ae0fc24d\",\n \"udid\": \"31838736-8b84-11ea-bc55-0242ac130003\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n },\n {\n \"conversionId\": \"2acf7d32-8b84-11ea-bc55-0242ac130003\",\n \"udid\": \"1214bc58-8b84-11ea-bc55-0242ac1300039\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n }\n ]\n}\n```\n\n
", + "operationId": "Conversion_ListPreview", + "x-ms-examples": { + "Returns a list of all the data processed by the Conversion Service for the account": { + "$ref": "./examples/List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "List request completed successfully.", + "schema": { + "$ref": "#/definitions/ConversionListResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/conversion/{conversionId}": { + "delete": { + "x-publish": true, + "description": "**Conversion Delete API**\n\n**Applies to:** S1 pricing tier.
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Delete API is part of Creator.
\n\nThis API allows the caller to delete any data conversions created previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/conversion/convertpreview).\n\n### Submit Delete Request\n\nTo delete your conversion data you will issue a `DELETE` request where the path will contain the `conversionId` of the data to delete.\n\n### Conversion Delete Response\n\nThe Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if no resource associated with the passed-in `conversionId` is found. ", + "operationId": "Conversion_DeletePreview", + "x-ms-examples": { + "Delete previously converted content": { + "$ref": "./examples/Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ConversionId" + } + ], + "responses": { + "204": { + "description": "Conversion delete request completed successfully. The content for `conversionId` was deleted on the server.", + "schema": { + "$ref": "#/definitions/ConversionDeleteResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + } + }, + "definitions": { + "ODataErrorResponse": { + "type": "object", + "description": "This response object is returned when an error occurs in the Maps API.", + "properties": { + "error": { + "$ref": "#/definitions/ODataError" + } + } + }, + "ODataError": { + "type": "object", + "description": "This object is returned when an error occurs in the Maps API.", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The ODataError code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + } + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the target causing the error." + } + } + }, + "LongRunningOperationResult": { + "description": "The response model for a Long-Running Operations API.", + "type": "object", + "properties": { + "operationId": { + "description": "The Id for this long-running operation.", + "type": "string" + }, + "status": { + "description": "The status state of the request.", + "type": "string", + "enum": [ + "NotStarted", + "Running", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": false, + "values": [ + { + "value": "NotStarted", + "description": "The request has not started processing yet." + }, + { + "value": "Running", + "description": "The request has started processing." + }, + { + "value": "Failed", + "description": "The request has one or more failures." + }, + { + "value": "Succeeded", + "description": "The request has successfully completed." + } + ] + }, + "readOnly": true + }, + "created": { + "description": "The created timestamp.", + "type": "string", + "readOnly": true + }, + "resourceLocation": { + "description": "The location URI for details about the created resource. This is only provided when the request was successfully completed.", + "type": "string", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/ODataError" + }, + "warning": { + "$ref": "#/definitions/ODataError" + } + } + }, + "ConversionListResponse": { + "description": "The response model for the Conversion List API.", + "type": "object", + "properties": { + "conversions": { + "description": "A list of all the previously submitted conversion requests.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ConversionListDetailInfo" + } + } + } + }, + "ConversionListDetailInfo": { + "description": "Detail information for the conversion requests.", + "type": "object", + "properties": { + "conversionId": { + "description": "A unique id that represents the artifact of a _successfully_ completed conversion process.", + "type": "string", + "readOnly": true + }, + "udid": { + "description": "The unique id of the content provided to create this conversion.", + "type": "string", + "readOnly": true + }, + "created": { + "description": "The date and time of this conversion.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "User provided description of the content being converted.", + "type": "string", + "readOnly": true + }, + "featureCounts": { + "description": "A summary of feature counts in this conversion.", + "type": "object", + "readOnly": true + } + } + }, + "ConversionDeleteResponse": { + "description": "The response model for the Conversion Delete API. The response body will be empty signifying there's no content available for the `conversionId` anymore.", + "type": "object" + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/examples/Conversion.json b/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/examples/Conversion.json new file mode 100644 index 000000000000..b9af945a36d8 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/examples/Conversion.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "udid": "25084fb7-307a-4720-8f91-7952a0b91012", + "inputType": "DWG" + }, + "responses": { + "201": { + "headers": { + "Location": "https://atlas.microsoft.com/conversion/{conversionId}?api-version=1.0", + "Access-Control-Expose-Headers": "Location" + }, + "body": { + "operationId": "{operationId}", + "status": "Succeeded", + "created": "2020-01-02 1:02:03 AM +00:00", + "resourceLocation": "https://atlas.microsoft.com/conversion/{conversionId}?api-version=1.0" + } + }, + "202": { + "headers": { + "Location": "https://atlas.microsoft.com/conversion/operations/{operationId}?api-version=1.0", + "Access-Control-Expose-Headers": "Location" + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/examples/Delete.json b/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/examples/Delete.json new file mode 100644 index 000000000000..a0858462d16c --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/examples/Delete.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "conversionId": "99884fb7-87a9-0920-7f93-7952a0b91012" + }, + "responses": { + "204": { + "body": {} + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/examples/List.json b/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/examples/List.json new file mode 100644 index 000000000000..357a0d0ab352 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/DwgConversion/preview/1.0/examples/List.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "conversions": [ + { + "conversionId": "54398242-ea6c-1f31-4fa6-79b1ae0fc24d", + "udid": "31838736-8b84-11ea-bc55-0242ac130003", + "created": "5/19/2020 9:00:00 AM +00:00", + "description": "User provided description.", + "featureCounts": { + "directoryInfo": 1, + "level": 3, + "facility": 1, + "unit": 150, + "category": 8, + "areaElement": 0, + "opening": 10 + } + }, + { + "conversionId": "2acf7d32-8b84-11ea-bc55-0242ac130003", + "udid": "1214bc58-8b84-11ea-bc55-0242ac1300039", + "created": "5/19/2020 9:00:00 AM +00:00", + "description": "User provided description.", + "featureCounts": { + "directoryInfo": 1, + "level": 3, + "facility": 1, + "unit": 150, + "category": 8, + "areaElement": 0, + "opening": 10 + } + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/CreateStateset.json b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/CreateStateset.json new file mode 100644 index 000000000000..3b48b2acdd73 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/CreateStateset.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "datasetId": "5d34fbe8-87b7-f7c0-3144-c50e003a3c75", + "statesetCreateRequestBody": { + "styles": [ + { + "keyname": "s1", + "type": "boolean", + "rules": [ + { + "true": "#FF0000", + "false": "#00FF00" + } + ] + }, + { + "keyname": "s2", + "type": "number", + "rules": [ + { + "range": { + "exclusiveMaximum": 50 + }, + "color": "#343deb" + }, + { + "range": { + "minimum": 50, + "exclusiveMaximum": 70 + }, + "color": "#34ebb1" + }, + { + "range": { + "minimum": 70, + "exclusiveMaximum": 90 + }, + "color": "#eba834" + }, + { + "range": { + "minimum": 90 + }, + "color": "#eb3434" + } + ] + } + ] + } + }, + "responses": { + "200": { + "body": { + "statesetId": "b24bdb73-1305-3212-1909-a428d937b64f" + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/DeleteFeatureState.json b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/DeleteFeatureState.json new file mode 100644 index 000000000000..86a97a62d209 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/DeleteFeatureState.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "statesetId": "b24bdb73-1305-3212-1909-a428d937b64", + "featureId": "SPC4709", + "stateKeyName": "keyName1" + }, + "responses": { + "200": {}, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "409": { + "headers": {}, + "body": { + "error": { + "code": "409 Conflict", + "message": "The request could not be completed due to a conflict with the current state of the resource." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/DeleteStateset.json b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/DeleteStateset.json new file mode 100644 index 000000000000..e6bf9ebe20a6 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/DeleteStateset.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "statesetId": "b24bdb73-1305-3212-1909-a428d937b64f" + }, + "responses": { + "204": {}, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/GetStates.json b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/GetStates.json new file mode 100644 index 000000000000..e581ce3b7b5d --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/GetStates.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "statesetId": "b24bdb73-1305-3212-1909-a428d937b64", + "featureId": "SPC4709" + }, + "responses": { + "200": { + "body": { + "states": [ + { + "keyName": "s1", + "value": true, + "eventTimestamp": "2019-08-16 13:01" + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/GetStateset.json b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/GetStateset.json new file mode 100644 index 000000000000..5d2a45831fbf --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/GetStateset.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "statesetId": "b24bdb73-1305-3212-1909-a428d937b64" + }, + "responses": { + "200": { + "body": { + "datasetIdList": [ + "8d700cc7-fd2c-4e21-b402-ad3f5e524f36" + ], + "statesetStyle": { + "styles": [ + { + "keyName": "s1", + "type": "boolean", + "rules": [ + { + "true": "#FFFF00", + "false": "#FFFFFF" + } + ] + }, + { + "keyName": "s2", + "type": "number", + "rules": [ + { + "range": { + "minimum": null, + "maximum": null, + "exclusiveMinumum": null, + "exclusiveMaximum": "50" + }, + "color": "#343deb" + }, + { + "range": { + "minimum": "50", + "maximum": null, + "exclusiveMinumum": null, + "exclusiveMaximum": "69" + }, + "color": "#34ebb1" + }, + { + "range": { + "minimum": "69", + "maximum": null, + "exclusiveMinumum": null, + "exclusiveMaximum": "90" + }, + "color": "#eba834" + }, + { + "range": { + "minimum": "90", + "maximum": null, + "exclusiveMinumum": null, + "exclusiveMaximum": null + }, + "color": "#eb3434" + } + ] + } + ] + } + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/Stateset_List.json b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/Stateset_List.json new file mode 100644 index 000000000000..bf547d808b57 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/Stateset_List.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "statesetDetailList": [ + { + "statesetId": "09abcdf8-cad0-b3dd-a38f-d5ee3cff5eea", + "datasetIdList": [ + "8d700cc7-fd2c-4e21-b402-ad3f5e524f36" + ], + "statesetStyle": { + "styles": [ + { + "keyName": "s1", + "type": "boolean", + "rules": [ + { + "true": "#0FFF00", + "false": "#00FFF0" + } + ] + }, + { + "keyName": "s2", + "type": "number", + "rules": [ + { + "range": { + "minimum": null, + "maximum": null, + "exclusiveMinumum": null, + "exclusiveMaximum": "50" + }, + "color": "#343deb" + }, + { + "range": { + "minimum": "50", + "maximum": null, + "exclusiveMinumum": null, + "exclusiveMaximum": "69" + }, + "color": "#34ebb1" + }, + { + "range": { + "minimum": "69", + "maximum": null, + "exclusiveMinumum": null, + "exclusiveMaximum": "90" + }, + "color": "#eba834" + }, + { + "range": { + "minimum": "90", + "maximum": null, + "exclusiveMinumum": null, + "exclusiveMaximum": null + }, + "color": "#eb3434" + } + ] + } + ] + } + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/UpdateStates.json b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/UpdateStates.json new file mode 100644 index 000000000000..d19d997f16f9 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/UpdateStates.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "statesetId": "b24bdb73-1305-3212-1909-a428d937b64", + "featureId": "SPC4709", + "featureStateUpdateRequestBody": { + "states": [ + { + "keyName": "s1", + "value": true, + "eventTimestamp": "2019-08-16 13:01" + } + ] + } + }, + "responses": { + "200": {}, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/UpdateStateset.json b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/UpdateStateset.json new file mode 100644 index 000000000000..e540bcda431a --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/examples/UpdateStateset.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "statesetId": "b24bdb73-1305-3212-1909-a428d937b64", + "statesetStyleUpdateRequestBody": { + "styles": [ + { + "keyname": "s1", + "type": "boolean", + "rules": [ + { + "true": "#FFFF00", + "false": "#FFFFFF" + } + ] + }, + { + "keyname": "s2", + "type": "number", + "rules": [ + { + "range": { + "exclusiveMaximum": 50 + }, + "color": "#343deb" + }, + { + "range": { + "minimum": 50, + "exclusiveMaximum": 69 + }, + "color": "#34ebb1" + }, + { + "range": { + "minimum": 69, + "exclusiveMaximum": 90 + }, + "color": "#eba834" + }, + { + "range": { + "minimum": 90 + }, + "color": "#eb3434" + } + ] + } + ] + } + }, + "responses": { + "200": {}, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/featurestate.json b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/featurestate.json new file mode 100644 index 000000000000..ec38059a4d5b --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/FeatureState/preview/1.0/featurestate.json @@ -0,0 +1,804 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Feature State Service", + "version": "1.0", + "description": "APIs for managing the dynamic feature states in Azure Maps." + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "user_impersonation": "Impersonates a user's Azure Active Directory account." + } + }, + "apiKeyQuery": { + "type": "apiKey", + "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + } + }, + "security": [ + { + "azure_auth": [] + }, + { + "apiKeyQuery": [] + } + ], + "responses": { + "400": { + "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "401": { + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + }, + "headers": { + "WWW-Authenticate": { + "type": "string", + "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" + } + } + }, + "403": { + "description": "Permission, capacity, or authentication issues.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "404": { + "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "409": { + "description": "The request could not be completed due to a conflict with the current state of the resource. Likely caused by a parallel update to the same resource.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "500": { + "description": "An error occurred while processing the request. Please try again later.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + } + }, + "parameters": { + "SubscriptionKey": { + "name": "subscription-key", + "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API. Current version is 1.0", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "DatasetIdForCreate": { + "name": "datasetId", + "description": "The datasetId must have been obtained from a successful [Dataset Create API](https://review.docs.microsoft.com/en-us/rest-staging/api/maps-master/dataset/createpreview?branch=lbs) call.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "StatesetId": { + "name": "statesetId", + "description": "The stateset id that was created.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "StatesetIdInPath": { + "name": "statesetId", + "description": "The stateset id that was created.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "FeatureIdSet": { + "name": "featureId", + "description": "The id of a feature in the given dataset. If the featureId is not present in the dataset, Bad Request response will be returned.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "FeatureIdGet": { + "name": "featureId", + "description": "The id of a feature in the given stateset. If no state was set for the featureId in the stateset earlier, Bad Request response will be returned.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "FeatureIdDelete": { + "name": "featureId", + "description": "The id of a feature in the given stateset. If no state was set for the featureId in the stateset earlier, Bad Request response will be returned.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "StateKeyNameDelete": { + "name": "stateKeyName", + "description": "The Name of the state to be deleted.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/featureState/stateset/{statesetId}": { + "get": { + "x-publish": true, + "description": "**Applies to:** S1 pricing tier.\n
\n\nThis GET API allows the user to get the stateset Information.\n\nThe stateset Information includes the datasetId associated to the stateset, and the styles of that stateset.", + "operationId": "FeatureState_GetStatesetPreview", + "x-ms-examples": { + "Get stateset information with a statesetId": { + "$ref": "./examples/GetStateset.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StatesetIdInPath" + } + ], + "responses": { + "200": { + "description": "Get request completed successfully.", + "schema": { + "$ref": "#/definitions/StatesetGetResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + }, + "delete": { + "x-publish": true, + "description": "**Applies to:** S1 pricing tier.
This DELETE API allows the user to delete the stateset and the associated data.", + "operationId": "FeatureState_DeleteStatesetPreview", + "x-ms-examples": { + "Delete an existing stateset": { + "$ref": "./examples/DeleteStateset.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StatesetIdInPath" + } + ], + "responses": { + "204": { + "description": "Stateset Deleted." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + }, + "put": { + "x-publish": true, + "description": "**Applies to:** S1 pricing tier.\n
\n\nThis PUT API allows the user to update the stateset style rules.", + "operationId": "FeatureState_PutStatesetPreview", + "x-ms-examples": { + "Update stateset style rules with a statesetId": { + "$ref": "./examples/UpdateStateset.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StatesetIdInPath" + }, + { + "name": "statesetStyleUpdateRequestBody", + "in": "body", + "description": "The stateset style JSON data. Only style rules are allowed to be updated, update on keyname and type is not allowed.", + "required": true, + "schema": { + "$ref": "#/definitions/StylesObject" + } + } + ], + "responses": { + "200": { + "description": "Stateset styles are updated successfully." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/featureState/stateset": { + "post": { + "x-publish": true, + "description": "**Applies to:** S1 pricing tier.\n
\n\nThis POST API allows the user to create a new Stateset and define stateset style using request body.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Feature State API is part of Creator. \n\nThe Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here.\n\nThis Feature State service pivot on the Stateset. Like Tileset, Stateset encapsulates the storage mechanism for feature states for a dataset.\n\nOnce the stateset is created, users can use that statesetId to post feature state updates and retrieve the current feature states. A feature can have any number of states. \n\nFeature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state’s timestamp is later than the stored timestamp. \n\nAzure Maps MapControl provides a way to use these feature states to style the features. Please refer to the State Tile documentation for more information.", + "operationId": "FeatureState_CreateStatesetPreview", + "x-ms-examples": { + "Create a new stateset with a datasetId": { + "$ref": "./examples/CreateStateset.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/DatasetIdForCreate" + }, + { + "name": "statesetCreateRequestBody", + "in": "body", + "description": "The stateset style JSON data.", + "required": true, + "schema": { + "$ref": "#/definitions/StylesObject" + } + } + ], + "responses": { + "200": { + "description": "Stateset created.", + "schema": { + "$ref": "#/definitions/StatesetCreatedResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + }, + "get": { + "x-publish": true, + "description": "**Applies to:** S1 pricing tier.
This API allows the caller to fetch a list of all previously successfully created statesets.", + "operationId": "FeatureState_ListStatesetPreview", + "x-ms-examples": { + "List all the previously created statesets": { + "$ref": "./examples/Stateset_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "The list stateset request completed successfully. The response body contains a list of all the previously created statesets.", + "schema": { + "$ref": "#/definitions/StatesetListResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/featureState/state": { + "get": { + "x-publish": true, + "operationId": "FeatureState_GetStatesPreview", + "description": "**Applies to:** S1 pricing tier.
This API returns the current state information associated with the given feature in the given stateset.", + "x-ms-examples": { + "Get the current states of a feature": { + "$ref": "./examples/GetStates.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StatesetId" + }, + { + "$ref": "#/parameters/FeatureIdGet" + } + ], + "responses": { + "200": { + "description": "Get request completed successfully.", + "schema": { + "$ref": "#/definitions/FeatureStatesStructure" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + }, + "post": { + "x-publish": true, + "operationId": "FeatureState_UpdateStatesPreview", + "description": "**Applies to:** S1 pricing tier.
\nThis POST API allows the user to update the state of the given feature in the given stateset.", + "x-ms-examples": { + "Update the states of a feature": { + "$ref": "./examples/UpdateStates.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StatesetId" + }, + { + "$ref": "#/parameters/FeatureIdSet" + }, + { + "name": "featureStateUpdateRequestBody", + "in": "body", + "description": "The feature state JSON data. A feature can have only one state at a given point in time. The specified state keyname must have been defined during the stateset creation.", + "required": true, + "schema": { + "$ref": "#/definitions/FeatureStatesStructure" + } + } + ], + "responses": { + "200": { + "description": "Feature states are updated successfully." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + }, + "delete": { + "x-publish": true, + "operationId": "FeatureState_DeleteStatePreview", + "description": "**Applies to:** S1 pricing tier.
This API deletes the state information identified by the StateKeyName parameter for the feature identified by the FeatureId parameter in the the stateset.", + "x-ms-examples": { + "Delete the given feature state": { + "$ref": "./examples/DeleteFeatureState.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StatesetId" + }, + { + "$ref": "#/parameters/FeatureIdDelete" + }, + { + "$ref": "#/parameters/StateKeyNameDelete" + } + ], + "responses": { + "200": { + "description": "Feature states deleted successfully." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "409": { + "$ref": "#/responses/409" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + } + }, + "definitions": { + "ODataErrorResponse": { + "type": "object", + "description": "This response object is returned when an error occurs in the Maps API.", + "properties": { + "error": { + "$ref": "#/definitions/ODataError" + } + } + }, + "ODataError": { + "type": "object", + "description": "This object is returned when an error occurs in the Maps API.", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The ODataError code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + } + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the target causing the error." + } + } + }, + "StatesetGetResponse": { + "description": "The response model for the successful Stateset Get API.", + "type": "object", + "properties": { + "datasetIdList": { + "description": "Dataset ID associated with the stateset.", + "type": "array", + "items": { + "type": "string" + } + }, + "statesetStyle": { + "$ref": "#/definitions/StylesObject" + } + } + }, + "StatesetListResponse": { + "description": "The response model for the successful Stateset List API.", + "type": "object", + "properties": { + "statesetDetailList": { + "description": "A list of statesets information.", + "type": "array", + "items": { + "$ref": "#/definitions/StatesetInfoObject" + } + } + } + }, + "StatesetInfoObject": { + "description": "The stateset information detail.", + "type": "object", + "properties": { + "statesetId": { + "description": "The stateset ID of this stateset.", + "type": "string" + }, + "datasetIdList": { + "description": "Dataset ID associated with the stateset.", + "type": "array", + "items": { + "type": "string" + } + }, + "statesetStyle": { + "$ref": "#/definitions/StylesObject" + } + } + }, + "StatesetCreatedResponse": { + "description": "The response model for the successful Stateset Create API.", + "type": "object", + "properties": { + "statesetId": { + "description": "The ID for the new stateset created.", + "type": "string", + "readOnly": true + } + } + }, + "FeatureStatesStructure": { + "description": "The feature states model for a feature.", + "type": "object", + "properties": { + "states": { + "description": "The feature states array.", + "type": "array", + "items": { + "$ref": "#/definitions/FeatureStateObject" + } + } + } + }, + "FeatureStateObject": { + "description": "Single feature state model.", + "type": "object", + "properties": { + "keyName": { + "description": "Feature state Keyname.", + "type": "string" + }, + "value": { + "description": "Value for the feature state.", + "type": "object" + }, + "eventTimestamp": { + "description": "Timestamp when the feature state was captured.", + "type": "string" + } + } + }, + "StylesObject": { + "description": "The styles model.", + "type": "object", + "properties": { + "styles": { + "description": "An array of stateset styles.", + "type": "array", + "items": { + "$ref": "#/definitions/StyleObject" + } + } + } + }, + "StyleObject": { + "description": "The stateset style model. The style rule could be a numeric type style rule or a boolean type style rule. Refer to NumberRuleObject and BooleanRuleObject definition.", + "type": "object" + }, + "NumberRuleObject": { + "description": "The numeric rule", + "type": "object", + "properties": { + "range": { + "$ref": "#/definitions/RangeObject" + }, + "color": { + "description": "Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB (\"#ff0\", \"#ffff00\", \"rgb(255, 255, 0)\"), RGBA (\"rgba(255, 255, 0, 1)\"), HSL(\"hsl(100, 50%, 50%)\"), and HSLA(\"hsla(100, 50%, 50%, 1)\"). Predefined HTML colors names, like yellow and blue, are also permitted.", + "type": "string" + } + } + }, + "RangeObject": { + "description": "The numeric value range for this style rule, If the value is in the range, all the conditions must hold true.", + "type": "object", + "properties": { + "minimum": { + "description": "All the number x that x ≥ minimum.", + "type": "number", + "format": "double" + }, + "maximum": { + "description": "All the number x that x ≤ maximum.", + "type": "number", + "format": "double" + }, + "exclusiveMinimum": { + "description": "All the number x that x > exclusiveMinimum.", + "type": "number", + "format": "double" + }, + "exclusiveMaximum": { + "description": "All the number x that x < exclusiveMaximum.", + "type": "number", + "format": "double" + } + } + }, + "BooleanRuleObject": { + "description": "the boolean rule", + "type": "object", + "properties": { + "true": { + "description": "The color when value is true", + "type": "string" + }, + "false": { + "description": "The color when value is false", + "type": "string" + } + } + }, + "StyleRuleBase": { + "description": "contains common properties for numeric style rules and boolean style rules.", + "discriminator": "type", + "required": [ + "keyName", + "type" + ], + "properties": { + "keyName": { + "description": "Stateset style key name. Key names are random strings but they should be unique inside style array.", + "type": "string" + }, + "type": { + "description": "The type of stateset style.", + "type": "string", + "enum": [ + "number", + "boolean" + ] + } + } + }, + "BooleanTypeStyleRule": { + "description": "the boolean type style rule object.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StyleRuleBase" + } + ], + "properties": { + "rules": { + "description": "Boolean style rules.", + "type": "array", + "items": { + "$ref": "#/definitions/BooleanRuleObject" + } + } + } + }, + "NumberTypeStyleRule": { + "description": "The numeric type style rule object.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StyleRuleBase" + } + ], + "properties": { + "rules": { + "description": "Numeric style rules.", + "type": "array", + "items": { + "$ref": "#/definitions/NumberRuleObject" + } + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Feedback/preview/1.0/feedback.json b/specification/maps/data-plane/Microsoft.Maps/Feedback/preview/1.0/feedback.json new file mode 100644 index 000000000000..c6c282364104 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Feedback/preview/1.0/feedback.json @@ -0,0 +1,685 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Feedback Service", + "version": "1.0" + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json", + "application/xml" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "user_impersonation": "Impersonates a user's Azure Active Directory account." + } + }, + "apiKeyQuery": { + "type": "apiKey", + "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + } + }, + "security": [ + { + "azure_auth": [] + }, + { + "apiKeyQuery": [] + } + ], + "responses": { + "400": { + "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "401": { + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + }, + "headers": { + "WWW-Authenticate": { + "type": "string", + "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" + } + } + }, + "403": { + "description": "Permission, capacity, or authentication issues.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "404": { + "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "500": { + "description": "An error occurred while processing the request. Please try again later.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + } + }, + "parameters": { + "ClientId": { + "name": "x-ms-client-id", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "client" + }, + "SubscriptionKey": { + "name": "subscription-key", + "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API. Current version is 1.0", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + } + }, + "paths": {}, + "definitions": { + "ODataErrorResponse": { + "type": "object", + "description": "This response object is returned when an error occurs in the Maps API.", + "properties": { + "error": { + "$ref": "#/definitions/ODataError" + } + } + }, + "ODataError": { + "type": "object", + "description": "This object is returned when an error occurs in the Maps API.", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The ODataError code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + } + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the target causing the error." + } + } + }, + "GeoJSONPosition": { + "description": "A valid `GeoJSON Position` geometry type. A `Position` is an array of numbers with two or more elements. The first two elements are _longitude_ and _latitude_, precisely in that order. _Altitude/Elevation_ is an optional third element. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.1) for details.", + "type": "array", + "items": { + "type": "number", + "format": "double" + } + }, + "GeoJSONGeometry": { + "description": "A valid `GeoJSON` geometry object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1) for details.", + "type": "object", + "discriminator": "type", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "Specifies the `GeoJSON` geometry type. Must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection.", + "type": "string", + "enum": [ + "Point", + "MultiPoint", + "LineString", + "MultiLineString", + "Polygon", + "MultiPolygon", + "GeometryCollection" + ], + "x-ms-enum": { + "name": "GeoJSONGeometryType", + "modelAsString": false, + "values": [ + { + "value": "Point", + "description": "`GeoJSON Point` geometry." + }, + { + "value": "MultiPoint", + "description": "`GeoJSON MultiPoint` geometry." + }, + { + "value": "LineString", + "description": "`GeoJSON LineString` geometry." + }, + { + "value": "MultiLineString", + "description": "`GeoJSON MultiLineString` geometry." + }, + { + "value": "Polygon", + "description": "`GeoJSON Polygon` geometry." + }, + { + "value": "MultiPolygon", + "description": "`GeoJSON MultiPolygon` geometry." + }, + { + "value": "GeometryCollection", + "description": "`GeoJSON GeometryCollection` geometry." + } + ] + } + } + } + }, + "Point": { + "description": "A valid `GeoJSON Point` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.2) for details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJSONGeometry" + }, + { + "properties": { + "type": { + "description": "Specifies the `type` for the geometry. Value should always be equal to \"Point\".", + "type": "string" + }, + "coordinates": { + "$ref": "#/definitions/GeoJSONPosition" + } + }, + "required": [ + "coordinates" + ] + } + ] + }, + "GeoJsonBoundingBox": { + "description": "Bounding Box. The bounding box is an array of length 2*n where n is\nthe number of dimensions represented in the contained geometries,\nwith all axes of the most southwesterly point followed by all axes\nof the more northeasterly point. The axes order of a bbox follows\nthe axes order of geometries.\n\nThe edges of the bounding box follow lines of constant longitude,\nlatitude, and elevation.", + "type": "array", + "items": { + "type": "number", + "format": "double" + } + }, + "Geometry": { + "description": "This represents the geometry for one or more geographical features (parks, state boundary etc.) and should be a `GeoJSON` compliant type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946) for details.", + "type": "object" + }, + "FeedbackStatusResponse": { + "type": "object", + "required": [ + "formatVersion", + "feedbackId", + "status", + "createDate", + "featureType", + "action", + "request" + ], + "properties": { + "formatVersion": { + "type": "string" + }, + "feedbackId": { + "type": "string" + }, + "status": { + "type": "string" + }, + "createDate": { + "type": "string" + }, + "featureType": { + "type": "string" + }, + "action": { + "type": "string" + }, + "request": { + "description": "The original request object.", + "type": "object" + } + } + }, + "FeedbackAddPoiRequestBody": { + "type": "object", + "required": [ + "location", + "bbox", + "feature" + ], + "properties": { + "isMock": { + "type": "boolean" + }, + "location": { + "$ref": "#/definitions/GeoJSONPosition" + }, + "bbox": { + "$ref": "#/definitions/GeoJsonBoundingBox" + }, + "comments": { + "type": "string" + }, + "contactInformation": { + "$ref": "#/definitions/FeedbackContactInformation" + }, + "feature": { + "$ref": "#/definitions/FeedbackPoiFeature" + } + } + }, + "FeedbackFixPoiRequestBody": { + "type": "object", + "required": [ + "location", + "bbox", + "feature" + ], + "properties": { + "isMock": { + "type": "boolean" + }, + "location": { + "$ref": "#/definitions/GeoJSONPosition" + }, + "bbox": { + "$ref": "#/definitions/GeoJsonBoundingBox" + }, + "comments": { + "type": "string" + }, + "contactInformation": { + "$ref": "#/definitions/FeedbackContactInformation" + }, + "feature": { + "$ref": "#/definitions/FeedbackPoiUpdateFeature" + } + } + }, + "FeedbackDeletePoiRequestBody": { + "type": "object", + "required": [ + "location", + "bbox", + "feature" + ], + "properties": { + "isMock": { + "type": "boolean" + }, + "location": { + "$ref": "#/definitions/GeoJSONPosition" + }, + "bbox": { + "$ref": "#/definitions/GeoJsonBoundingBox" + }, + "comments": { + "type": "string" + }, + "contactInformation": { + "$ref": "#/definitions/FeedbackContactInformation" + }, + "feature": { + "$ref": "#/definitions/FeedbackPoiFeature" + } + } + }, + "FeedbackPoiFeature": { + "type": "object", + "required": [ + "name", + "category", + "geometry" + ], + "properties": { + "featureId": { + "type": "string" + }, + "name": { + "type": "string" + }, + "category": { + "type": "string" + }, + "subcategory": { + "type": "string" + }, + "emailAddress": { + "type": "string" + }, + "faxNumber": { + "type": "string" + }, + "telephoneNumber": { + "type": "string" + }, + "website": { + "type": "string" + }, + "houseNumber": { + "type": "string" + }, + "streetName": { + "type": "string" + }, + "city": { + "type": "string" + }, + "postCode": { + "type": "string" + }, + "stateName": { + "type": "string" + }, + "country": { + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/Point" + } + } + }, + "FeedbackPoiUpdateFeature": { + "type": "object", + "required": [ + "name", + "category", + "geometry" + ], + "properties": { + "featureId": { + "type": "string" + }, + "name": { + "$ref": "#/definitions/FeedbackStringFieldUpdate" + }, + "category": { + "$ref": "#/definitions/FeedbackStringFieldUpdate" + }, + "subcategory": { + "$ref": "#/definitions/FeedbackStringFieldUpdate" + }, + "emailAddress": { + "$ref": "#/definitions/FeedbackStringFieldUpdate" + }, + "faxNumber": { + "$ref": "#/definitions/FeedbackStringFieldUpdate" + }, + "telephoneNumber": { + "$ref": "#/definitions/FeedbackStringFieldUpdate" + }, + "website": { + "$ref": "#/definitions/FeedbackStringFieldUpdate" + }, + "houseNumber": { + "$ref": "#/definitions/FeedbackStringFieldUpdate" + }, + "streetName": { + "$ref": "#/definitions/FeedbackStringFieldUpdate" + }, + "city": { + "$ref": "#/definitions/FeedbackStringFieldUpdate" + }, + "postCode": { + "$ref": "#/definitions/FeedbackStringFieldUpdate" + }, + "stateName": { + "$ref": "#/definitions/FeedbackStringFieldUpdate" + }, + "country": { + "$ref": "#/definitions/FeedbackStringFieldUpdate" + }, + "geometry": { + "$ref": "#/definitions/FeedbackGeometryFieldUpdate" + } + } + }, + "FeedbackAddAddressRequestBody": { + "type": "object", + "required": [ + "location", + "bbox", + "feature" + ], + "properties": { + "isMock": { + "type": "boolean" + }, + "location": { + "$ref": "#/definitions/GeoJSONPosition" + }, + "bbox": { + "$ref": "#/definitions/GeoJsonBoundingBox" + }, + "comments": { + "type": "string" + }, + "contactInformation": { + "$ref": "#/definitions/FeedbackContactInformation" + }, + "feature": { + "$ref": "#/definitions/FeedbackAddressFeature" + } + } + }, + "FeedbackFixAddressRequestBody": { + "type": "object", + "required": [ + "location", + "bbox", + "feature" + ], + "properties": { + "isMock": { + "type": "boolean" + }, + "location": { + "$ref": "#/definitions/GeoJSONPosition" + }, + "bbox": { + "$ref": "#/definitions/GeoJsonBoundingBox" + }, + "comments": { + "type": "string" + }, + "contactInformation": { + "$ref": "#/definitions/FeedbackContactInformation" + }, + "feature": { + "$ref": "#/definitions/FeedbackAddressUpdateFeature" + } + } + }, + "FeedbackDeleteAddressRequestBody": { + "type": "object", + "required": [ + "location", + "bbox", + "feature" + ], + "properties": { + "isMock": { + "type": "boolean" + }, + "location": { + "$ref": "#/definitions/GeoJSONPosition" + }, + "bbox": { + "$ref": "#/definitions/GeoJsonBoundingBox" + }, + "comments": { + "type": "string" + }, + "contactInformation": { + "$ref": "#/definitions/FeedbackContactInformation" + }, + "feature": { + "$ref": "#/definitions/FeedbackAddressFeature" + } + } + }, + "FeedbackAddressFeature": { + "type": "object", + "required": [ + "houseNumber", + "streetName", + "city", + "postCode", + "geometry" + ], + "properties": { + "featureId": { + "type": "string" + }, + "houseNumber": { + "type": "string" + }, + "streetName": { + "type": "string" + }, + "city": { + "type": "string" + }, + "postCode": { + "type": "string" + }, + "stateName": { + "type": "string" + }, + "country": { + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/Point" + } + } + }, + "FeedbackAddressUpdateFeature": { + "type": "object", + "required": [ + "houseNumber", + "streetName", + "city", + "postCode", + "geometry" + ], + "properties": { + "featureId": { + "type": "string" + }, + "houseNumber": { + "$ref": "#/definitions/FeedbackStringFieldUpdate" + }, + "streetName": { + "$ref": "#/definitions/FeedbackStringFieldUpdate" + }, + "city": { + "$ref": "#/definitions/FeedbackStringFieldUpdate" + }, + "postCode": { + "$ref": "#/definitions/FeedbackStringFieldUpdate" + }, + "stateName": { + "$ref": "#/definitions/FeedbackStringFieldUpdate" + }, + "country": { + "$ref": "#/definitions/FeedbackStringFieldUpdate" + }, + "geometry": { + "$ref": "#/definitions/FeedbackGeometryFieldUpdate" + } + } + }, + "FeedbackFixOtherRequestBody": { + "type": "object", + "required": [ + "location", + "bbox" + ], + "properties": { + "isMock": { + "type": "boolean" + }, + "location": { + "$ref": "#/definitions/GeoJSONPosition" + }, + "bbox": { + "$ref": "#/definitions/GeoJsonBoundingBox" + }, + "comments": { + "type": "string" + }, + "contactInformation": { + "$ref": "#/definitions/FeedbackContactInformation" + } + } + }, + "FeedbackContactInformation": { + "type": "object", + "properties": { + "emailAddress": { + "type": "string" + } + } + }, + "FeedbackStringFieldUpdate": { + "type": "object", + "properties": { + "current": { + "type": "string" + }, + "proposed": { + "type": "string" + } + } + }, + "FeedbackGeometryFieldUpdate": { + "type": "object", + "properties": { + "current": { + "$ref": "#/definitions/Geometry" + }, + "proposed": { + "$ref": "#/definitions/Geometry" + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Geolocation/preview/1.0/examples/GetLocationByIpAddress.json b/specification/maps/data-plane/Microsoft.Maps/Geolocation/preview/1.0/examples/GetLocationByIpAddress.json new file mode 100644 index 000000000000..4723a73f3579 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Geolocation/preview/1.0/examples/GetLocationByIpAddress.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscription-key": "[subscription-key]", + "api-version": "1.0", + "format": "json", + "ip": "2001:4898:80e8:b::189" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "countryRegion": { + "isoCode": "US" + }, + "ipAddress": "2001:4898:80e8:b::189" + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Geolocation/preview/1.0/geolocation.json b/specification/maps/data-plane/Microsoft.Maps/Geolocation/preview/1.0/geolocation.json new file mode 100644 index 000000000000..af145ea5c56c --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Geolocation/preview/1.0/geolocation.json @@ -0,0 +1,249 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Geolocation Service", + "version": "1.0", + "description": "Azure Maps Geolocation REST APIs" + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "user_impersonation": "Impersonates a user's Azure Active Directory account." + } + }, + "apiKeyQuery": { + "type": "apiKey", + "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + } + }, + "security": [ + { + "azure_auth": [] + }, + { + "apiKeyQuery": [] + } + ], + "responses": { + "400": { + "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "401": { + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + }, + "headers": { + "WWW-Authenticate": { + "type": "string", + "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" + } + } + }, + "403": { + "description": "Permission, capacity, or authentication issues.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "404": { + "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "500": { + "description": "An error occurred while processing the request. Please try again later.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + } + }, + "parameters": { + "ClientId": { + "name": "x-ms-client-id", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "client" + }, + "SubscriptionKey": { + "name": "subscription-key", + "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API. Current version is 1.0", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "JsonFormat": { + "name": "format", + "description": "Desired format of the response. Only `json` format is supported.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "json" + ], + "x-ms-enum": { + "name": "JsonFormat", + "modelAsString": false, + "values": [ + { + "value": "json", + "description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)" + } + ] + }, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/geolocation/ip/{format}": { + "get": { + "x-publish": true, + "description": "\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis service will return the ISO country code for the provided IP address. Developers can use this information to block or alter certain content based on geographical locations where the application is being viewed from. \n\n\n__Note:__ This service returns results from IANA and does not necessarily reflect the views of Microsoft Corporation.", + "operationId": "Geolocation_GetIPToLocationPreview", + "x-ms-examples": { + "GetLocationByIpAddress": { + "$ref": "./examples/GetLocationByIpAddress.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "ip", + "in": "query", + "description": "The IP address. Both IPv4 and IPv6 are allowed.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IpAddressToLocationResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + } + }, + "definitions": { + "ODataErrorResponse": { + "type": "object", + "description": "This response object is returned when an error occurs in the Maps API.", + "properties": { + "error": { + "$ref": "#/definitions/ODataError" + } + } + }, + "ODataError": { + "type": "object", + "description": "This object is returned when an error occurs in the Maps API.", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The ODataError code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + } + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the target causing the error." + } + } + }, + "IpAddressToLocationResult": { + "description": "This object is returned from a successful call to IP Address to country/region API", + "type": "object", + "properties": { + "countryRegion": { + "$ref": "#/definitions/CountryRegion" + }, + "ipAddress": { + "description": "The IP Address of the request.", + "type": "string", + "readOnly": true + } + } + }, + "CountryRegion": { + "description": "The object containing the country/region information.", + "type": "object", + "readOnly": true, + "properties": { + "isoCode": { + "description": "The IP Address's 2-character code [(ISO 3166-1)](https://www.iso.org/iso-3166-country-codes.html) of the country or region as assigned by IANA and regional internet authorities. Please note, IP address in ranges reserved for special purpose will return Null for country/region.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetMetroArea.json b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetMetroArea.json new file mode 100644 index 000000000000..82d62473f11d --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetMetroArea.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "query": "40.648677,-74.010535", + "queryType": "position" + }, + "responses": { + "200": { + "body": { + "results": [ + { + "metroId": 121, + "metroName": "NYC-NJ", + "viewport": { + "topLeftPoint": { + "latitude": 42.21254, + "longitude": -75.68527 + }, + "btmRightPoint": { + "latitude": 38.87921, + "longitude": -71.83323 + } + }, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + -73.08158, + 41.18596 + ], + [ + -73.12026, + 41.23447 + ], + [ + -73.17959, + 41.25386 + ], + [ + -73.25697, + 41.18014 + ], + [ + -73.36529, + 41.18401 + ], + [ + -73.36013, + 41.39719 + ], + [ + -73.08158, + 41.18596 + ] + ] + ] + } + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetMetroAreaInfo.json b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetMetroAreaInfo.json new file mode 100644 index 000000000000..5105fdde77ed --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetMetroAreaInfo.json @@ -0,0 +1,359 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "query": "121", + "detailType": "agencies" + }, + "responses": { + "200": { + "body": { + "metroName": "NYC-NJ", + "agencies": [ + { + "agencyId": "121---10368", + "agencyKey": "LIBUS", + "agencyName": "NICE bus", + "transitType": { + "transitType": "Bus", + "captionOverride": "Bus" + } + }, + { + "agencyId": "121---10369", + "agencyKey": "GOOGLESTAM_TRANSIT", + "agencyName": "CT Transit- Stamford", + "transitType": { + "transitType": "Bus", + "captionOverride": "Bus" + } + }, + { + "agencyId": "121---10370", + "agencyKey": "0", + "agencyName": "Norwalk Transit District", + "transitType": { + "transitType": "Bus", + "captionOverride": "Bus" + } + }, + { + "agencyId": "121---516", + "agencyKey": "NJB", + "agencyName": "NJ Transit", + "transitType": { + "transitType": "Bus", + "captionOverride": "Bus" + } + }, + { + "agencyId": "121---1175189", + "agencyKey": "42700", + "agencyName": "Statue Cruises", + "transitType": { + "transitType": "Ferry", + "captionOverride": "Ferry" + } + }, + { + "agencyId": "121---1058901", + "agencyKey": "SCT", + "agencyName": "Suffolk County Transit", + "transitType": { + "transitType": "Bus", + "captionOverride": "Bus" + } + }, + { + "agencyId": "121---1175188", + "agencyKey": "42705", + "agencyName": "Seastreak", + "transitType": { + "transitType": "Ferry", + "captionOverride": "Ferry" + } + }, + { + "agencyId": "121---1217492", + "agencyKey": "1", + "agencyName": "NYC Ferry Shuttle bus", + "transitType": { + "transitType": "Bus", + "captionOverride": "Bus" + } + }, + { + "agencyId": "121---726988", + "agencyKey": "LI", + "agencyName": "LIRR", + "transitType": { + "transitType": "Rail", + "captionOverride": "Rail" + } + }, + { + "agencyId": "121---1217493", + "agencyKey": "1", + "agencyName": "NYC Ferry", + "transitType": { + "transitType": "Ferry", + "captionOverride": "Ferry" + } + }, + { + "agencyId": "121---855111", + "agencyKey": "MTA NYCT", + "agencyName": "MTA Subway", + "transitType": { + "transitType": "Subway", + "captionOverride": "Subway" + } + }, + { + "agencyId": "121---855110", + "agencyKey": "MTA NYCT", + "agencyName": "Staten Island Railway", + "transitType": { + "transitType": "Rail", + "captionOverride": "Rail" + } + }, + { + "agencyId": "121---5844", + "agencyKey": "151", + "agencyName": "PATH", + "transitType": { + "transitType": "Rail", + "captionOverride": "Rail" + } + }, + { + "agencyId": "121---965398", + "agencyKey": "631", + "agencyName": "Port Authority of NY and NJ", + "transitType": { + "transitType": "Bus", + "captionOverride": "Bus" + } + }, + { + "agencyId": "121---865943", + "agencyKey": "5942", + "agencyName": "Suffolk County Transit", + "transitType": { + "transitType": "Bus", + "captionOverride": "Bus" + } + }, + { + "agencyId": "121---1020565", + "agencyKey": "24415", + "agencyName": "Staten Island Ferry", + "transitType": { + "transitType": "Ferry", + "captionOverride": "Ferry" + } + }, + { + "agencyId": "121---865942", + "agencyKey": "14639", + "agencyName": "Long Beach NY", + "transitType": { + "transitType": "Bus", + "captionOverride": "Bus" + } + }, + { + "agencyId": "121---1358024", + "agencyKey": "72", + "agencyName": "Ulster County Area Transit", + "transitType": { + "transitType": "Bus", + "captionOverride": "Bus" + } + }, + { + "agencyId": "121---1325321", + "agencyKey": "58939", + "agencyName": "Hampton Jitney", + "transitType": { + "transitType": "Bus", + "captionOverride": "Bus" + } + }, + { + "agencyId": "121---1440628", + "agencyKey": "63882", + "agencyName": "Housatonic Area Regional Transit", + "transitType": { + "transitType": "Bus", + "captionOverride": "Bus" + } + }, + { + "agencyId": "121---775148", + "agencyKey": "119", + "agencyName": "AirTrain", + "transitType": { + "transitType": "Tram", + "captionOverride": "Light Rail" + } + }, + { + "agencyId": "121---427", + "agencyKey": "1", + "agencyName": "Metro-North Railroad", + "transitType": { + "transitType": "Rail", + "captionOverride": "Rail" + } + }, + { + "agencyId": "121---856508", + "agencyKey": "5705", + "agencyName": "Roosevelt Island Cable Car", + "transitType": { + "transitType": "Bus", + "captionOverride": "Bus" + } + }, + { + "agencyId": "121---1460323", + "agencyKey": "65856", + "agencyName": "Downtown Alliance", + "transitType": { + "transitType": "Bus", + "captionOverride": "Bus" + } + }, + { + "agencyId": "121---856507", + "agencyKey": "5705", + "agencyName": "Roosevelt Island Cable Car", + "transitType": { + "transitType": "CableCar", + "captionOverride": "Cable car" + } + }, + { + "agencyId": "121---1227748", + "agencyKey": "SLE", + "agencyName": "Shore Line East", + "transitType": { + "transitType": "Rail", + "captionOverride": "Rail" + } + }, + { + "agencyId": "121---856506", + "agencyKey": "5703", + "agencyName": "NY Waterway", + "transitType": { + "transitType": "Ferry", + "captionOverride": "Ferry" + } + }, + { + "agencyId": "121---1367715", + "agencyKey": "67", + "agencyName": "Dutchess County Public Transit", + "transitType": { + "transitType": "Bus", + "captionOverride": "Bus" + } + }, + { + "agencyId": "121---10169", + "agencyKey": "NJT", + "agencyName": "NJ Transit Rail", + "transitType": { + "transitType": "Rail", + "captionOverride": "Rail" + } + }, + { + "agencyId": "121---10170", + "agencyKey": "NJT", + "agencyName": "NJ Transit Rail", + "transitType": { + "transitType": "Tram", + "captionOverride": "Light Rail" + } + }, + { + "agencyId": "121---857463", + "agencyKey": "MTA NYCT", + "agencyName": "MTA Bus", + "transitType": { + "transitType": "Bus", + "captionOverride": "Bus" + } + }, + { + "agencyId": "121---11515", + "agencyKey": "WCDOT", + "agencyName": "Bee-Line Bus", + "transitType": { + "transitType": "Bus", + "captionOverride": "Bus" + } + }, + { + "agencyId": "121---1177901", + "agencyKey": "0", + "agencyName": "LANTA", + "transitType": { + "transitType": "Bus", + "captionOverride": "Bus" + } + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetNearbyTransit.json b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetNearbyTransit.json new file mode 100644 index 000000000000..963d9675101b --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetNearbyTransit.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "query": "40.693393,-73.988310", + "radius": 300 + }, + "responses": { + "200": { + "body": { + "results": [ + { + "id": "121---14013676", + "type": "stop", + "objectDetails": { + "stopKey": "307460", + "stopName": "Adams St/Bklyn Supreme Crt", + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + "position": { + "latitude": 40.69256, + "longitude": -73.989131 + }, + "viewport": { + "topLeftPoint": { + "latitude": 40.693471, + "longitude": -73.9903 + }, + "btmRightPoint": { + "latitude": 40.691648, + "longitude": -73.987961 + } + } + }, + { + "id": "121---14013518", + "type": "stop", + "objectDetails": { + "stopKey": "306969", + "stopName": "Jay St/Willoughby St", + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + "position": { + "latitude": 40.692661, + "longitude": -73.98718 + }, + "viewport": { + "topLeftPoint": { + "latitude": 40.693572, + "longitude": -73.988349 + }, + "btmRightPoint": { + "latitude": 40.691749, + "longitude": -73.98601 + } + } + }, + { + "id": "121---14011729", + "type": "stop", + "objectDetails": { + "stopKey": "302445", + "stopName": "Jay St/Willoughby St", + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + "position": { + "latitude": 40.692451, + "longitude": -73.987337 + }, + "viewport": { + "topLeftPoint": { + "latitude": 40.693362, + "longitude": -73.988506 + }, + "btmRightPoint": { + "latitude": 40.691539, + "longitude": -73.986167 + } + } + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetRealTimeArrivals.json b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetRealTimeArrivals.json new file mode 100644 index 000000000000..60933fce0b9f --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetRealTimeArrivals.json @@ -0,0 +1,141 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "query": "121---19919516" + }, + "responses": { + "200": { + "body": { + "results": [ + { + "arrivalMinutes": 1, + "scheduleType": "realTime", + "patternId": "121---3120454", + "line": { + "lineId": "121---3128966", + "lineGroupId": "121---400175", + "direction": "forward", + "agencyId": "121---855111", + "agencyName": "MTA Subway", + "lineNumber": "R", + "lineDestination": "Forest Hills - 71 Av", + "transitType": "Subway" + }, + "stop": { + "stopId": "121---19919516", + "stopKey": "S9563736", + "stopName": "45 St [R]", + "position": { + "latitude": 40.648939, + "longitude": -74.010006 + }, + "mainTransitType": "Subway", + "mainAgencyId": "121---855111", + "mainAgencyName": "MTA Subway" + } + }, + { + "arrivalMinutes": 7, + "scheduleType": "realTime", + "patternId": "121---3120453", + "line": { + "lineId": "121---3128969", + "lineGroupId": "121---400175", + "direction": "backward", + "agencyId": "121---855111", + "agencyName": "MTA Subway", + "lineNumber": "R", + "lineDestination": "Bay Ridge - 95 St", + "transitType": "Subway" + }, + "stop": { + "stopId": "121---19919516", + "stopKey": "S9563736", + "stopName": "45 St [R]", + "position": { + "latitude": 40.648939, + "longitude": -74.010006 + }, + "mainTransitType": "Subway", + "mainAgencyId": "121---855111", + "mainAgencyName": "MTA Subway" + } + }, + { + "arrivalMinutes": 13, + "scheduleType": "realTime", + "patternId": "121---3120453", + "line": { + "lineId": "121---3128969", + "lineGroupId": "121---400175", + "direction": "backward", + "agencyId": "121---855111", + "agencyName": "MTA Subway", + "lineNumber": "R", + "lineDestination": "Bay Ridge - 95 St", + "transitType": "Subway" + }, + "stop": { + "stopId": "121---19919516", + "stopKey": "S9563736", + "stopName": "45 St [R]", + "position": { + "latitude": 40.648939, + "longitude": -74.010006 + }, + "mainTransitType": "Subway", + "mainAgencyId": "121---855111", + "mainAgencyName": "MTA Subway" + } + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitItinerary.json b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitItinerary.json new file mode 100644 index 000000000000..02fc587bd829 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitItinerary.json @@ -0,0 +1,203 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "query": "68fa6e31-d1a4-4457-a15b-8f5036a76a78---201909167EB6D19458C443BFAD897246FD28DAD4:0---121", + "detailType": [ + "geometry" + ] + }, + "responses": { + "200": { + "body": { + "departureTime": "2019-09-16T18:04:53Z", + "arrivalTime": "2019-09-16T18:08:07Z", + "legs": [ + { + "legType": "Bicycle", + "legStartTime": "2019-09-16T18:04:53Z", + "legEndTime": "2019-09-16T18:08:07Z", + "steps": [ + { + "direction": { + "relativeDirection": "depart" + }, + "streetName": "3rd Avenue" + }, + { + "direction": { + "relativeDirection": "right" + }, + "streetName": "Dean Street" + }, + { + "direction": { + "relativeDirection": "right" + }, + "streetName": "5th Avenue" + } + ], + "origin": { + "position": { + "latitude": 40.680903, + "longitude": -73.983723 + } + }, + "destination": { + "position": { + "latitude": 40.682051, + "longitude": -73.976702 + } + }, + "geometry": { + "type": "LineString", + "coordinates": [ + [ + -73.98373, + 40.6809 + ], + [ + -73.98371, + 40.68089 + ], + [ + -73.98328, + 40.68152 + ], + [ + -73.9831, + 40.68179 + ], + [ + -73.98303, + 40.68189 + ], + [ + -73.98302, + 40.68191 + ], + [ + -73.9829, + 40.68208 + ], + [ + -73.98286, + 40.68214 + ], + [ + -73.9828, + 40.68223 + ], + [ + -73.98243, + 40.68278 + ], + [ + -73.98199, + 40.68342 + ], + [ + -73.98161, + 40.68398 + ], + [ + -73.98157, + 40.68405 + ], + [ + -73.9812, + 40.6839 + ], + [ + -73.97984, + 40.68338 + ], + [ + -73.9794, + 40.6832 + ], + [ + -73.97924, + 40.68314 + ], + [ + -73.97912, + 40.68309 + ], + [ + -73.97899, + 40.68304 + ], + [ + -73.97675, + 40.68217 + ], + [ + -73.97659, + 40.68211 + ], + [ + -73.97665, + 40.68203 + ], + [ + -73.97665, + 40.68203 + ], + [ + -73.97671, + 40.68205 + ] + ] + } + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitLineInfo.json b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitLineInfo.json new file mode 100644 index 000000000000..ea4d8d7bf140 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitLineInfo.json @@ -0,0 +1,599 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "query": "121---373227", + "detailType": [ + "stops" + ] + }, + "responses": { + "200": { + "body": { + "lineGroup": { + "lineGroupId": "121---373227", + "agencyId": "121---857463", + "agencyName": "MTA Bus", + "lineNumber": "B25", + "caption1": "Dwntn Bklyn & DUMBO - Broadway Junction", + "caption2": "B25 Dwntn Bklyn & DUMBO - Broadway Junction", + "color": "6CBE45", + "transitType": "Bus" + }, + "lines": [ + { + "lineId": "121---1227940", + "lineGroupId": "121---373227", + "direction": "forward", + "agencyId": "121---857463", + "agencyName": "MTA Bus", + "lineNumber": "B25", + "lineDestination": "Broadway Jct Alabama Av Via Fulton", + "mostFrequentPatternId": "121---1581548", + "transitType": "Bus" + }, + { + "lineId": "121---1227941", + "lineGroupId": "121---373227", + "direction": "backward", + "agencyId": "121---857463", + "agencyName": "MTA Bus", + "lineNumber": "B25", + "lineDestination": "Downtown Bklyn Front St Via Fulton", + "mostFrequentPatternId": "121---1701359", + "transitType": "Bus" + } + ], + "stops": [ + { + "stopId": "121---14011984", + "stopKey": "303017", + "stopName": "Fulton St/Ashland Pl", + "position": { + "latitude": 40.687781, + "longitude": -73.978221 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14013637", + "stopKey": "307259", + "stopName": "Fulton St/Thomas S Boyland St", + "position": { + "latitude": 40.678336, + "longitude": -73.913138 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14013639", + "stopKey": "307263", + "stopName": "Fulton St/Van Sinderen Av", + "position": { + "latitude": 40.677816, + "longitude": -73.903542 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14013638", + "stopKey": "307260", + "stopName": "Fulton St/Rockaway Av", + "position": { + "latitude": 40.678189, + "longitude": -73.910359 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14013633", + "stopKey": "307255", + "stopName": "Fulton St/Ralph Av", + "position": { + "latitude": 40.678762, + "longitude": -73.92125 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14013632", + "stopKey": "307254", + "stopName": "Fulton St/Buffalo Av", + "position": { + "latitude": 40.67894, + "longitude": -73.924108 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---31066255", + "stopKey": "901211", + "stopName": "East New York Av/Alabama Av", + "position": { + "latitude": 40.676719, + "longitude": -73.900118 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14013635", + "stopKey": "307257", + "stopName": "Fulton St/Saratoga Av", + "position": { + "latitude": 40.678489, + "longitude": -73.915892 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14013634", + "stopKey": "307256", + "stopName": "Fulton St/Howard Av", + "position": { + "latitude": 40.678615, + "longitude": -73.918564 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011701", + "stopKey": "302376", + "stopName": "Fulton St/Grand Av", + "position": { + "latitude": 40.682362, + "longitude": -73.961824 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011700", + "stopKey": "302375", + "stopName": "Fulton St/St James Pl", + "position": { + "latitude": 40.682662, + "longitude": -73.9633 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14193658", + "stopName": "Front St/York St", + "position": { + "latitude": 40.702464, + "longitude": -73.991858 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011703", + "stopKey": "302378", + "stopName": "Fulton St/Franklin Av", + "position": { + "latitude": 40.680982, + "longitude": -73.955289 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14013751", + "stopKey": "307631", + "stopName": "Fulton St/Eastern Py", + "position": { + "latitude": 40.678066, + "longitude": -73.908188 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011702", + "stopKey": "302377", + "stopName": "Fulton St/Classon Av", + "position": { + "latitude": 40.681579, + "longitude": -73.958134 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011697", + "stopKey": "302371", + "stopName": "Fulton St/Clermont Av", + "position": { + "latitude": 40.683904, + "longitude": -73.968617 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011696", + "stopKey": "302370", + "stopName": "Fulton St/Carlton Av", + "position": { + "latitude": 40.68478, + "longitude": -73.970798 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011699", + "stopKey": "302374", + "stopName": "Fulton St/Washington Av", + "position": { + "latitude": 40.682882, + "longitude": -73.964338 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011698", + "stopKey": "302372", + "stopName": "Fulton St/Clinton Av", + "position": { + "latitude": 40.683332, + "longitude": -73.966593 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14013629", + "stopKey": "307251", + "stopName": "Fulton St/Troy Av", + "position": { + "latitude": 40.679501, + "longitude": -73.934459 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011964", + "stopKey": "302948", + "stopName": "Fulton St/Flatbush Av Ext", + "position": { + "latitude": 40.688976, + "longitude": -73.981278 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011708", + "stopKey": "302383", + "stopName": "Fulton St/Kingston Av", + "position": { + "latitude": 40.67988, + "longitude": -73.941381 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14013631", + "stopKey": "307253", + "stopName": "Fulton St/Utica Av", + "position": { + "latitude": 40.67919, + "longitude": -73.928636 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14013630", + "stopKey": "307252", + "stopName": "Fulton St/Schenectady Av", + "position": { + "latitude": 40.679398, + "longitude": -73.932497 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14013689", + "stopKey": "307491", + "stopName": "Fulton St/Hoyt St", + "position": { + "latitude": 40.69069, + "longitude": -73.985547 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011705", + "stopKey": "302380", + "stopName": "Fulton St/Nostrand Av", + "position": { + "latitude": 40.680301, + "longitude": -73.949161 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14013881", + "stopKey": "307926", + "stopName": "Fulton St/Albany Av", + "position": { + "latitude": 40.679664, + "longitude": -73.937573 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011704", + "stopKey": "302379", + "stopName": "Fulton St/Bedford Av", + "position": { + "latitude": 40.6805, + "longitude": -73.952805 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011963", + "stopKey": "302947", + "stopName": "Fulton St/Bond St", + "position": { + "latitude": 40.689709, + "longitude": -73.983099 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011707", + "stopKey": "302382", + "stopName": "Fulton St/Brooklyn Av", + "position": { + "latitude": 40.680033, + "longitude": -73.944167 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011962", + "stopKey": "302945", + "stopName": "Fulton St/Smith St", + "position": { + "latitude": 40.69148, + "longitude": -73.987534 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011706", + "stopKey": "302381", + "stopName": "Fulton St/Marcy Av", + "position": { + "latitude": 40.680116, + "longitude": -73.945667 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14406637", + "stopName": "Tillary St/Cadman Pz E", + "position": { + "latitude": 40.696046, + "longitude": -73.990383 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011693", + "stopKey": "302359", + "stopName": "Cadman Plz W/Cadman Tower", + "position": { + "latitude": 40.698348, + "longitude": -73.991565 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011692", + "stopKey": "302358", + "stopName": "Cadman Pz W/Clark St", + "position": { + "latitude": 40.696696, + "longitude": -73.991464 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14013676", + "stopKey": "307460", + "stopName": "Adams St/Bklyn Supreme Crt", + "position": { + "latitude": 40.69256, + "longitude": -73.989131 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011695", + "stopKey": "302369", + "stopName": "Fulton St/S Portland Av", + "position": { + "latitude": 40.686059, + "longitude": -73.974034 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14013934", + "stopKey": "308025", + "stopName": "Water St/Main St", + "position": { + "latitude": 40.703318, + "longitude": -73.991102 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011694", + "stopKey": "302368", + "stopName": "Fulton St/Lafayette Av", + "position": { + "latitude": 40.687146, + "longitude": -73.97669 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011689", + "stopKey": "302355", + "stopName": "Old Fulton St/Elizabeth Pl", + "position": { + "latitude": 40.702666, + "longitude": -73.993952 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011691", + "stopKey": "302357", + "stopName": "Cadman Pz W/Middagh St", + "position": { + "latitude": 40.699591, + "longitude": -73.99129 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + { + "stopId": "121---14011690", + "stopKey": "302356", + "stopName": "Old Fulton St/Henry St", + "position": { + "latitude": 40.701021, + "longitude": -73.991449 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitRoute.json b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitRoute.json new file mode 100644 index 000000000000..9074ad95aaef --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitRoute.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "origin": "40.680903,-73.983723", + "originType": "position", + "destination": "40.682051,-73.976702", + "destinationType": "position" + }, + "responses": { + "200": { + "body": { + "results": [ + { + "itineraryId": "68fa6e31-d1a4-4457-a15b-8f5036a76a78---201909167EB6D19458C443BFAD897246FD28DAD4:0---121", + "departureTime": "2019-09-16T18:04:53Z", + "arrivalTime": "2019-09-16T18:08:07Z", + "travelTimeInSeconds": 194, + "numberOfLegs": 1, + "legs": [ + { + "legType": "Bicycle", + "legStartTime": "2019-09-16T18:04:53Z", + "legEndTime": "2019-09-16T18:08:07Z", + "lengthInMeters": 877 + } + ] + }, + { + "itineraryId": "68fa6e31-d1a4-4457-a15b-8f5036a76a78---20190916E4C79AA6602341F0973B94A3A79D9D36:0---121", + "departureTime": "2019-09-16T18:04:53Z", + "arrivalTime": "2019-09-16T18:07:57Z", + "travelTimeInSeconds": 184, + "numberOfLegs": 1, + "legs": [ + { + "legType": "Bicycle", + "legStartTime": "2019-09-16T18:04:53Z", + "legEndTime": "2019-09-16T18:07:57Z", + "lengthInMeters": 851 + } + ] + }, + { + "itineraryId": "68fa6e31-d1a4-4457-a15b-8f5036a76a78---201909168C38C8E44DEC41B7B6B7DB3ADE640722:0---121", + "departureTime": "2019-09-16T18:04:53Z", + "arrivalTime": "2019-09-16T18:13:33Z", + "travelTimeInSeconds": 520, + "numberOfLegs": 3, + "legs": [ + { + "legType": "Walk", + "legStartTime": "2019-09-16T18:04:53Z", + "legEndTime": "2019-09-16T18:07:12Z", + "caption": "Douglass Street", + "lengthInMeters": 93 + }, + { + "legType": "Bicycle", + "legStartTime": "2019-09-16T18:07:12Z", + "legEndTime": "2019-09-16T18:10:22Z", + "caption": "Dean Street", + "lengthInMeters": 734 + }, + { + "legType": "Walk", + "legStartTime": "2019-09-16T18:10:22Z", + "legEndTime": "2019-09-16T18:13:33Z", + "lengthInMeters": 212 + } + ] + }, + { + "itineraryId": "68fa6e31-d1a4-4457-a15b-8f5036a76a78---201909168960D307482847EF9E0A2A59D22A5D2F:0---121", + "departureTime": "2019-09-16T18:04:53Z", + "arrivalTime": "2019-09-16T18:14:00Z", + "travelTimeInSeconds": 547, + "numberOfLegs": 3, + "legs": [ + { + "legType": "Walk", + "legStartTime": "2019-09-16T18:04:53Z", + "legEndTime": "2019-09-16T18:07:12Z", + "caption": "Douglass Street", + "lengthInMeters": 93 + }, + { + "legType": "Bicycle", + "legStartTime": "2019-09-16T18:07:12Z", + "legEndTime": "2019-09-16T18:10:22Z", + "caption": "Dean Street", + "lengthInMeters": 734 + }, + { + "legType": "Walk", + "legStartTime": "2019-09-16T18:10:22Z", + "legEndTime": "2019-09-16T18:14:00Z", + "lengthInMeters": 237 + } + ] + }, + { + "itineraryId": "68fa6e31-d1a4-4457-a15b-8f5036a76a78---2019091632031DBD314545E19C0CD726BCE4BCD8:0---121", + "departureTime": "2019-09-16T18:06:17Z", + "arrivalTime": "2019-09-16T18:16:00Z", + "travelTimeInSeconds": 583, + "numberOfLegs": 3, + "legs": [ + { + "legType": "Walk", + "legStartTime": "2019-09-16T18:06:17Z", + "legEndTime": "2019-09-16T18:11:56Z", + "caption": "Dean Street", + "lengthInMeters": 429 + }, + { + "legType": "Wait", + "legStartTime": "2019-09-16T18:11:56Z", + "legEndTime": "2019-09-16T18:12:57Z", + "caption": "B65" + }, + { + "legType": "Bus", + "legStartTime": "2019-09-16T18:12:57Z", + "legEndTime": "2019-09-16T18:16:00Z", + "caption": "B65", + "lengthInMeters": 422 + } + ] + }, + { + "itineraryId": "68fa6e31-d1a4-4457-a15b-8f5036a76a78---2019091632031DBD314545E19C0CD726BCE4BCD8:1---121", + "departureTime": "2019-09-16T18:15:04Z", + "arrivalTime": "2019-09-16T18:24:36Z", + "travelTimeInSeconds": 572, + "numberOfLegs": 4, + "legs": [ + { + "legType": "Walk", + "legStartTime": "2019-09-16T18:15:04Z", + "legEndTime": "2019-09-16T18:15:50Z", + "caption": "3rd Avenue", + "lengthInMeters": 51 + }, + { + "legType": "Wait", + "legStartTime": "2019-09-16T18:15:50Z", + "legEndTime": "2019-09-16T18:16:51Z", + "caption": "B37" + }, + { + "legType": "Bus", + "legStartTime": "2019-09-16T18:16:51Z", + "legEndTime": "2019-09-16T18:21:00Z", + "caption": "B37", + "lengthInMeters": 942 + }, + { + "legType": "Walk", + "legStartTime": "2019-09-16T18:21:01Z", + "legEndTime": "2019-09-16T18:24:36Z", + "lengthInMeters": 278 + } + ] + }, + { + "itineraryId": "68fa6e31-d1a4-4457-a15b-8f5036a76a78---2019091632031DBD314545E19C0CD726BCE4BCD8:2---121", + "departureTime": "2019-09-16T18:04:53Z", + "arrivalTime": "2019-09-16T18:15:38Z", + "travelTimeInSeconds": 645, + "numberOfLegs": 1, + "legs": [ + { + "legType": "Walk", + "legStartTime": "2019-09-16T18:04:53Z", + "legEndTime": "2019-09-16T18:15:38Z", + "lengthInMeters": 829 + } + ] + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitStopInfo.json b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitStopInfo.json new file mode 100644 index 000000000000..1f7fc7684b6d --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/examples/GetTransitStopInfo.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "query": "121---14013676", + "queryType": "stopId", + "detailType": [ + "lines" + ] + }, + "responses": { + "200": { + "body": { + "stop": { + "stopId": "121---14013676", + "stopKey": "307460", + "stopName": "Adams St/Bklyn Supreme Crt", + "position": { + "latitude": 40.69256, + "longitude": -73.989131 + }, + "mainTransitType": "Bus", + "mainAgencyId": "121---857463", + "mainAgencyName": "MTA Bus" + }, + "lines": [ + { + "lineId": "121---1227940", + "lineGroupId": "121---373227", + "direction": "forward", + "agencyId": "121---857463", + "agencyName": "MTA Bus", + "lineNumber": "B25", + "lineDestination": "Broadway Jct Alabama Av Via Fulton", + "transitType": "Bus" + }, + { + "lineId": "121---1227962", + "lineGroupId": "121---373234", + "direction": "forward", + "agencyId": "121---857463", + "agencyName": "MTA Bus", + "lineNumber": "B38", + "lineDestination": "Ltd Ridgewood Catalpa Av", + "transitType": "Bus" + }, + { + "lineId": "121---1227960", + "lineGroupId": "121---373234", + "direction": "forward", + "agencyId": "121---857463", + "agencyName": "MTA Bus", + "lineNumber": "B38", + "lineDestination": "Ridgewood Metro Av", + "transitType": "Bus" + }, + { + "lineId": "121---1227961", + "lineGroupId": "121---373234", + "direction": "forward", + "agencyId": "121---857463", + "agencyName": "MTA Bus", + "lineNumber": "B38", + "lineDestination": "Ridgewood Catalpa Av", + "transitType": "Bus" + }, + { + "lineId": "121---3996060", + "lineGroupId": "121---373236", + "direction": "backward", + "agencyId": "121---857463", + "agencyName": "MTA Bus", + "lineNumber": "B41", + "lineDestination": "Kings Plaza Via Flatbush", + "transitType": "Bus" + }, + { + "lineId": "121---3996040", + "lineGroupId": "121---373236", + "direction": "backward", + "agencyId": "121---857463", + "agencyName": "MTA Bus", + "lineNumber": "B41", + "lineDestination": "Bergen Beach Veterans Av Via Flatbush", + "transitType": "Bus" + }, + { + "lineId": "121---3996059", + "lineGroupId": "121---373236", + "direction": "backward", + "agencyId": "121---857463", + "agencyName": "MTA Bus", + "lineNumber": "B41", + "lineDestination": "Limited Kings Plaza Via Flatbush", + "transitType": "Bus" + }, + { + "lineId": "121---1227976", + "lineGroupId": "121---373236", + "direction": "backward", + "agencyId": "121---857463", + "agencyName": "MTA Bus", + "lineNumber": "B41", + "lineDestination": "Ltd Bergen Bch Veterans Av Via Flatbush", + "transitType": "Bus" + }, + { + "lineId": "121---1228017", + "lineGroupId": "121---373245", + "direction": "forward", + "agencyId": "121---857463", + "agencyName": "MTA Bus", + "lineNumber": "B52", + "lineDestination": "Ridgewood Term Via Gates", + "transitType": "Bus" + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/mobility.json b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/mobility.json new file mode 100644 index 000000000000..afeb93435bcf --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Mobility/preview/1.0/mobility.json @@ -0,0 +1,2483 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Mobility Service", + "version": "1.0" + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "user_impersonation": "Impersonates a user's Azure Active Directory account." + } + }, + "apiKeyQuery": { + "type": "apiKey", + "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + } + }, + "security": [ + { + "azure_auth": [] + }, + { + "apiKeyQuery": [] + } + ], + "responses": { + "400": { + "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "401": { + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + }, + "headers": { + "WWW-Authenticate": { + "type": "string", + "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" + } + } + }, + "403": { + "description": "Permission, capacity, or authentication issues.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "404": { + "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "500": { + "description": "An error occurred while processing the request. Please try again later.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + } + }, + "parameters": { + "ClientId": { + "name": "x-ms-client-id", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "client" + }, + "SubscriptionKey": { + "name": "subscription-key", + "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API. Current version is 1.0", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "JsonFormat": { + "name": "format", + "description": "Desired format of the response. Only `json` format is supported.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "json" + ], + "x-ms-enum": { + "name": "JsonFormat", + "modelAsString": false, + "values": [ + { + "value": "json", + "description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "MetroId": { + "name": "metroId", + "description": "The unique id of the metro area. Can be retrieved via [Get Metro Area API](https://aka.ms/AzureMapsMobilityMetro).", + "type": "integer", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + }, + "MobilityLanguage": { + "name": "language", + "description": "Language in which search results will be returned. Only NGT is supported. Please refer to [Supported languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/mobility/metroArea/id/{format}": { + "get": { + "x-publish": true, + "operationId": "Mobility_GetMetroAreaPreview", + "description": "**Metro Area API**\n\n**Applies to**: S1 pricing tier.\n\nService allows to request metro areas in which the Azure Maps Mobility Service is available. The service supports filtering results by country or coordinate location. Information returned includes Metro Area details such as metro Id, name and a representation of the metro area geometry in GeoJSON format.", + "x-ms-examples": { + "MetroArea": { + "$ref": "./examples/GetMetroArea.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "query", + "description": "The applicable location input. Can be position (specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\") or countryCode (2-character ISO country code).", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "queryType", + "description": "The type of the query. By default originType=position, specified as a comma separated string composed by latitude followed by longitude, e.g. \"47.641268,-122.125679”.", + "in": "query", + "required": false, + "type": "string", + "default": "position", + "enum": [ + "position", + "countryCode" + ], + "x-ms-enum": { + "name": "MetroAreaQueryType", + "modelAsString": false, + "values": [ + { + "value": "position", + "description": "The origin of the route as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\"." + }, + { + "value": "countryCode", + "description": "2-character [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-2 country code. E.g. US." + } + ] + }, + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/MobilityLanguage" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MetroAreaResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/mobility/metroArea/info/{format}": { + "get": { + "x-publish": true, + "operationId": "Mobility_GetMetroAreaInfoPreview", + "description": "**Metro Area Info API**\n\n**Applies to**: S1 pricing tier.\n\nService allows to request additional information for metro areas in which the Azure Maps Mobility Service is available. Information such as supported transit types, transit agencies and active alerts is available, depending on the options selected.", + "x-ms-examples": { + "MetroAreaInfo": { + "$ref": "./examples/GetMetroAreaInfo.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "query", + "description": "metroId. The unique id of the metro area. Required parameter specifying the required metro area to search in. Can be retrieved via [Get Metro Area API](https://aka.ms/AzureMapsMobilityTransitRoute).", + "in": "query", + "required": true, + "type": "integer" + }, + { + "name": "detailType", + "description": "Specify details requested respective to the metro area as a comma separated list. Supported values are:\n * `agencies` - Return a list of all public transit agencies operating in the given metro area.\n * `alerts` - Returns a list of all active service alerts, that are defined in the metro or agency level, and are not connected to a specific line or stop.\n * `alertDetails` - Applicable only when alerts are requested. Returns details of the alerts.\n * `transitTypes` - Returns a list of all supported transit types in the given metro area.", + "in": "query", + "required": true, + "type": "array", + "items": { + "type": "string", + "enum": [ + "agencies", + "alerts", + "alertDetails", + "transitTypes" + ], + "x-ms-enum": { + "name": "MetroAreaDetailType", + "modelAsString": false, + "values": [ + { + "value": "agencies", + "description": "Return a list of all public transit agencies operating in the given metro area." + }, + { + "value": "alerts", + "description": "Returns a list of all active service alerts, that are defined in the metro or agency level, and are not connected to a specific line or stop." + }, + { + "value": "alertDetails", + "description": "Applicable only when alerts are requested. Returns details of the alerts." + }, + { + "value": "transitTypes", + "description": "Returns a list of all supported transit types in the given metro area." + } + ] + } + }, + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/MobilityLanguage" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MetroAreaInfoResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/mobility/transit/nearby/{format}": { + "get": { + "x-publish": true, + "operationId": "Mobility_GetNearbyTransitPreview", + "description": "**Find Nearby Transit API**\n\n**Applies to**: S1 pricing tier.\n\nGet Nearby Transit service allows you to search public transit stops around a given location returning the transit object details. Service allows users to search for public transit stops within a given radius returning a set of stops with stop details. Additional information such as transit operator information is returned depending on the options selected. The returned information can be used for further processing such as requesting [real-time arrivals](https://aka.ms/AzureMapsMobilityRealTimeArrivals) for the stop or [transit stop details](https://aka.ms/AzureMapsMobilityTransitStop) such as main transit type of most lines stopping for a given public, active service alerts or main transport agency.", + "x-ms-examples": { + "NearbyTransit": { + "$ref": "./examples/GetNearbyTransit.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "$ref": "#/parameters/MetroId" + }, + { + "name": "query", + "description": "Location input from user. The applicable location query specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "limit", + "description": "Maximum number of responses that will be returned. Default is 3, minimum 1 and maximum 100. Sort order is based on distance from input location.", + "in": "query", + "required": false, + "type": "integer" + }, + { + "name": "radius", + "description": "Specifies the search area to constrain a search. The radius in meters to for the results to be constrained to the defined area. Default value is 30 meters, minimum 1 meter and maximum 5000 meters (5km).", + "in": "query", + "required": false, + "type": "integer" + }, + { + "name": "objectType", + "description": "The transit object type. By default, objectType is set to `stop`", + "in": "query", + "required": false, + "default": "stop", + "type": "string" + }, + { + "$ref": "#/parameters/MobilityLanguage" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NearbyTransitResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/mobility/transit/line/{format}": { + "get": { + "x-publish": true, + "operationId": "Mobility_GetTransitLineInfoPreview", + "description": "**Transit Line Info API**\n\n**Applies to**: S1 pricing tier.\n\nYour scenario might require requesting transit line specific data such as stops and line geometry. Transit Line Info service allows you to request line group by line group id returning a line group comprised a set of lines. Additional information such as 24 hours static schedule, active alerts for the line group and line patterns is also available, depending on the options selected. Mobility services uses a parallel data model for public transit lines and line groups. Usually line group contains 2 lines, one going from A to B, and the other returning from B to A, both operating by the same Public Transport Agency having the same line number. We recommend you review our guidance [article](https://aka.ms/AMapsPublicTRansitConcepts) to understand the concepts of lines and line groups.", + "x-ms-examples": { + "TransitLineInfo": { + "$ref": "./examples/GetTransitLineInfo.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "$ref": "#/parameters/MetroId" + }, + { + "name": "query", + "description": "lineGroupId, for example,'666074'. Typically contains 2 lines having the same agency and line, one going from A to B, and the other from B to A.", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "detailType", + "description": "Specify additional details requested respective to the line group as a comma separated list. As a default service returns line basic info. Supported values are:\n * `alerts` - Return any active service alerts for the specified stop. Response provides brief information for disruption in service and all basic data associated with the alert.\n * `alertDetails` - Can only be used in conjunction with detailType=alerts.Return additional details associated with the active service alerts.\n * `lines` - Return transit lines that stops at the specified stop.\n * `stops` - Return list of stops the line group goes through.\n * `schedule` - Return a 24h static schedule for the specified line group from the current time of the day to the end of the current day.\n * `patterns` - Return list of patterns this group is comprised of. A pattern consists of a stop sequence and shape per line.", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "alerts", + "alertDetails", + "lines", + "stops", + "schedule", + "patterns" + ], + "x-ms-enum": { + "name": "TransitLineDetailType", + "modelAsString": false, + "values": [ + { + "value": "alerts", + "description": "Return any active service alerts for the specified stop. Response provides brief information for disruption in service and all basic data associated with the alert." + }, + { + "value": "alertDetails", + "description": "Can only be used in conjunction with detailType=alerts.Return additional details associated with the active service alerts." + }, + { + "value": "lines", + "description": "Return transit lines that stops at the specified stop." + }, + { + "value": "stops", + "description": "Return list of stops the line group goes through." + }, + { + "value": "schedule", + "description": "Return a 24h static schedule for the specified line group from the current time of the day to the end of the current day." + }, + { + "value": "patterns", + "description": "Return list of patterns this group is comprised of. A pattern consists of a stop sequence and shape per line." + } + ] + } + } + }, + { + "$ref": "#/parameters/MobilityLanguage" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TransitLineInfoResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/mobility/transit/stop/{format}": { + "get": { + "x-publish": true, + "operationId": "Mobility_GetTransitStopInfoPreview", + "description": "**Transit Stop Info API**\n\n**Applies to**: S1 pricing tier.\n\nGet Transit Stop Info service allows you to request information for a given public transit stop. Basic information returned includes details such as main transit type of most lines stopping for a given public and main transport agency. Additional details such as stop lines and active service alerts for specified stop are also available, depending on the options selected.", + "x-ms-examples": { + "TransitStopInfo": { + "$ref": "./examples/GetTransitStopInfo.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "$ref": "#/parameters/MetroId" + }, + { + "name": "query", + "description": "The stopId or stopKey for which the user is requesting transit stop details.", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "queryType", + "description": "The type of the unique query parameter of the stop. By default queryType=stopId.", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "stopId", + "stopKey" + ], + "default": "stopId", + "x-ms-enum": { + "name": "TransitStopQueryType", + "modelAsString": false, + "values": [ + { + "value": "stopId", + "description": "The unique Azure Maps identifier for the respective public transit stop. When referring to public transit stops over time, it is recommended to use `stopId` since it will not change, as long as the physical stop exists" + }, + { + "value": "stopKey", + "description": "The GTFS stop Id. GTFS stop Ids are provided by the transit authority and are subject to change.
**Note**: When this value is used, the metroId parameter is required." + } + ] + }, + "x-ms-parameter-location": "method" + }, + { + "name": "detailType", + "description": "Specify additional details requested respective to the transit stop as a comma separated list. Supported values are:\n * `alerts` - Return any active service alerts for the specified stop. Response provides brief information for disruption in service and all basic data associated with the alert.\n * `alertDetails` - Can only be used in conjunction with detailType=alerts.Return additional details associated with the active service alerts.\n * `lines` - Return transit lines that stops at the specified stop.\n * `lineGroups` - Return line groups that stops at the specified stop.", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "alerts", + "alertDetails", + "lines", + "lineGroups" + ], + "x-ms-enum": { + "name": "TransitStopDetailType", + "modelAsString": false, + "values": [ + { + "value": "alerts", + "description": "Return any active service alerts for the specified stop. Response provides brief information for disruption in service and all basic data associated with the alert." + }, + { + "value": "alertDetails", + "description": "Can only be used in conjunction with detailType=alerts.Return additional details associated with the active service alerts." + }, + { + "value": "lines", + "description": "Return transit lines that stops at the specified stop." + }, + { + "value": "lineGroups", + "description": "Return line groups that stops at the specified stop." + } + ] + } + } + }, + { + "$ref": "#/parameters/MobilityLanguage" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TransitStopInfoResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/mobility/transit/route/{format}": { + "get": { + "x-publish": true, + "operationId": "Mobility_GetTransitRoutePreview", + "description": "**Transit Route API**\n\n**Applies to**: S1 pricing tier.\n\nGet Transit Route API will allow trip planning returning the best possible route options between an origin and destination by using multi-modal search. Service provides a variety of travel modes, including walk, bike, and public transit. The API supports parameters to request one or multiple public transit types such as bus, tram and subway, and prefer a specific transit agency operating in the area. Also, service provides options to choose optimal route with least walk or transfers and specify arrival or departure times when user need to be at a specific destination by a certain time.", + "x-ms-examples": { + "TransitRoute": { + "$ref": "./examples/GetTransitRoute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "$ref": "#/parameters/MetroId" + }, + { + "name": "origin", + "description": "The origin of the route. By default originType=position, specified as a comma separated string composed by latitude followed by longitude, e.g. \"47.641268,-122.125679”.", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "originType", + "description": "The type of the origin. By default originType=position, specified as a comma separated string composed by latitude followed by longitude, e.g., \"47.641268,-122.125679”.", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "position", + "stopId", + "stopKey" + ], + "default": "position", + "x-ms-enum": { + "name": "OriginType", + "modelAsString": false, + "values": [ + { + "value": "position", + "description": "The origin of the route as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\"." + }, + { + "value": "stopId", + "description": "The unique Azure Maps identifier for the respective public transit stop. When referring to public transit stops over time, it is recommended to use `stopId` since it will not change, as long as the physical stop exists" + }, + { + "value": "stopKey", + "description": "The GTFS stop Id. GTFS stop Ids are provided by the transit authority and are subject to change.
**Note**: When this value is used, the metroId parameter is required." + } + ] + }, + "x-ms-parameter-location": "method" + }, + { + "name": "destination", + "description": "The destination of the route. By default the destinationType=position, specified as a comma separated string composed by latitude followed by longitude, e.g. \"47.641268,-122.125679”.", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "destinationType", + "description": "The type of the destination.", + "in": "query", + "required": false, + "type": "string", + "default": "position", + "enum": [ + "position", + "stopId", + "stopKey" + ], + "x-ms-enum": { + "name": "DestinationType", + "modelAsString": false, + "values": [ + { + "value": "position", + "description": "The destination of the route as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\"." + }, + { + "value": "stopId", + "description": "The unique Azure Maps identifier for the respective public transit stop. When referring to public transit stops over time, it is recommended to use `stopId` since it will not change, as long as the physical stop exists." + }, + { + "value": "stopKey", + "description": "The GTFS stop Id. GTFS stop Ids are provided by the transit authority and are subject to change.
**Note**: When this value is used, the metroId parameter is required." + } + ] + }, + "x-ms-parameter-location": "method" + }, + { + "name": "modeType", + "description": "The mode of travel for the requested route; as comma separated list. If not specified, all modes will be allowed. All modes might not be available in all metro areas. If valid trip is not found, empty result will be returned. Supported values are:\n * `walk` - Walk (pedestrian)\n * `bike` - Bike\n * `publicTransit` - Public transit", + "required": false, + "in": "query", + "type": "array", + "items": { + "type": "string", + "enum": [ + "walk", + "bike", + "publicTransit" + ], + "x-ms-enum": { + "name": "ModeType", + "modelAsString": false, + "values": [ + { + "value": "walk", + "description": "walk (pedestrian)" + }, + { + "value": "bike", + "description": "bike" + }, + { + "value": "publicTransit", + "description": "public transit" + } + ] + } + }, + "x-ms-parameter-location": "method" + }, + { + "name": "transitType", + "description": "Applicable only with modeType = publicTransit. Allow only a specific set of public transit types (as a comma separated list) to be returned for the route. Note that the requested transitType may not be available for the entire route. If not specified, all modes will be allowed. Supported values are:\n * `bus` - Bus\n * `cableCar` - Cable car\n * `ferry` - Ferry\n * `funicular` - Funicular\n * `gondola` - Gondola\n * `rail` - Rail\n * `tram` - Tram\n * `subway` - Subway/Metro", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "bus", + "cableCar", + "ferry", + "funicular", + "gondola", + "rail", + "tram", + "subway" + ], + "x-ms-enum": { + "name": "TransitTypeFilter", + "modelAsString": false, + "values": [ + { + "value": "bus", + "description": "bus" + }, + { + "value": "cableCar", + "description": "cableCar" + }, + { + "value": "ferry", + "description": "ferry" + }, + { + "value": "funicular", + "description": "funicular" + }, + { + "value": "gondola", + "description": "gondola" + }, + { + "value": "rail", + "description": "rail" + }, + { + "value": "tram", + "description": "tram" + }, + { + "value": "subway", + "description": "subway" + } + ] + } + }, + "x-ms-parameter-location": "method" + }, + { + "name": "agency", + "description": "Specifies whether to prefer routes from a specific set of agencies if possible; as a comma separated list. If valid trip isn’t found with the preferred agency, or only one with very long trips or with large number of transfers, itineraries with other agencies will be returned.", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + } + }, + { + "name": "agencyType", + "description": "Specifies the agency identifier to request routes from preferred agencies. By default the agencyType=agencyId.", + "in": "query", + "required": false, + "type": "string", + "default": "agencyId", + "enum": [ + "agencyId", + "agencyKey", + "agencyName" + ], + "x-ms-enum": { + "name": "AgencyType", + "modelAsString": false, + "values": [ + { + "value": "agencyId", + "description": "The Id of the transit agency, e.g. '5872'" + }, + { + "value": "agencyKey", + "description": "The agency’s GTFS Id.
**Note**: When this value is used, the metroId parameter is required." + }, + { + "value": "agencyName", + "description": "The name of the transit agency, e.g. Metro Transit." + } + ] + }, + "x-ms-parameter-location": "method" + }, + { + "name": "time", + "description": "The time of departure or arrival in the local time in ISO format (2019-04-05T14:24:18-04:00). If timeType is not specified, it will be assumed to be 'departure' and time is the current local time at the origin point.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "timeType", + "description": "Specifies whether the time signifies departure time or arrival time. If not defined, default value is 'departure'.", + "in": "query", + "required": false, + "type": "string", + "default": "departure", + "enum": [ + "arrival", + "departure", + "last" + ], + "x-ms-enum": { + "name": "TimeType", + "modelAsString": false, + "values": [ + { + "value": "arrival", + "description": "arrival at the destination point. Requires that 'time' value must be in the future." + }, + { + "value": "departure", + "description": "Request departure at the destination point. Requires that 'time' value must be now or in the future." + }, + { + "value": "last", + "description": "Request the last lines for the day." + } + ] + } + }, + { + "name": "routeType", + "description": "The type of route requested. If not specified, 'optimal' will be used.", + "in": "query", + "required": false, + "type": "string", + "default": "optimal", + "enum": [ + "optimal", + "leastWalk", + "leastTransfers" + ], + "x-ms-enum": { + "name": "TransitRouteType", + "modelAsString": false, + "values": [ + { + "value": "optimal", + "description": "The best optimal route." + }, + { + "value": "leastWalk", + "description": "Route with least walk." + }, + { + "value": "leastTransfers", + "description": "Route with least transfers." + } + ] + } + }, + { + "name": "bikeType", + "description": "Bike type of the bike. Specifies which type of bikes will be used. Only private bikes are supported.", + "in": "query", + "required": false, + "type": "string", + "default": "privateBike" + }, + { + "$ref": "#/parameters/MobilityLanguage" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TransitRouteResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/mobility/transit/itinerary/{format}": { + "get": { + "x-publish": true, + "operationId": "Mobility_GetTransitItineraryPreview", + "description": "**Transit Itinerary API**\n\n**Applies to**: S1 pricing tier.\n\nReturns data according to an itinerary Id previously returned by [Transit Route API](https://aka.ms/AzureMapsMobilityTransitRoute). The basic info contains data as to the various legs comprising the itinerary, including the locations, public transit lines, start and end times. User can request additional routing information such as the shape of the itinerary and detailed itinerary schedules is also available, depending on the options selected. An itinerary is available up to 24 hours following a search request.", + "x-ms-examples": { + "TransitItinerary": { + "$ref": "./examples/GetTransitItinerary.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "query", + "description": "The unique id (itineraryId) of an itinerary previously returned by [Transit Route API](https://aka.ms/AzureMapsMobilityTransitRoute).", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "detailType", + "description": "Specify additional details returned in the transit route itinerary response, as a comma separated list. Supported values are:\n * `geometry` - Shape of an in GeoJSON format. For public transit legs will return also the stops that the leg passes through. For walk and bike legs, will return also the turn-by-turn navigation data. \n * `schedule` - Static schedule data as to all departures of Public Transit legs from the current time of the day to the end of the current day.", + "required": false, + "in": "query", + "type": "array", + "items": { + "type": "string", + "enum": [ + "geometry", + "schedule" + ], + "x-ms-enum": { + "name": "TransitItineraryDetailType", + "modelAsString": false, + "values": [ + { + "value": "geometry", + "description": "Shape of an in GeoJSON format. For public transit legs will return also the stops that the leg passes through. For walk and bike legs, will return also the turn-by-turn navigation data." + }, + { + "value": "schedule", + "description": "Static schedule data as to all departures of Public Transit legs from the current time of the day to the end of the current day." + } + ] + } + }, + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/MobilityLanguage" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TransitItineraryResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/mobility/realtime/arrivals/{format}": { + "get": { + "x-publish": true, + "operationId": "Mobility_GetRealTimeArrivalsPreview", + "description": "**Real-time Arrivals API**\n\n**Applies to**: S1 pricing tier.\n\nGet Real Time Arrivals API returns for a given a stop, line or location the requested number of real-time arrivals. Endpoint support different modes to request real-time arrivals such as number of live arrivals for all lines arriving at the specified stop or all arrivals of a line to stops near the user’s location. The API supports parameters to request one or multiple public transit types such as bus, tram and subway, maximum number if arrivals, and prefer a specific transit agency operating in the area. In some cases real-time arrivals may not be available, for example, if arrival is too far in the future or transit vehicle does not have capability to share the real-time location. This is symbolized in a scheduleType field present in all responses.", + "x-ms-examples": { + "RealTimeArrivals": { + "$ref": "./examples/GetRealTimeArrivals.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "$ref": "#/parameters/MetroId" + }, + { + "name": "query", + "description": "Stop, line or location identifier.", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "queryType", + "description": "The type of the query parameter. Defines the mode of the request. Only one mode per request is supported. By default queryType is set to be ‘stops’ returning the requested number of Live Arrivals for all lines arriving at the specified stop.", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "stops", + "line", + "lineAndStop", + "position" + ], + "default": "stops", + "x-ms-enum": { + "name": "RealTimeArrivalsQueryType", + "modelAsString": false, + "values": [ + { + "value": "stops", + "description": "One or multiple stops as a comma separated list. Returns the requested number of live arrivals for all lines arriving at the specified stop. Defined by parameter stopQueryType." + }, + { + "value": "line", + "description": "Returns the next live arrival times for each stop within the specified line. lineId, for example, '3785742'." + }, + { + "value": "lineAndStop", + "description": "Returns up to three next Live Arrival times for a given line at a given stop. Comma-separated list including lineId and stop identifier, for example, 1228526,14014071 (lineId,stopId)." + }, + { + "value": "position", + "description": "Returns arrivals of a line to stops near the user’s location. The applicable location query specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\"." + } + ] + }, + "x-ms-parameter-location": "method" + }, + { + "name": "stopQueryType", + "description": "The type of the unique query parameter of the stop. By default stopQueryType=stopId. This parameter can only be used in conjunction with queryType=stops or queryType=lineAndStop.", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "stopId", + "stopKey" + ], + "default": "stopId", + "x-ms-enum": { + "name": "StopQueryType", + "modelAsString": false, + "values": [ + { + "value": "stopId", + "description": "The unique Azure Maps identifier for the respective public transit stop. When referring to public transit stops over time, it is recommended to use `stopId` since it will not change, as long as the physical stop exists." + }, + { + "value": "stopKey", + "description": "The GTFS stop Id. GTFS stop Ids are provided by the transit authority and are subject to change.
**Note**: When this value is used, the metroId parameter is required." + } + ] + }, + "x-ms-parameter-location": "method" + }, + { + "name": "limit", + "description": "The maximum arrivals to return. If not specified, the system default will be used. For stops max number of arrivals per stop. For lines max arrivals per stop on the line. For everything else max arrivals overall.", + "in": "query", + "required": false, + "type": "integer" + }, + { + "name": "maxMinutesInFuture", + "description": "The maximum time (in minutes) in the future to return arrivals for. If not specified, the system default (30 minutes) will be used. The minimum value is 0 and maximum value is 60 minutes.", + "required": false, + "type": "integer", + "in": "query" + }, + { + "name": "transitType", + "description": "Type of public transit user is requesting respective transit stop, as a comma separated list. For example, transitType=Bus,Subway. If not specified, all will be allowed. This parameter can only be used in conjunction with queryType=stops. Supported values are:\n * `bus` - Bus\n * `cableCar` - Cable car\n * `ferry` - Ferry\n * `funicular` - Funicular\n * `gondola` - Gondola\n * `rail` - Rail\n * `tram` - Tram\n * `subway` - Subway/Metro", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "bus", + "cableCar", + "ferry", + "funicular", + "gondola", + "rail", + "tram", + "subway" + ], + "x-ms-enum": { + "name": "TransitTypeFilter", + "modelAsString": false, + "values": [ + { + "value": "bus", + "description": "bus" + }, + { + "value": "cableCar", + "description": "cableCar" + }, + { + "value": "ferry", + "description": "ferry" + }, + { + "value": "funicular", + "description": "funicular" + }, + { + "value": "gondola", + "description": "gondola" + }, + { + "value": "rail", + "description": "rail" + }, + { + "value": "tram", + "description": "tram" + }, + { + "value": "subway", + "description": "subway" + } + ] + } + }, + "x-ms-parameter-location": "method" + }, + { + "name": "agency", + "description": "In case you prefer routes from a specific set of agencies to be returned. Specified as a comma separated string.", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + } + }, + { + "name": "agencyType", + "description": "Specifies the agency identifier to request routes from a specific set of agencies to be returned. By default the agencyType=agencyId.", + "in": "query", + "required": false, + "type": "string", + "default": "agencyId", + "enum": [ + "agencyId", + "agencyKey", + "agencyName" + ], + "x-ms-enum": { + "name": "AgencyType", + "modelAsString": false, + "values": [ + { + "value": "agencyId", + "description": "The Id of the transit agency, e.g. '5872'" + }, + { + "value": "agencyKey", + "description": "The agency’s GTFS Id.
**Note**: When this value is used, the metroId parameter is required." + }, + { + "value": "agencyName", + "description": "The name of the transit agency, e.g. Metro Transit." + } + ] + }, + "x-ms-parameter-location": "method" + }, + { + "name": "timeoutInSeconds", + "description": "Time in seconds within which if the provider doesn’t respond, end point will return static data.", + "in": "query", + "required": false, + "type": "integer" + }, + { + "$ref": "#/parameters/MobilityLanguage" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RealTimeArrivalsResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + } + }, + "definitions": { + "ODataErrorResponse": { + "type": "object", + "description": "This response object is returned when an error occurs in the Maps API.", + "properties": { + "error": { + "$ref": "#/definitions/ODataError" + } + } + }, + "ODataError": { + "type": "object", + "description": "This object is returned when an error occurs in the Maps API.", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The ODataError code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + } + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the target causing the error." + } + } + }, + "Coordinate": { + "description": "A location represented as a latitude and longitude.", + "type": "object", + "properties": { + "latitude": { + "description": "Latitude property", + "type": "number", + "format": "double", + "readOnly": true + }, + "longitude": { + "description": "Longitude property", + "type": "number", + "format": "double", + "readOnly": true + } + } + }, + "GeoJSONGeometry": { + "description": "A valid `GeoJSON` geometry object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1) for details.", + "type": "object", + "discriminator": "type", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "Specifies the `GeoJSON` geometry type. Must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection.", + "type": "string", + "enum": [ + "Point", + "MultiPoint", + "LineString", + "MultiLineString", + "Polygon", + "MultiPolygon", + "GeometryCollection" + ], + "x-ms-enum": { + "name": "GeoJSONGeometryType", + "modelAsString": false, + "values": [ + { + "value": "Point", + "description": "`GeoJSON Point` geometry." + }, + { + "value": "MultiPoint", + "description": "`GeoJSON MultiPoint` geometry." + }, + { + "value": "LineString", + "description": "`GeoJSON LineString` geometry." + }, + { + "value": "MultiLineString", + "description": "`GeoJSON MultiLineString` geometry." + }, + { + "value": "Polygon", + "description": "`GeoJSON Polygon` geometry." + }, + { + "value": "MultiPolygon", + "description": "`GeoJSON MultiPolygon` geometry." + }, + { + "value": "GeometryCollection", + "description": "`GeoJSON GeometryCollection` geometry." + } + ] + } + } + } + }, + "Polygon": { + "description": "A valid `GeoJSON Polygon` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.6) for details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJSONGeometry" + }, + { + "properties": { + "type": { + "description": "Specifies the `type` for the object. Value should always be equal to \"Polygon\".", + "type": "string" + }, + "coordinates": { + "description": "Coordinates for the `Polygon` geometry type.", + "type": "array", + "items": { + "$ref": "#/definitions/GeoJSONLinearRing" + } + } + }, + "required": [ + "coordinates" + ] + } + ] + }, + "LineString": { + "description": "A valid `GeoJSON LineString` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.4) for details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJSONGeometry" + }, + { + "properties": { + "type": { + "description": "Specifies the `type` for the geometry. Value should always be equal to \"LineString\".", + "type": "string" + }, + "coordinates": { + "description": "Coordinates for the `LineString` geometry.", + "type": "array", + "items": { + "$ref": "#/definitions/GeoJSONPosition" + } + } + }, + "required": [ + "coordinates" + ] + } + ] + }, + "GeoJSONLinearRing": { + "description": "Though a linear ring is not explicitly represented as a GeoJSON geometry type, it helps in defining the polygon as an array of linear rings. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.6) for details.", + "type": "array", + "items": { + "$ref": "#/definitions/GeoJSONPosition" + } + }, + "GeoJSONPosition": { + "description": "A valid `GeoJSON Position` geometry type. A `Position` is an array of numbers with two or more elements. The first two elements are _longitude_ and _latitude_, precisely in that order. _Altitude/Elevation_ is an optional third element. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.1) for details.", + "type": "array", + "items": { + "type": "number", + "format": "double" + } + }, + "MetroAreaResponse": { + "description": "This object is returned from a successful Get Metro Area call", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/definitions/MetroAreaResult" + } + } + } + }, + "MetroAreaInfoResponse": { + "description": "This object is returned from a successful Metro Area call.", + "type": "object", + "properties": { + "metroName": { + "type": "string", + "description": "The name of the metro area." + }, + "transitTypes": { + "type": "array", + "items": { + "$ref": "#/definitions/TransitTypeResult" + } + }, + "agencies": { + "type": "array", + "items": { + "$ref": "#/definitions/Agency" + } + }, + "alerts": { + "type": "array", + "items": { + "$ref": "#/definitions/Alert" + } + } + } + }, + "NearbyTransitResponse": { + "description": "This object is returned from a successful Get Nearby Transit call", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/definitions/TransitObjectResult" + } + } + } + }, + "TransitStopInfoResponse": { + "description": "This object is returned from a successful Get Transit Stop Info call", + "type": "object", + "properties": { + "stop": { + "$ref": "#/definitions/Stop" + }, + "lines": { + "$ref": "#/definitions/Lines" + }, + "lineGroups": { + "$ref": "#/definitions/LineGroups" + }, + "alerts": { + "$ref": "#/definitions/Alerts" + } + } + }, + "TransitRouteResponse": { + "description": "This object is returned from a successful Get Transit Stop Info call", + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/definitions/ItineraryResult" + } + } + } + }, + "TransitItineraryResponse": { + "description": "This object is returned from a successful Get Transit Itinerary call", + "type": "object", + "properties": { + "departureTime": { + "description": "The date and time of departure from the origin point in ISO 8601 format, e.g. 1996-12-19T16:39:57-08:00.", + "type": "string" + }, + "arrivalTime": { + "description": "The date and time of arrival at the destination point in ISO 8601 format, e.g. 1996-12-19T19:39:57-08:00.", + "type": "string" + }, + "legs": { + "$ref": "#/definitions/ItinerarySummary" + } + } + }, + "TransitLineInfoResponse": { + "description": "This object is returned from a successful Transit Line Info call.", + "type": "object", + "properties": { + "lineGroup": { + "description": "Groups together all lines that are logically part of the same group. Typically contains 2 lines having the same agency and line, one going from A to B, and the other from B to A.", + "$ref": "#/definitions/LineGroup" + }, + "lines": { + "description": "The line group’s basic info and list of the lines.", + "$ref": "#/definitions/Lines" + }, + "stops": { + "description": "List of stops the line group goes through.", + "type": "array", + "items": { + "$ref": "#/definitions/Stop" + } + }, + "patterns": { + "description": "List of patterns this group is comprised of. A pattern consists of a stop sequence and shape per a line in GeoJSON format.", + "type": "array", + "items": { + "$ref": "#/definitions/Pattern" + } + }, + "schedule": { + "description": "Line schedule for the current 24h. May be null in case no schedule exists for the current time.", + "$ref": "#/definitions/LineArrival" + } + } + }, + "RealTimeArrivalsResponse": { + "description": "This object is returned from a successful Get Real Time Arrival Info call.", + "type": "object", + "properties": { + "results": { + "description": "Results array. Contains results related details.", + "type": "array", + "items": { + "$ref": "#/definitions/RealTimeArrivalResult" + } + } + } + }, + "MetroAreaResult": { + "description": "Details of the metro area.", + "type": "object", + "properties": { + "metroId": { + "description": "The metro area's Id for use with other API calls.", + "type": "integer" + }, + "metroName": { + "description": "The main display name of the metro.", + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/Polygon" + }, + "viewport": { + "$ref": "#/definitions/ResultViewport" + } + } + }, + "ResultViewport": { + "description": "The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport.", + "type": "object", + "properties": { + "topLeftPoint": { + "$ref": "#/definitions/Coordinate" + }, + "btmRightPoint": { + "$ref": "#/definitions/Coordinate" + } + } + }, + "TransitObjectResult": { + "type": "object", + "properties": { + "id": { + "description": "The unique identifier (stopID) for the returned public transit stop. When referring to public transit stops over time, it is recommended to use `stopId` since it will not change, as long as the physical stop exists.", + "type": "string" + }, + "type": { + "description": "The type of object found as a result of the query.", + "type": "string" + }, + "objectDetails": { + "description": "The object specific details.", + "type": "object" + }, + "position": { + "description": "The transit object's position.", + "$ref": "#/definitions/Coordinate" + }, + "viewport": { + "$ref": "#/definitions/ResultViewport" + } + } + }, + "Stop": { + "description": "The stop's basic info", + "type": "object", + "properties": { + "stopId": { + "description": "The unique Azure Maps identifier for the respective public transit stop. When referring to public transit stops over time, it is recommended to use `stopId` since it will not change, as long as the physical stop exists.", + "type": "string" + }, + "stopKey": { + "description": "The GTFS stop Id. GTFS stop Ids are provided by the transit authority and subject to change.", + "type": "string" + }, + "stopName": { + "description": "The name of the stop.", + "type": "string" + }, + "stopCode": { + "description": "The stop code displayed at the physical stop. Returned if available.", + "type": "string" + }, + "position": { + "description": "The Stop's location, latitude and longitude.", + "$ref": "#/definitions/Coordinate" + }, + "mainTransitType": { + "description": "The transit type of most lines stopping at this stop. One of Tram, Subway, Rail, Bus, Ferry, CableCar, Gondola, Funicular", + "type": "string" + }, + "mainAgencyId": { + "description": "The Id of the transit agency of most lines stopping at this stop. For example '5872'.", + "type": "string" + }, + "mainAgencyName": { + "description": "The name of the agency of most lines stopping at this stop, for example, 'Metro Transit'.", + "type": "string" + } + } + }, + "Lines": { + "description": "A list of stop lines", + "type": "array", + "items": { + "$ref": "#/definitions/Line" + } + }, + "Line": { + "description": "A stop line", + "type": "object", + "properties": { + "lineId": { + "description": "Line Id.", + "type": "string" + }, + "lineGroupId": { + "description": "Line group Id. Typically contains 2 lines having the same agency and line, one going from A to B, and the other from B to A.", + "type": "string" + }, + "direction": { + "description": "Line direction. Possible values 'forward' or 'backward'.", + "type": "string" + }, + "agencyId": { + "description": "The Id of the transit agency, for example, '5872'.", + "type": "string" + }, + "agencyName": { + "description": "The name of the transit agency, for example, 'NJ Transit'.", + "type": "string" + }, + "lineNumber": { + "description": "The transit line number.", + "type": "string" + }, + "origin": { + "description": "The line’s origin, will be present according to metro settings.", + "type": "string" + }, + "lineDestination": { + "description": "The line’s user displayable destination.", + "type": "string" + }, + "mostFrequentPatternId": { + "description": "Most common pattern for the line.", + "type": "string" + }, + "transitType": { + "description": "The public transit type of the line.", + "$ref": "#/definitions/TransitType" + } + } + }, + "LineGroups": { + "description": "A list of line groups", + "type": "array", + "items": { + "$ref": "#/definitions/LineGroup" + } + }, + "LineGroup": { + "description": "A line group", + "type": "object", + "properties": { + "lineGroupId": { + "description": "Line group Id. Typically contains 2 lines having the same agency and line, one going from A to B, and the other from B to A.", + "type": "string" + }, + "agencyId": { + "description": "The Id of the transit agency, for example, '5872'.", + "type": "string" + }, + "agencyName": { + "description": "The name of the transit agency, e.g. Metro Transit.", + "type": "string" + }, + "lineNumber": { + "description": "The transit line number.", + "type": "string" + }, + "caption1": { + "description": "A descriptive string. In case caption2 is null, should be used alone as a subtitle to the line number (i.e. Circular). In case caption2 has a value present, should be used in conjunction with it (i.e. Rome ↔ Napoli).", + "type": "string" + }, + "caption2": { + "description": "A descriptive string.", + "type": "string" + }, + "color": { + "description": "HEX color for the line.", + "type": "string" + }, + "transitType": { + "description": "The public transit type of the line.", + "$ref": "#/definitions/TransitType" + } + } + }, + "Alerts": { + "description": "A list of stop alerts", + "type": "array", + "items": { + "$ref": "#/definitions/Alert" + } + }, + "Alert": { + "description": "Basic information associated with the active alert.", + "type": "object", + "properties": { + "alertSummary": { + "description": "Text summarizing the alert.", + "type": "string" + }, + "publicationDate": { + "description": "The date and time in ISO 8601 format, e.g. 2019-04-05T14:24:18-04:00.", + "type": "string", + "format": "date-time" + }, + "category": { + "description": "The category of the alert. One of None, Regular, Info, Modified, Critical.", + "type": "string" + }, + "alertLevel": { + "description": "The level at which the respective alert extents to. One of Metro, Agency, Line, Stop.", + "type": "string" + }, + "details": { + "$ref": "#/definitions/AlertDetail" + } + } + }, + "AlertDetail": { + "description": "A list of alert details.", + "type": "object", + "properties": { + "agencyId": { + "description": "The Id of the relevant transit agency, for example, '5872'.", + "type": "string" + }, + "agencyName": { + "description": "Name of the relevant transit agency, e.g. Metro Transit.", + "type": "string" + }, + "title": { + "description": "The title of the alert.", + "type": "string" + }, + "description": { + "description": "A short description of the alert.", + "$ref": "#/definitions/AlertDescription" + }, + "activeFrom": { + "description": "The start time of the alert in the local time in ISO format (2019-04-05T14:24:18-04:00).", + "type": "string", + "format": "date-time" + }, + "activeTo": { + "description": "The estimated end time of the alert in the local time in ISO format (2019-04-05T14:24:18-04:00).", + "type": "string", + "format": "date-time" + }, + "effect": { + "description": "Service Alert effect - one of SA_NO_SERVICE, SA_REDUCED_SERVICE, SA_SIGNIFICANT_DELAYS, SA_DETOUR, SA_ADDITIONAL_SERVICE, SA_MODIFIED_SERVICE, SA_OTHER_EFFECT, SA_STOP_MOVED, SA_GOOD_SERVICE, SA_SLEEPING, SA_OTHER_EFFECT", + "type": "string" + } + } + }, + "ItineraryResult": { + "type": "object", + "properties": { + "itineraryId": { + "description": "A unique identifier of the returned itinerary.", + "type": "string" + }, + "departureTime": { + "description": "The date and time of departure from the origin point in ISO 8601 format, e.g. 1996-12-19T16:39:57-08:00.", + "type": "string", + "format": "date-time" + }, + "arrivalTime": { + "description": "The date and time of arrival at the destination point in ISO 8601 format, e.g. 1996-12-19T19:39:57-08:00.", + "type": "string", + "format": "date-time" + }, + "travelTimeInSeconds": { + "description": "Estimated travel time in seconds.", + "type": "integer" + }, + "numberOfLegs": { + "description": "Number of legs.", + "type": "integer" + }, + "legs": { + "description": "An array summarizing the legs of this itinerary.", + "$ref": "#/definitions/RouteItinerarySummary" + } + } + }, + "RouteItinerarySummary": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteItineraryLeg" + } + }, + "RouteItineraryLeg": { + "type": "object", + "properties": { + "legType": { + "description": "The travel mode of the leg.", + "$ref": "#/definitions/LegType" + }, + "legStartTime": { + "description": "Start time for the leg in ISO 8601 format, e.g. 1996-12-19T19:39:57-08:00.", + "type": "string" + }, + "legEndTime": { + "description": "End time for the leg in ISO 8601 format, e.g. 1996-12-19T19:39:57-08:00.", + "type": "string" + }, + "caption": { + "description": "For Public Transit legs the caption of the line serving the leg, for example, line number.", + "type": "string" + }, + "lengthInMeters": { + "description": "The total distance of the leg in meters.", + "type": "integer" + } + } + }, + "ItinerarySummary": { + "description": "An array summarizing the legs of this itinerary.", + "type": "array", + "items": { + "$ref": "#/definitions/Leg" + } + }, + "Leg": { + "type": "object", + "properties": { + "legType": { + "description": "The travel mode of the leg.", + "$ref": "#/definitions/LegType" + }, + "legStartTime": { + "description": "Start time for the leg.", + "type": "string" + }, + "legEndTime": { + "description": "End time for the leg.", + "type": "string" + }, + "steps": { + "description": "In case of walk or bike leg, the directions.", + "type": "array", + "items": { + "$ref": "#/definitions/Step" + } + }, + "origin": { + "description": "The walk/bike leg’s origin.", + "$ref": "#/definitions/LegPoint" + }, + "destination": { + "description": "The walk/bike leg’s destination.", + "$ref": "#/definitions/LegPoint" + }, + "geometry": { + "$ref": "#/definitions/LineString" + }, + "lineGroup": { + "description": "In case of a public transit leg, the line group serving this leg.", + "$ref": "#/definitions/LineGroup" + }, + "line": { + "description": "In case of a public transit leg, the line serving this leg.", + "$ref": "#/definitions/Line" + }, + "stops": { + "description": "List of stops comprising the line’s route within the leg (e.g. the stops the leg passes through).", + "$ref": "#/definitions/Stops" + }, + "departures": { + "description": "Relevant for Public Transit and Wait legs only", + "$ref": "#/definitions/Departures" + }, + "waitOnVehicle": { + "description": "Indicates whether it’s necessary to wait for the next leg on the same vehicle (i.e. the bus will only change its line number).", + "type": "string" + } + } + }, + "LegType": { + "type": "string", + "enum": [ + "Walk", + "Bicycle", + "Tram", + "Subway", + "Rail", + "Bus", + "Ferry", + "Cable", + "Gondola", + "Funicular", + "PathWayWalk", + "Wait", + "WaitOnVehicle" + ], + "x-ms-enum": { + "name": "LegType", + "modelAsString": false, + "values": [ + { + "value": "Walk", + "description": "Pedestrian walk" + }, + { + "value": "Bicycle", + "description": "Bicycle" + }, + { + "value": "Tram", + "description": "Tram" + }, + { + "value": "Subway", + "description": "Subway" + }, + { + "value": "Rail", + "description": "Rail" + }, + { + "value": "Bus", + "description": "Bus" + }, + { + "value": "Ferry", + "description": "Ferry" + }, + { + "value": "Cable", + "description": "Cable Car" + }, + { + "value": "Gondola", + "description": "Gondola" + }, + { + "value": "Funicular", + "description": "Funicular" + }, + { + "value": "PathWayWalk", + "description": "A Leg describing a walk within a compound, e.g. Central Station" + }, + { + "value": "Wait", + "description": "A Leg describing a wait for the next public transit leg" + }, + { + "value": "WaitOnVehicle", + "description": "It’s necessary to wait for the next leg on the same vehicle (i.e. the bus will only change its line number)" + } + ] + } + }, + "LegPoint": { + "type": "object", + "properties": { + "position": { + "$ref": "#/definitions/Coordinate" + } + } + }, + "Stops": { + "type": "array", + "items": { + "$ref": "#/definitions/Stop" + } + }, + "Step": { + "type": "object", + "properties": { + "direction": { + "description": "The walking direction associated with this step.", + "$ref": "#/definitions/Direction" + }, + "streetName": { + "description": "The name of the street in which this step takes place.", + "type": "string" + } + } + }, + "Direction": { + "description": "The walking directions guidance.", + "type": "object", + "properties": { + "relativeDirection": { + "description": "The relative walking direction associated with applicable step.", + "type": "string", + "enum": [ + "depart", + "hardLeft", + "left", + "slightlyLeft", + "continue", + "slightlyRight", + "right", + "hardRight", + "circleClockwise", + "circleCounterclockwise", + "elevator", + "uturnLeft", + "uturnRight" + ], + "x-ms-enum": { + "name": "RelativeDirection", + "modelAsString": false, + "values": [ + { + "value": "depart", + "description": "Leave" + }, + { + "value": "hardLeft", + "description": "Turn sharp left." + }, + { + "value": "left", + "description": "Turn left." + }, + { + "value": "slightlyLeft", + "description": "Turn slightly left." + }, + { + "value": "continue", + "description": "Keep going." + }, + { + "value": "slightlyRight", + "description": "Turn slightly right." + }, + { + "value": "right", + "description": "Turn right." + }, + { + "value": "hardRight", + "description": "Turn sharp right." + }, + { + "value": "circleClockwise", + "description": "Circle clockwise." + }, + { + "value": "circleCounterclockwise", + "description": "Circle counter clockwise." + }, + { + "value": "elevator", + "description": "Take the elevator." + }, + { + "value": "uturnLeft", + "description": "Make a U-turn left." + }, + { + "value": "uturnRight", + "description": "Make a U-turn right." + } + ] + } + }, + "absoluteDirection": { + "description": "The absolute walking direction associated with this step.", + "type": "string", + "enum": [ + "north", + "northeast", + "east", + "southeast", + "south", + "southwest", + "west", + "northwest" + ], + "x-ms-enum": { + "name": "AbsoluteDirection", + "modelAsString": false, + "values": [ + { + "value": "north", + "description": "North" + }, + { + "value": "northeast", + "description": "NorthEast" + }, + { + "value": "east", + "description": "East" + }, + { + "value": "southeast", + "description": "SouthEast" + }, + { + "value": "south", + "description": "South" + }, + { + "value": "southwest", + "description": "SouthWest" + }, + { + "value": "west", + "description": "West" + }, + { + "value": "northwest", + "description": "NorthWest" + } + ] + } + } + } + }, + "Departures": { + "type": "array", + "items": { + "$ref": "#/definitions/LineArrival" + } + }, + "LineArrival": { + "type": "object", + "properties": { + "lineId": { + "description": "Line Id.", + "type": "string" + }, + "stopId": { + "description": "The unique Azure Maps identifier for the respective public transit stop. When referring to public transit stops over time, it is recommended to use `stopId` since it will not change, as long as the physical stop exists.", + "type": "string" + }, + "scheduleTime": { + "description": "The date and time of departure from the stop in ISO 8601 format, e.g. 1996-12-19T19:39:57-08:00.", + "type": "string", + "format": "date-time" + }, + "scheduleType": { + "description": "Whether the result is based on real-time or static data.", + "$ref": "#/definitions/ScheduleType" + } + } + }, + "Pattern": { + "type": "object", + "description": "Stop-shape-segments of the trip pattern, which are an ordered list of the stops and the shapes connecting them.", + "properties": { + "patternId": { + "description": "Pattern Id, for example, '3267995'.", + "type": "string" + }, + "lineId": { + "description": "Line Id.", + "type": "string" + }, + "stopIds": { + "description": "Stops the line goes through.", + "type": "array", + "items": { + "type": "string" + } + }, + "geometry": { + "description": "Stop sequence and shape per a line in GeoJSON format.", + "$ref": "#/definitions/LineString" + } + } + }, + "TransitTypeResult": { + "type": "object", + "properties": { + "transitType": { + "description": "Supported public transit type.", + "$ref": "#/definitions/TransitType" + }, + "captionOverride": { + "description": "For metro areas in which local name is different than the GTFS supported transit type, original name is returned.", + "type": "string" + } + } + }, + "Agency": { + "type": "object", + "description": "Details of the agency.", + "properties": { + "agencyId": { + "description": "The Id of the relevant transit agency, for example, '5872'", + "type": "string" + }, + "agencyKey": { + "description": "The agency’s GTFS Id.", + "type": "string" + }, + "agencyName": { + "description": "Name of the relevant transit agency, e.g. Metro Transit.", + "type": "string" + }, + "transitType": { + "description": "Supported public transit type. One of Tram, Subway, Rail, Bus, Ferry, CableCar, Gondola, Funicular.", + "$ref": "#/definitions/TransitTypeResult" + } + } + }, + "TransitType": { + "type": "string", + "enum": [ + "Bus", + "CableCar", + "Ferry", + "Funicular", + "Gondola", + "Rail", + "Tram", + "Subway" + ], + "x-ms-enum": { + "name": "TransitType", + "modelAsString": false, + "values": [ + { + "value": "Bus", + "description": "bus" + }, + { + "value": "CableCar", + "description": "cableCar" + }, + { + "value": "Ferry", + "description": "ferry" + }, + { + "value": "Funicular", + "description": "funicular" + }, + { + "value": "Gondola", + "description": "gondola" + }, + { + "value": "Rail", + "description": "rail" + }, + { + "value": "Tram", + "description": "tram" + }, + { + "value": "Subway", + "description": "subway" + } + ] + } + }, + "AlertDescription": { + "type": "object", + "properties": { + "data": { + "description": "Description of the alert.", + "type": "string" + }, + "format": { + "description": "Format of the alert description.", + "type": "string" + }, + "sourceUrl": { + "description": "Source URL.", + "type": "string" + } + } + }, + "RealTimeArrivalResult": { + "description": "Contains real-time arrival related details.", + "type": "object", + "properties": { + "arrivalMinutes": { + "description": "The estimated time of arrival in minutes.", + "type": "integer" + }, + "scheduleType": { + "description": "Whether the result is based on real-time or static data.", + "$ref": "#/definitions/ScheduleType" + }, + "patternId": { + "description": "The pattern Id.", + "type": "string" + }, + "line": { + "description": "The public transit type of the line.", + "$ref": "#/definitions/Line" + }, + "stop": { + "description": "Object for the given stop.", + "$ref": "#/definitions/Stop" + } + } + }, + "ScheduleType": { + "description": "Whether the result is based on real-time or static data.", + "type": "string", + "enum": [ + "scheduledTime", + "realTime" + ], + "x-ms-enum": { + "name": "ScheduleType", + "modelAsString": false, + "values": [ + { + "value": "scheduledTime", + "description": "Returned when estimated time of arrival is based on real-time data." + }, + { + "value": "realTime", + "description": "Returned when estimated time of arrival is based on static data." + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetCopyrightCaption.json b/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetCopyrightCaption.json new file mode 100644 index 000000000000..d6e9b47100f2 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetCopyrightCaption.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "formatVersion": "0.0.1", + "copyrightsCaption": "© 1992 - 2017 TomTom." + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetCopyrightForTile.json b/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetCopyrightForTile.json new file mode 100644 index 000000000000..ebbf26fccc88 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetCopyrightForTile.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "zoom": 6, + "x": 9, + "y": 22, + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "formatVersion": "0.0.1", + "generalCopyrights": [ + "© 1992 - 2018 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection, database right protection and other intellectual property rights owned by TomTom or its suppliers. The use of this material is subject to the terms of a license agreement. Any unauthorized copying or disclosure of this material will lead to criminal and civil liabilities.", + "Data Source © 2018 TomTom", + "based on" + ], + "regions": [ + { + "copyrights": [ + "© 2006 – 2018 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection and other intellectual property rights owned or licensed to TomTom. The product includes information copied with permission from Canadian authorities, including © Canada Post Corporation and Department of Natural Resources Canada, All rights reserved. The use of this material is subject to the terms of a License Agreement. You will be held liable for any unauthorized copying or disclosure of this material. Adapted from Statistics Canada: Boundary Files, 2016 Census; Road Network File, 2016; and Census Population and Dwelling Count Highlight Tables, 2016 Census. This does not constitute an endorsement by Statistics Canada of this product", + "The following copyright notice applies to the use of Administrative Area: © 2006 – 2018 TomTom. All rights reserved. Adapted from Statistics Canada: Boundary Files, 2016 Census: Census Population and Dwelling Count Highlight Tables, 2016. This does not constitute an endorsement by Statistics Canada of this product.", + "The following copyright notice applies to the use of Post- FSA layer and 6-digit layer: © 2006 – 2018 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection and other intellectual property rights owned or licensed to TomTom. The product includes information copied with permission from Canadian authorities, including © Canada Post Corporation, All rights reserved. The use of this material is subject to the terms of a License Agreement. You will be held liable for any unauthorized copying or disclosure of this material", + "The following copyright notice applies to the use of Points of Interest: © 2006 – 2018 TomTom. All rights reserved. Portions of the POI database contained in Points of Interest North America have been provided by Neustar Localeze", + "The following copyright notice applies to the use of Telecommunications: © 2017 Pitney Bowes. All rights reserved. In addition, for the following product layers Wire Center Boundaries, ILEC Boundaries, and Rate Center Boundaries, the following also applies: This product contains information and/or data of Telcordia Technologies, Inc. (Telcordia) licensed to be included herein.", + "The following copyright notice applies to the use of TomTom Traffic: Portions of the data have been provided by Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. © 2017. Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. All rights reserved.", + "This product contains address point data made available under the city of Vancouver’s Open Data framework as documented on August 6, 2012 in: vancouver.ca/open-government-licence Contains public sector Datasets made available under the City of Toronto's Open Data Licence v2.0. This is specified in their terms available here: http://www1.toronto.ca/wps/portal/contentonly?vgnextoid=4a37e03bb8d1e310VgnVCM10000071d60f89RCRD", + "Contains information licensed under the Open Government Licence – Strathcona County. For specifics, please reference: https://data.strathcona.ca/licence", + "Contains information licensed under the Open Government Licence – County of Grande Prairie. For specifics, please reference: http://www.countygp.ab.ca/EN/main/community/maps-gis/open-data/open-data-licence.html", + "Contains information licensed under the Open Government Licence – Canada. For specifics, please reference: http://open.canada.ca/en/open-government-licence-canada", + "Contains information licensed under the Calgary Regional Partnership Open Data Licence. For specifics, please reference: http://calgaryregion.ca/dam/Website/reports/General/GIS/Public-documents/Calgary-Regional-Partnership-Open-Data-Licence/Calgary%20Regional%20Partnership%20Open%20Data%20Licence.pdf Contains information licensed under the Open Government Licence – Banff. For specifics, please reference: http://www.banffopendata.ca/Home/About", + "Contains information licensed under the Open Data License – City of Grande Prairie. For specifics, please reference: http://www.cityofgp.com/index.aspx?page=2332", + "Contains information licensed under the Open Government Licence – City of Victoria. For specifics, please reference: http://www.victoria.ca/EN/main/city/open-data-catalogue/open-data-licence.html", + "Contains information licenced under the Open Government Licence - Halifax. For specifics, please reference: http://www.halifax.ca/opendata/OD_TermsOfUse.php", + "Contains information provided by the City of Guelph under an open government license. For specifics, please reference: http://data.open.guelph.ca/pages/open-government-licence", + "Contains information licensed under the Open Government Licence – Haldimand County. For specifics, please reference: http://opendata.haldimandcounty.on.ca/", + "Contains information provided by the City of Hamilton under an open government license. For specifics, please reference: http://www2.hamilton.ca/NR/rdonlyres/C58984A4-FE11-40B9-A231-8572EB922AAA/0/OpenDataTermsAndConditions_Final.html Contains information licensed under the Open Government Licence - Niagara Region. For specifics, please reference: http://www.niagararegion.ca/government/opendata/terms-of-use.aspx", + "Contains information licensed under the Open Government Licence — Town of Oakville. For specifics, please reference: http://www.oakville.ca/data/open_data_licence.html", + "Contains information licensed under the Open Government Licence - The Corporation of the City of Windsor. For specifics, please reference: http://www.citywindsor.ca/opendata/Documents/OpenDataTermsofUse.pdf", + "Contains information licensed under the Open Government Licence – City of Regina. For specifics, please reference: https://www.regina.ca/residents/open-government/open-government-licence/", + "Contains information licensed under the Open Government License - British Columbia. Contains information licensed under the Open Government License - City of Surrey. Contains public sector datasets made available under the City of Brandon's Open Data License. For specifics, please reference: http://opengov.brandon.ca/terms.aspx", + "Contains information licensed under the Open Government License - Winnipeg. For specifics, please reference: https://data.winnipeg.ca/open-data-licence", + "Contains information licensed under the GeoNB Open Data Licence. For specifics, please reference: http://geonb.snb.ca/documents/license/geonb-odl_en.pdf", + "Contains information licensed under the Open Government Licence - The Corporation of the Municipality of Chatham-Kent. Contains information licensed under the Open Government Licence - Niagara Region. For specifics, please referec: https://niagaraopendata.ca/pages/open-government-license-2-0-niagara-region", + "Contains information licensed under the Open Government Licence - City of Welland. Contains information licensed under the Open Government Licence - Prince Edward Island. For specifics, please reference: https://www.princeedwardisland.ca/en/information/finance/open-government-licence-prince-edward-island", + "Contains information licensed under the Open Government License - Kamloops. For specifics, please reference: http://www.kamloops.ca/maps/disclaimer.html", + "Contains information licensed under the Open Government License - Nanaimo. For specifics, please reference: http://www.nanaimo.ca/EN/main/departments/information-technology/DataCatalogue/Licence.html Contains information licensed under the Open Government License – City of New Westminster. For specifics, please reference: http://opendata.newwestcity.ca/licence", + "Contains information licensed under the Open Government License – City of Prince George. For specifics, please reference: http://pgmap.princegeorge.ca/opendata/CityofPrinceGeorge_Open_Government_License_Open_Data.pdf", + "Contains Information licensed under the Open Government Licence – Brantford. For specifics, please reference: http://www.brantford.ca/govt/projects/opendata/Pages/OpenDataLicence.aspx", + "Contains data for Gatineau, QC made available through Creative Commons Attribution 4.0 International. For specifics, please reference: https://creativecommons.org/licenses/by/4.0/legalcode", + "Contains data for Laval, QC made available through Creative Commons Attribution 4.0 International. For specifics, please reference: https://creativecommons.org/licenses/by/4.0/legalcode", + "Contains data for Longueuil, QC made available through Creative Commons Attribution 4.0 International. For specifics, please reference: https://creativecommons.org/licenses/by/4.0/legalcode", + "Contains data for Montreal, QC made available through Creative Commons Attribution 4.0 International. For specifics, please reference: https://creativecommons.org/licenses/by/4.0/legalcode", + "Contains data for Rimouski, QC made available through Creative Commons Attribution 4.0 International. For specifics, please reference: https://creativecommons.org/licenses/by/4.0/legalcode" + ], + "country": { + "ISO3": "CAN", + "label": "Canada" + } + }, + { + "copyrights": [ + "The following copyright notice applies to the use of Points of Interest: © 2006 – 2018 TomTom. All rights reserved. Portions of the POI database contained in Points of Interest North America have been provided by Neustar Localeze", + "The following copyright notice applies to the use of Telecommunications: © 2017 Pitney Bowes. All rights reserved. In addition, for the following product layers Wire Center Boundaries, ILEC Boundaries, and Rate Center Boundaries, the following also applies: This product contains information and/or data of Telcordia Technologies, Inc. (Telcordia) licensed to be included herein.", + "The following copyright notice applies to the use of TomTom Traffic: Portions of the data have been provided by Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. © 2017. Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. All rights reserved.", + "© United States Postal Service 2017", + "Contains data made available by the Rhode Island Geographic Information System (RIGIS) consortium, the State of Rhode Island, and the University of Rhode Island. For specifics, please reference: http://www.rigis.org/information", + "Contains Address Points data made available by State of Maryland and MD iMAP. For specifics, please reference: http://imap.maryland.gov." + ], + "country": { + "ISO3": "USA", + "label": "United States" + } + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetCopyrightForWorld.json b/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetCopyrightForWorld.json new file mode 100644 index 000000000000..ab7e51c902d4 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetCopyrightForWorld.json @@ -0,0 +1,384 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "formatVersion": "0.0.1", + "generalCopyrights": [ + "© 1992 - 2018 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection, database right protection and other intellectual property rights owned by TomTom or its suppliers. The use of this material is subject to the terms of a license agreement. Any unauthorized copying or disclosure of this material will lead to criminal and civil liabilities.", + "Data Source © 2018 TomTom", + "based on" + ], + "regions": [ + { + "copyrights": [ + "This product contains cartographic information (geometry, street names, traffic flow, address points) made available by Govern d’Andorra under legal terms available here; https://www.govern.ad/avis-legal" + ], + "country": { + "ISO3": "AND", + "label": "Andorra" + } + }, + { + "copyrights": [ + "In New South Wales this product contains road centerline geometry from NSW Land Property Information licensed under CC-BY 3.0 AU. © Land and Property Information [2015]. Further information available here: http://spatialservices.finance.nsw.gov.au/mapping_and_imagery/lpi_web_services", + "In Queensland this product contains road centerline geometry from QLD Transport and Main Roads authority made available by the Queensland open data portal and licensed under CC-BY 3.0 AU. Further information available here: https://data.qld.gov.au/dataset/state-controlled-roads-queensland", + "In South Australia this product contains road centerline geometry from SA Department of Planning Transport and Infrastructure made available by the South Australian government and licensed under CC-BY 4.0. Further information available here: http://data.sa.gov.au/data/organization/department-of-planning-transport-and-infrastructure https://data.sa.gov.au/copyright", + "In Tasmania this product contains road centerline attribution from the Tasmanian Government Transport agency. http://www.transport.tas.gov.au/roadsafety/speed", + "In Victoria this product contains cartographic information (roads, speed restriction, vehicle restrictions) made available by the Victorian Government open data portal licensed under CC-BY 4.0. Further information here: http://vicroadsopendata.vicroadsmaps.opendata.arcgis.com/ https://www.data.vic.gov.au/data/dataset", + "In Western Australia this product contains medium scale road centerline geometry from Landgate made available by the Western Australian Government via their open that portal licensed under CC-BY 4.0 http://catalogue.beta.data.wa.gov.au/dataset/roads-lgate-012 http://opendefinition.org/od/2.0/en/", + "This product contains address point data made available in the PSMA Geocoded National Address File (G- NAF) offered via the Australian Federal Government open data portal under EULA terms based on Creative Commons license CC BY 4.0 with the following special restriction. For Specifics please reference: https://data.gov.au/dataset/geocoded-national-address-file-g-naf/resource/09f74802-08b1-4214-a6ea-3591b2753d30" + ], + "country": { + "ISO3": "AUS", + "label": "Australia" + } + }, + { + "copyrights": [ + "© BEV, GZ 1368/2017" + ], + "country": { + "ISO3": "AUT", + "label": "Austria" + } + }, + { + "copyrights": [ + "© Source data. State committee on property of the Republic of Belarus, 2015 © Republic unitary organization <>, 2016" + ], + "country": { + "ISO3": "BLR", + "label": "Belarus" + } + }, + { + "copyrights": [ + "© 2006 – 2018 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection and other intellectual property rights owned or licensed to TomTom. The product includes information copied with permission from Canadian authorities, including © Canada Post Corporation and Department of Natural Resources Canada, All rights reserved. The use of this material is subject to the terms of a License Agreement. You will be held liable for any unauthorized copying or disclosure of this material. Adapted from Statistics Canada: Boundary Files, 2016 Census; Road Network File, 2016; and Census Population and Dwelling Count Highlight Tables, 2016 Census. This does not constitute an endorsement by Statistics Canada of this product", + "The following copyright notice applies to the use of Administrative Area: © 2006 – 2018 TomTom. All rights reserved. Adapted from Statistics Canada: Boundary Files, 2016 Census: Census Population and Dwelling Count Highlight Tables, 2016. This does not constitute an endorsement by Statistics Canada of this product.", + "The following copyright notice applies to the use of Post- FSA layer and 6-digit layer: © 2006 – 2018 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection and other intellectual property rights owned or licensed to TomTom. The product includes information copied with permission from Canadian authorities, including © Canada Post Corporation, All rights reserved. The use of this material is subject to the terms of a License Agreement. You will be held liable for any unauthorized copying or disclosure of this material", + "The following copyright notice applies to the use of Points of Interest: © 2006 – 2018 TomTom. All rights reserved. Portions of the POI database contained in Points of Interest North America have been provided by Neustar Localeze", + "The following copyright notice applies to the use of Telecommunications: © 2017 Pitney Bowes. All rights reserved. In addition, for the following product layers Wire Center Boundaries, ILEC Boundaries, and Rate Center Boundaries, the following also applies: This product contains information and/or data of Telcordia Technologies, Inc. (Telcordia) licensed to be included herein.", + "The following copyright notice applies to the use of TomTom Traffic: Portions of the data have been provided by Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. © 2017. Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. All rights reserved.", + "This product contains address point data made available under the city of Vancouver’s Open Data framework as documented on August 6, 2012 in: vancouver.ca/open-government-licence Contains public sector Datasets made available under the City of Toronto's Open Data Licence v2.0. This is specified in their terms available here: http://www1.toronto.ca/wps/portal/contentonly?vgnextoid=4a37e03bb8d1e310VgnVCM10000071d60f89RCRD", + "Contains information licensed under the Open Government Licence – Strathcona County. For specifics, please reference: https://data.strathcona.ca/licence", + "Contains information licensed under the Open Government Licence – County of Grande Prairie. For specifics, please reference: http://www.countygp.ab.ca/EN/main/community/maps-gis/open-data/open-data-licence.html", + "Contains information licensed under the Open Government Licence – Canada. For specifics, please reference: http://open.canada.ca/en/open-government-licence-canada", + "Contains information licensed under the Calgary Regional Partnership Open Data Licence. For specifics, please reference: http://calgaryregion.ca/dam/Website/reports/General/GIS/Public-documents/Calgary-Regional-Partnership-Open-Data-Licence/Calgary%20Regional%20Partnership%20Open%20Data%20Licence.pdf Contains information licensed under the Open Government Licence – Banff. For specifics, please reference: http://www.banffopendata.ca/Home/About", + "Contains information licensed under the Open Data License – City of Grande Prairie. For specifics, please reference: http://www.cityofgp.com/index.aspx?page=2332", + "Contains information licensed under the Open Government Licence – City of Victoria. For specifics, please reference: http://www.victoria.ca/EN/main/city/open-data-catalogue/open-data-licence.html", + "Contains information licenced under the Open Government Licence - Halifax. For specifics, please reference: http://www.halifax.ca/opendata/OD_TermsOfUse.php", + "Contains information provided by the City of Guelph under an open government license. For specifics, please reference: http://data.open.guelph.ca/pages/open-government-licence", + "Contains information licensed under the Open Government Licence – Haldimand County. For specifics, please reference: http://opendata.haldimandcounty.on.ca/", + "Contains information provided by the City of Hamilton under an open government license. For specifics, please reference: http://www2.hamilton.ca/NR/rdonlyres/C58984A4-FE11-40B9-A231-8572EB922AAA/0/OpenDataTermsAndConditions_Final.html Contains information licensed under the Open Government Licence - Niagara Region. For specifics, please reference: http://www.niagararegion.ca/government/opendata/terms-of-use.aspx", + "Contains information licensed under the Open Government Licence — Town of Oakville. For specifics, please reference: http://www.oakville.ca/data/open_data_licence.html", + "Contains information licensed under the Open Government Licence - The Corporation of the City of Windsor. For specifics, please reference: http://www.citywindsor.ca/opendata/Documents/OpenDataTermsofUse.pdf", + "Contains information licensed under the Open Government Licence – City of Regina. For specifics, please reference: https://www.regina.ca/residents/open-government/open-government-licence/", + "Contains information licensed under the Open Government License - British Columbia. Contains information licensed under the Open Government License - City of Surrey. Contains public sector datasets made available under the City of Brandon's Open Data License. For specifics, please reference: http://opengov.brandon.ca/terms.aspx", + "Contains information licensed under the Open Government License - Winnipeg. For specifics, please reference: https://data.winnipeg.ca/open-data-licence", + "Contains information licensed under the GeoNB Open Data Licence. For specifics, please reference: http://geonb.snb.ca/documents/license/geonb-odl_en.pdf", + "Contains information licensed under the Open Government Licence - The Corporation of the Municipality of Chatham-Kent. Contains information licensed under the Open Government Licence - Niagara Region. For specifics, please referec: https://niagaraopendata.ca/pages/open-government-license-2-0-niagara-region", + "Contains information licensed under the Open Government Licence - City of Welland. Contains information licensed under the Open Government Licence - Prince Edward Island. For specifics, please reference: https://www.princeedwardisland.ca/en/information/finance/open-government-licence-prince-edward-island", + "Contains information licensed under the Open Government License - Kamloops. For specifics, please reference: http://www.kamloops.ca/maps/disclaimer.html", + "Contains information licensed under the Open Government License - Nanaimo. For specifics, please reference: http://www.nanaimo.ca/EN/main/departments/information-technology/DataCatalogue/Licence.html Contains information licensed under the Open Government License – City of New Westminster. For specifics, please reference: http://opendata.newwestcity.ca/licence", + "Contains information licensed under the Open Government License – City of Prince George. For specifics, please reference: http://pgmap.princegeorge.ca/opendata/CityofPrinceGeorge_Open_Government_License_Open_Data.pdf", + "Contains Information licensed under the Open Government Licence – Brantford. For specifics, please reference: http://www.brantford.ca/govt/projects/opendata/Pages/OpenDataLicence.aspx", + "Contains data for Gatineau, QC made available through Creative Commons Attribution 4.0 International. For specifics, please reference: https://creativecommons.org/licenses/by/4.0/legalcode", + "Contains data for Laval, QC made available through Creative Commons Attribution 4.0 International. For specifics, please reference: https://creativecommons.org/licenses/by/4.0/legalcode", + "Contains data for Longueuil, QC made available through Creative Commons Attribution 4.0 International. For specifics, please reference: https://creativecommons.org/licenses/by/4.0/legalcode", + "Contains data for Montreal, QC made available through Creative Commons Attribution 4.0 International. For specifics, please reference: https://creativecommons.org/licenses/by/4.0/legalcode", + "Contains data for Rimouski, QC made available through Creative Commons Attribution 4.0 International. For specifics, please reference: https://creativecommons.org/licenses/by/4.0/legalcode" + ], + "country": { + "ISO3": "CAN", + "label": "Canada" + } + }, + { + "copyrights": [ + "© Swisstopo" + ], + "country": { + "ISO3": "CHE", + "label": "Switzerland" + } + }, + { + "copyrights": [ + "GeoBasis-DE/Geobasis NRW 2017" + ], + "country": { + "ISO3": "DEU", + "label": "Germany" + } + }, + { + "copyrights": [ + "© DAV, violation of these copyrights shall cause legal proceedings" + ], + "country": { + "ISO3": "DNK", + "label": "Denmark" + } + }, + { + "copyrights": [ + "© 2013-2018 TomTom-Nomago" + ], + "country": { + "ISO3": "DZA", + "label": "Algeria" + } + }, + { + "copyrights": [ + "This product contains cartographic information (geometry, street names, traffic flow) made available by Ajuntament de Lleida under legal terms available here: http://www.paeria.es/cas/avisLegal.asp", + "This product contains cartographic information (geometry, street names, traffic flow) made available by Ayuntamiento de Logroño under legal terms available here: http://web.logro-o.org/giswebpgm/ayuda/condicionesuso.html", + "This product contains address point data made available under the Gobierno de Navarra and offered under Creative Commons- Attribution (CC-by 3.0) license in: http://idena.navarra.es/busquedas/catalog/descargas/descargas.page", + "This product contains address point data made available by la Comunidad de Madrid with the product NomeCalles offered by El Instituto de Estadística de la Comunidad de Madrid in: http://www.madrid.org/nomecalles/DescargaBDTCorte.icm", + "This product contains address point data made available by la Dirección General del Catastro del Ministerio de Economía y Hacienda in: https://www.sedecatastro.gob.es/OVCFrames.aspx?TIPO=TIT&a=masiv", + "This product contains cartographic information (geometry, street names, traffic flow, address points) made available by Ajuntament de El Prat de Llobregat under legal terms available here: http://www.elprat.cat/plantilles/pr_re_mactfill_1c_imfl/_uGU6aDOKh21PMmm2WqoT4ZOhxsiMHAS0S7PZC2PCFqo", + "This product contains cartographic information (geometry, street names, traffic flow, address points) made available by Ayuntamiento de Valencia under legal terms available here: http://www.valencia.es/ayuntamiento/DatosAbiertos.nsf/vDocumentosTituloAux/Condiciones%20de%20uso?opendocument&lang=1&nivel=5&seccion=1", + "This product contains cartographic information (geometry, street names, traffic flow, address points) made available by Ajuntament de Sant Feu de Llobregat under legal terms available here: https://www.santfeliu.cat/common/misc/widget_container.faces?xmid=11796", + "This product contains cartographic information (geometry, street names, traffic flow) made available by Ayuntamiento de Vitoria-Gasteiz under Creative Commons Reconocimiento 3.0 España available here: TT#0041606-16 http://creativecommons.org/licenses/by/3.0/es/legalcode.es" + ], + "country": { + "ISO3": "ESP", + "label": "Spain" + } + }, + { + "copyrights": [ + "(navigation devices only) Michelin data © Michelin 2017 The following copyright applies to the Advanced Navigable MAP, Address Points, 2D City Map and Buildings: Source: Direction générale des Finances Publiques – Cadastre; Updated 2017" + ], + "country": { + "ISO3": "FRA", + "label": "France" + } + }, + { + "copyrights": [ + "Ordnance Survey of Northern Ireland", + "Contains Ordnance Survey data © Crown copyright and database right 2017", + "Code-Point® Open data; Contains Royal Mail data © Royal Mail copyright and database right 2017 Contains National Statistics data © Crown copyright and database right 2017" + ], + "country": { + "ISO3": "GBR", + "label": "United Kingdom" + } + }, + { + "copyrights": [ + "© Base data Bakosurtanal" + ], + "country": { + "ISO3": "IDN", + "label": "Indonesia" + } + }, + { + "copyrights": [ + "This product contains cartographic information (street names, address points) made available by the Regione Lombardia and offered under Italian Open Data License (IODL 2.0) http://www.dati.gov.it/iodl/2.0/) available at the following address: http://www.geoportale.regione.lombardia.it/en/i.i.t.-della-lombardia", + "This product contains cartographic information from Comune di Milano 1)– Servizio Sit e Statistica made available at https://geoportale.comune.milano.it/sit/open-data/ under license Creative Commons Attribution (CC BY 2,5) 2) Web portal available at https://www.comune.milano.it/wps/portal/ist/it/vivicitta/verde/parchi Under license Creative Commons Attribution (CC BY 3.0) (http://www.comune.milano.it/wps/portal/ist/it/extra/others/footer/legal)", + "This product contains cartographic information (street names, address points) made available by Regione Emilia Romagna and offered under Creative Commons Attribution (CC BY 2.5) available at following address http://geoportale.regione.emilia-romagna.it/it/catalogo/dati-cartografici/cartografia-di-base/database-topografico-regionale/gestione-viabilita-indirizzi/toponimi-e-numeri-civici This product contains cartographic information (street names, address points) made available by Comune di Torino and offered under Italian Open Data License (IODL 2.0) available at following address http://aperto.comune.torino.it/?q=node/504", + "This product contains cartographic information (street names, address points) made available by Regione Veneto and offered offered under Italian Open Data License (IODL 2.0) available at following address http://dati.veneto.it/dataset", + "This product contains cartographic information (street names, address points) made available by Regione Toscana and offered offered under under Creative Commons Attribution (CC BY 2.5), according to the legislation available at http://www.regione.toscana.it/documents/10180/492172/Decreto-2014_02_25n663.pdf/162db905-95fd-4b5e-bc41-88a629b5a3e5 and Regolamento http://raccoltanormativa.consiglio.regione.toscana.it/articolo?urndoc=urn:nir:regione.toscana:regolamento.giunta:2007-02-09;6/R&pr=idx,0;artic,1;articparziale,0, data available at following address http://dati.toscana.it/dataset/grafo-civici", + "This product contains cartographic information (area info) made available by Comune di Roma at http://dati.comune.roma.it/cms/it/dettaglio_ambiente.page?contentId=DTS5931 under license Creative Commons Attribution (CC BY 4.0)", + "This product contains data (house numbers, geographical and statistical info on administrative areas) made available under the Istituto Nazionale di Statistica and offered under Creative Commons- Attribution (CC-by 3.0) license in: http://www.istat.it/it/archivio/678 and http://datiopen.istat.it/", + "This product contains address point data made available under the Comune di Verona in: http://www.comune.verona.it/nqcontent.cfm?a_id=37426", + "This product contains address point data made available under the Comune di Vicenza in: http://www.comune.vicenza.it/servizi/opendata.php/76184", + "This product contains address point data from Comune di Milano – Servizio Sit e Statistica This product contains address point data made available under the Provincia di Biella in: http://cartografia.provincia.biella.it/on-line/Home/Repertorio/Consultazione/articolo3000217.html", + "This product contains address point data made available by Comune di Torino and offered under Italian Open Data License (IODL 2.0) available at following address http://aperto.comune.torino.it/?q=node/504", + "This product contains address point data made available under the Comune di Firenze and offered under Creative Commons- Attribution (CC-by 3.0) license in: http://opendata.comune.fi.it/statistica_territorio/dataset_0040.html", + "This product contains address point data made available by Regione Emilia Romagna and offered under Creative Commons Attribution (CC BY 2.5) available at following address http://geoportale.regione.emilia-romagna.it/it/catalogo/dati-cartografici/cartografia-di-base/database-topografico-regionale/gestione-viabilita-indirizzi/toponimi-e-numeri-civici", + "This product contains address point data made available by Regione Toscana and offered under Creative Commons Attribution (CC BY 2.5), according to the legislation available at http://www.regione.toscana.it/documents/10180/492172/Decreto-2014_02_25n663.pdf/162db905-95fd-4b5e-bc41-88a629b5a3e5 and Regolamento http://raccoltanormativa.consiglio.regione.toscana.it/articolo?urndoc=urn:nir:regione.toscana:regolamento.giunta:2007-02-09;6/R&pr=idx,0;artic,1;articparziale,0, data available at following address http://dati.toscana.it/dataset/grafo-civici", + "This product contains address point data made available by Regione Veneto and offered offered under Italian Open Data License (IODL 2.0) available at following address http://dati.veneto.it/dataset", + "This product contains address point data made available by Regione Autonoma Friuli Venezia Giulia and offered under ITALIA OPEN DATA LICENSE V2.0 (IODL 2.0). Data are available at following address : http://www.regione.fvg.it/rafvg/cms/RAFVG/ambiente-territorio/conoscere-ambiente-territorio/", + "This product contains address point data made available by Regione Umbria and offered under CCBY License. Data are available at following address : http://www.umbriageo.regione.umbria.it/pagine/servizi-wms-attivi?permalink=servizi-wms-attivi&permalink=servizi-wms-attivi This product contains address point data made available by Regione Lombardia and offered under Italian Open Data License (IODL 2.0 http://www.dati.gov.it/iodl/2.0/) available at the following address: http://www.geoportale.regione.lombardia.it/en/i.i.t.-della-lombardia" + ], + "country": { + "ISO3": "ITA", + "label": "Italy" + } + }, + { + "copyrights": [ + "© Royal Jordanian Geographic center" + ], + "country": { + "ISO3": "JOR", + "label": "Jordan" + } + }, + { + "copyrights": [ + "© Shobunsha Publications, Inc. © Shobunsha" + ], + "country": { + "ISO3": "JPN", + "label": "Japan" + } + }, + { + "copyrights": [ + "Based upon electronic data © Mappers Co., Ltd. All rights reserved" + ], + "country": { + "ISO3": "KOR", + "label": "Republic of Korea" + } + }, + { + "copyrights": [ + "© FICHIER DE BASE DES ADRESSES GEOCODEES : ADM. DU CADASTRE ET DE LA TOPOGRAPHIE (2017) [© File taken from the database of geocoded addresses: Land Registry and Topography Administration (2017)]" + ], + "country": { + "ISO3": "LUX", + "label": "Luxembourg" + } + }, + { + "copyrights": [ + "Macao Special Administrative Region Government – Cartography and Cadastre Bureau", + "This product contains Road Geometry data made available by Macao Special Administrative Region Government – Cartography and Cadastre Bureau: http://www.dscc.gov.mo/ENG/copyright.html" + ], + "country": { + "ISO3": "MAC", + "label": "Macao" + } + }, + { + "copyrights": [ + "The following copyright notice applies to the use of TomTom Traffic: Portions of the data have been provided by Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. © 2017. Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. All rights reserved." + ], + "country": { + "ISO3": "MEX", + "label": "Mexico" + } + }, + { + "copyrights": [ + "This product includes data from Mapping Unit, Malta Environment and Planning Authority and licensed on behalf of them or © Mapping Unit, Malta Environment and Planning Authority" + ], + "country": { + "ISO3": "MLT", + "label": "Malta" + } + }, + { + "copyrights": [ + "Topografische onderground Copyright © dienst voor het kadaster en de openbare registers, Apeldoorn 2017" + ], + "country": { + "ISO3": "NLD", + "label": "Netherlands" + } + }, + { + "copyrights": [ + "Contains data under the Norwegian licence for Open Government data (NLOD) distributed by Statens Vegvesen" + ], + "country": { + "ISO3": "NOR", + "label": "Norway" + } + }, + { + "copyrights": [ + "This product contains cartographic information (geometry, street names) made available by LINZ and sourced from the LINZ Data Service and licensed under the Creative Commons Attribution 3.0 New Zealand license", + "This product contains cartographic information (geometry) made with the help of Aerial Imagery made available by LINZ and sourced from the LINZ Data Service and licensed by various government agencies for re-use under the Creative Commons Attribution 3.0 New Zealand license", + "This product contains cartographic information (crash data) made available by New Zealand Transport Agency licensed under CC-BY 3.0 NZL. Further information here: http://www.nzta.govt.nz/resources/grouped-crash-sites", + "This product contains cartographic information (geometry, lane information, street names) made available by New Zealand Transport Agency on agreement on a case by case basis. Further information here: https://www.nzta.govt.nz/about-us/about-this-site#privacy https://www.nzta.govt.nz/projects/", + "This product contains address point data made available in the New Zealand Address Dataset which is sourced from New Zealand Post and Land Information New Zealand (LINZ). New Zealand Post copyright reserved. Data sourced from LINZ Data Service is subject to Creative Commons Attribution 3.0 New Zealand license" + ], + "country": { + "ISO3": "NZL", + "label": "New Zealand" + } + }, + { + "copyrights": [ + "This product contains postal code data of Poşta Română made available under Open Government License: http://data.gov.ro/base/images/logoinst/OGL-ROU-1.0.pdf http://data.gov.ro/dataset/coduri-postale-romania" + ], + "country": { + "ISO3": "ROU", + "label": "Romania" + } + }, + { + "copyrights": [ + "© ROSREESTR" + ], + "country": { + "ISO3": "RUS", + "label": "Russian Federation" + } + }, + { + "copyrights": [ + "The following copyright notice applies to the use of Points of Interest: © 2006 – 2018 TomTom. All rights reserved. Portions of the POI database contained in Points of Interest North America have been provided by Neustar Localeze", + "The following copyright notice applies to the use of Telecommunications: © 2017 Pitney Bowes. All rights reserved. In addition, for the following product layers Wire Center Boundaries, ILEC Boundaries, and Rate Center Boundaries, the following also applies: This product contains information and/or data of Telcordia Technologies, Inc. (Telcordia) licensed to be included herein.", + "The following copyright notice applies to the use of TomTom Traffic: Portions of the data have been provided by Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. © 2017. Total Traffic & Weather Network, a division of iHeartMedia + Entertainment, Inc. All rights reserved.", + "© United States Postal Service 2017", + "Contains data made available by the Rhode Island Geographic Information System (RIGIS) consortium, the State of Rhode Island, and the University of Rhode Island. For specifics, please reference: http://www.rigis.org/information", + "Contains Address Points data made available by State of Maryland and MD iMAP. For specifics, please reference: http://imap.maryland.gov." + ], + "country": { + "ISO3": "USA", + "label": "United States" + } + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetCopyrightFromBoundingBox.json b/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetCopyrightFromBoundingBox.json new file mode 100644 index 000000000000..0f73246575f9 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetCopyrightFromBoundingBox.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "mincoordinates": "52.41064,4.84228", + "maxcoordinates": "52.41072,4.84239", + "text": "yes", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "formatVersion": "0.0.1", + "generalCopyrights": [ + "© 1992 – 2016 TomTom. All rights reserved. This material is proprietary and the subject of copyright protection, database right protection and other intellectual property rights owned by TomTom or its suppliers. The use of this material is subject to the terms of a license agreement. Any unauthorized copying or disclosure of this material will lead to criminal and civil liabilities.", + "Data Source © 2016 TomTom", + "based on" + ], + "regions": [ + { + "copyrights": [ + "Topografische onderground Copyright © dienst voor het kadaster en de openbare registers, Apeldoorn 2016." + ], + "country": { + "ISO3": "NLD", + "label": "Netherlands" + } + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetMapImage.json b/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetMapImage.json new file mode 100644 index 000000000000..b316545d0ef1 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetMapImage.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "png", + "zoom": 2, + "bbox": "1.355233,42.982261,24.980233,56.526017", + "layer": "basic", + "style": "main", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "headers": {}, + "body": "binary string image" + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetMapImageryTile.json b/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetMapImageryTile.json new file mode 100644 index 000000000000..e3f6cda8376f --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetMapImageryTile.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "png", + "style": "satellite", + "zoom": 6, + "x": 10, + "y": 22, + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "headers": {}, + "body": "binary string image" + }, + "400": { + "headers": {}, + "body": { + "statuscode": "400", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + }, + "401": { + "headers": {}, + "body": { + "statuscode": "401", + "message": "Unauthorized: Access is denied due to invalid credentials." + } + }, + "403": { + "headers": {}, + "body": { + "statuscode": "403", + "message": "Permission, capacity, or authentication issues." + } + }, + "404": { + "headers": {}, + "body": { + "statuscode": "404", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + }, + "500": { + "headers": {}, + "body": { + "statuscode": "500", + "message": "An error occurred while processing the request. Please try again later." + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetMapStateTile.json b/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetMapStateTile.json new file mode 100644 index 000000000000..997c25929649 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetMapStateTile.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "1.0", + "statesetId": "[statesetId]", + "zoom": 6, + "x": 10, + "y": 22, + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/vnd.mapbox-vector-tile" + }, + "body": "state tile vector graphic content" + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetMapTile.json b/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetMapTile.json new file mode 100644 index 000000000000..b24399f4e996 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/examples/GetMapTile.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "png", + "layer": "basic", + "style": "main", + "zoom": 6, + "x": 10, + "y": 22, + "tilesize": 512, + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "headers": {}, + "body": "binary string image" + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/render.json b/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/render.json new file mode 100644 index 000000000000..91719c1102f1 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/render.json @@ -0,0 +1,1177 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Render Service", + "version": "1.0", + "description": "Azure Maps Render REST APIs" + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json", + "application/xml" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "user_impersonation": "Impersonates a user's Azure Active Directory account." + } + }, + "apiKeyQuery": { + "type": "apiKey", + "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + } + }, + "security": [ + { + "azure_auth": [] + }, + { + "apiKeyQuery": [] + } + ], + "responses": { + "400": { + "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "401": { + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + }, + "headers": { + "WWW-Authenticate": { + "type": "string", + "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" + } + } + }, + "403": { + "description": "Permission, capacity, or authentication issues.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "404": { + "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "500": { + "description": "An error occurred while processing the request. Please try again later.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + } + }, + "parameters": { + "ClientId": { + "name": "x-ms-client-id", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "client" + }, + "SubscriptionKey": { + "name": "subscription-key", + "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API. Current version is 1.0", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "RasterTileFormat": { + "name": "format", + "description": "Desired format of the response. Possible value: png.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "png" + ], + "x-ms-enum": { + "name": "RasterTileFormat", + "modelAsString": false, + "values": [ + { + "value": "png", + "description": "An image in the png format. Supports zoom levels 0 through 18." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "Language": { + "name": "language", + "in": "query", + "description": "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "TileFormat": { + "name": "format", + "description": "Desired format of the response. Possible values are png & pbf.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "png", + "pbf" + ], + "x-ms-enum": { + "name": "TileFormat", + "modelAsString": false, + "values": [ + { + "value": "png", + "description": "An image in the png format. Supports zoom levels 0 through 18." + }, + { + "value": "pbf", + "description": "Vector graphic in the pbf format. Supports zoom levels 0 through 22." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "xTileIndex": { + "name": "x", + "x-ms-client-name": "xTileIndex", + "in": "query", + "description": "X coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1].\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "x-ms-parameter-location": "method" + }, + "yTileIndex": { + "name": "y", + "x-ms-client-name": "yTileIndex", + "in": "query", + "description": "Y coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1].\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "x-ms-parameter-location": "method" + }, + "TextFormat": { + "name": "format", + "description": "Desired format of the response. Value can be either _json_ or _xml_.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "json", + "xml" + ], + "x-ms-enum": { + "name": "TextFormat", + "modelAsString": false, + "values": [ + { + "value": "json", + "description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)" + }, + { + "value": "xml", + "description": "[The Extensible Markup Language](https://www.w3.org/TR/xml/)" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "RasterZoom18": { + "name": "zoom", + "in": "query", + "description": "Zoom level for the desired tile. Zoom value must be in the range: 0-18 (inclusive).\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "x-ms-parameter-location": "method" + }, + "VectorZoom": { + "name": "zoom", + "in": "query", + "description": "Zoom level for the desired tile. Zoom value must be in the range: 0-20 (inclusive).\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "x-ms-parameter-location": "method" + }, + "ImageryRasterZoom": { + "name": "zoom", + "in": "query", + "description": "Zoom level for the desired tile. Zoom value must be in the range: 1-19 (inclusive).\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "x-ms-parameter-location": "method" + }, + "RasterVectorNaturalEarthZoom": { + "name": "zoom", + "in": "query", + "description": "Zoom level for the desired tile. For _raster_ tiles, value must be in the range: 0-18 (inclusive). Terra raster tiles, values must be in the range 0-6 (inclusive). For _vector_ tiles, value must be in the range: 0-22 (inclusive).\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "x-ms-parameter-location": "method" + }, + "Text": { + "name": "text", + "in": "query", + "description": "Yes/no value to exclude textual data from response. Only images and country names will be in response.", + "required": false, + "type": "string", + "enum": [ + "yes", + "no" + ], + "default": "yes", + "x-ms-parameter-location": "method" + }, + "View": { + "name": "view", + "in": "query", + "description": "The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/map/static/{format}": { + "get": { + "x-publish": true, + "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nThe static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The static image service renders a user-defined, rectangular image containing a map section using a zoom level from 0 to 20. The supported resolution range for the map image is from 1x1 to 8192x8192. If you are deciding when to use the static image service over the map tile service, you may want to consider how you would like to interact with the rendered map. If the map contents will be relatively unchanging, a static map is a good choice. If you want to support a lot of zooming, panning and changing of the map content, the map tile service would be a better choice. \n\nService also provides Image Composition functionality to get a static image back with additional data like; pushpins and geometry overlays with following S0 and S1 capabilities. \n\nIn S0 you can:\n- Render up to 5 pushpins specified in the request\n- Provide one custom image for the pins referenced in the request\n- Add labels to the pushpins\n\nIn S1 you can:\n- Render pushpins through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n- Specify multiple pushpin styles\n- Provide custom pushpin images stored in [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n- Render circle, polyline and polygon geometry types.\n- Render of supported GeoJSON geometry types uploaded through [Azure Maps Data Service](https://aka.ms/AzureMapsMapDataService)\n\nPlease see [How-to-Guide](https://aka.ms/AzureMapsHowToGuideImageCompositor) for detailed examples.\n\n_Note_ : Either **center** or **bbox** parameter must be supplied to the\nAPI.\n

\nThe supported Lat and Lon ranges when using the **bbox** parameter, are as follows:\n

\n\n |Zoom Level | Max Lon Range | Max Lat Range|\n |:----------|:----------------|:-------------|\n |0 | 360.0 | 170.0 | \n |1 | 360.0 | 170.0 |\n |2 | 360.0 | 170.0 |\n |3 | 360.0 | 170.0 |\n |4 | 360.0 | 170.0 |\n |5 | 180.0 | 85.0 |\n |6 | 90.0 | 42.5 |\n |7 | 45.0 | 21.25 |\n |8 | 22.5 | 10.625 |\n |9 | 11.25 | 5.3125 |\n |10 | 5.625 | 2.62625 |\n |11 | 2.8125 | 1.328125 |\n |12 | 1.40625 | 0.6640625 |\n |13 | 0.703125 | 0.33203125 |\n |14 | 0.3515625 | 0.166015625 |\n |15 | 0.17578125 | 0.0830078125 | \n |16 | 0.087890625 | 0.0415039063 | \n |17 | 0.0439453125 | 0.0207519531 |\n |18 | 0.0219726563 | 0.0103759766 |\n |19 | 0.0109863281 | 0.0051879883 |\n |20 | 0.0054931641 | 0.0025939941 |", + "operationId": "Render_GetMapImage", + "x-ms-examples": { + "GetMapStaticImage": { + "$ref": "./examples/GetMapImage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/RasterTileFormat" + }, + { + "name": "layer", + "in": "query", + "description": "Map layer requested. If layer is set to labels or hybrid, the format should be png.", + "required": false, + "default": "basic", + "type": "string", + "enum": [ + "basic", + "hybrid", + "labels" + ], + "x-ms-enum": { + "name": "StaticMapLayer", + "modelAsString": false, + "values": [ + { + "value": "basic", + "description": "Returns an image containing all map features including polygons, borders, roads and labels." + }, + { + "value": "hybrid", + "description": "Returns an image containing borders, roads, and labels, and can be overlaid on other tiles (such as satellite imagery) to produce hybrid tiles." + }, + { + "value": "labels", + "description": "Returns an image of just the map's label information." + } + ] + } + }, + { + "name": "style", + "in": "query", + "description": "Map style to be returned. Possible values are main and dark.", + "required": false, + "default": "main", + "type": "string", + "enum": [ + "main", + "dark" + ], + "x-ms-enum": { + "name": "MapImageStyle", + "modelAsString": false, + "values": [ + { + "value": "main", + "description": "Azure Maps main style" + }, + { + "value": "dark", + "description": "Dark grey version of the Azure Maps main style" + } + ] + } + }, + { + "name": "zoom", + "in": "query", + "description": "Desired zoom level of the map. Zoom value must be in the range: 0-20 (inclusive). Default value is 12.

Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": false, + "default": 12, + "type": "integer", + "minimum": 0, + "maximum": 20 + }, + { + "name": "center", + "in": "query", + "description": "Coordinates of the center point. Format: 'lon,lat'. Projection used\n- EPSG:3857. Longitude range: -180 to 180. Latitude range: -85 to 85. \n\nNote: Either center or bbox are required parameters. They are\nmutually exclusive.", + "required": false, + "type": "string" + }, + { + "name": "bbox", + "in": "query", + "description": "Bounding box. Projection used - EPSG:3857. Format : 'minLon, minLat,\nmaxLon, maxLat'. \n\nNote: Either bbox or center are required\nparameters. They are mutually exclusive. It shouldn’t be used with\nheight or width.\n\nThe maximum allowed ranges for Lat and Lon are defined for each zoom level\nin the table at the top of this page.", + "required": false, + "type": "string" + }, + { + "name": "height", + "in": "query", + "description": "Height of the resulting image in pixels. Range is 1 to 8192. Default\nis 512. It shouldn’t be used with bbox.", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 8192, + "default": 512 + }, + { + "name": "width", + "in": "query", + "description": "Width of the resulting image in pixels. Range is 1 to 8192. Default is 512. It shouldn’t be used with bbox.", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 8192, + "default": 512 + }, + { + "$ref": "#/parameters/Language" + }, + { + "$ref": "#/parameters/View" + }, + { + "name": "pins", + "description": "Pushpin style and instances. Use this parameter to optionally add pushpins to the image.\nThe pushpin style describes the appearance of the pushpins, and the instances specify\nthe coordinates of the pushpins and optional labels for each pin. (Be sure to properly URL-encode values of this\nparameter since it will contain reserved characters such as pipes and punctuation.)\n\nThe Azure Maps account S0 SKU only supports a single instance of the pins parameter. Other SKUs\nallow multiple instances of the pins parameter to specify multiple pin styles.\n\nTo render a pushpin at latitude 45°N and longitude 122°W using the default built-in pushpin style, add the\nquerystring parameter \n\n`pins=default||-122 45` \n\nNote that the longitude comes before the latitude.\nAfter URL encoding this will look like\n\n`pins=default%7C%7C-122+45`\n\nAll of the examples here show the pins\nparameter without URL encoding, for clarity.\n\nTo render a pin at multiple locations, separate each location with a pipe character. For example, use\n\n`pins=default||-122 45|-119.5 43.2|-121.67 47.12`\n\nThe S0 Azure Maps account SKU only allows five pushpins. Other account SKUs do not have this limitation.\n\n### Style Modifiers\n\nYou can modify the appearance of the pins by adding style modifiers. These are added after the style but before\nthe locations and labels. Style modifiers each have a two-letter name. These abbreviated names are used to help\nreduce the length of the URL.\n\nTo change the color of the pushpin, use the 'co' style modifier and specify the color using the HTML/CSS RGB color\nformat which is a six-digit hexadecimal number (the three-digit form is not supported). For example, to use\na deep pink color which you would specify as #FF1493 in CSS, use\n\n`pins=default|coFF1493||-122 45`\n\n### Pushpin Labels\n\nTo add a label to the pins, put the label in single quotes just before the coordinates. For example, to label\nthree pins with the values '1', '2', and '3', use\n\n`pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12`\n\nThere is a built in pushpin style called 'none' that does not display a pushpin image. You can use this if\nyou want to display labels without any pin image. For example,\n\n`pins=none||'A'-122 45|'B'-119.5 43.2`\n\nTo change the color of the pushpin labels, use the 'lc' label color style modifier. For example, to use pink\npushpins with black labels, use\n\n`pins=default|coFF1493|lc000000||-122 45`\n\nTo change the size of the labels, use the 'ls' label size style modifier. The label size represents the approximate\nheight of the label text in pixels. For example, to increase the label size to 12, use\n\n`pins=default|ls12||'A'-122 45|'B'-119 43`\n\nThe labels are centered at the pushpin 'label anchor.' The anchor location is predefined for built-in pushpins and\nis at the top center of custom pushpins (see below). To override the label anchor, using the 'la' style modifier\nand provide X and Y pixel coordinates for the anchor. These coordinates are relative to the top left corner of the\npushpin image. Positive X values move the anchor to the right, and positive Y values move the anchor down. For example,\nto position the label anchor 10 pixels right and 4 pixels above the top left corner of the pushpin image,\nuse\n\n`pins=default|la10 -4||'A'-122 45|'B'-119 43`\n\n### Custom Pushpins\n\nTo use a custom pushpin image, use the word 'custom' as the pin style name, and then specify a URL after the\nlocation and label information. Use two pipe characters to indicate that you're done specifying locations and are\nstarting the URL. For example,\n\n`pins=custom||-122 45||http://contoso.com/pushpins/red.png`\n\nAfter URL encoding, this would look like\n\n`pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png`\n\nBy default, custom pushpin images are drawn centered at the pin coordinates. This usually isn't ideal as it obscures\nthe location that you're trying to highlight. To override the anchor location of the pin image, use the 'an'\nstyle modifier. This uses the same format as the 'la' label anchor style modifier. For example, if your custom\npin image has the tip of the pin at the top left corner of the image, you can set the anchor to that spot by\nusing\n\n`pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png`\n\nNote: If you use the 'co' color modifier with a custom pushpin image, the specified color will replace the RGB \nchannels of the pixels in the image but will leave the alpha (opacity) channel unchanged. This would usually\nonly be done with a solid-color custom image.\n\n### Getting Pushpins from Azure Maps Data Storage\n\nFor all Azure Maps account SKUs other than S0,\nthe pushpin image and location information can be obtained from Azure Maps Data Storage. After uploading a pushpin image\nor a GeoJSON document containing pin locations, the Data Storage service returns a Unique Data ID (UDID) that you can use\nto reference the data in the pins parameter.\n\nTo use a custom pushpin image from Azure Maps Data Storage, specify the UDID prefixed by 'udid-' as the name of the\npushpin style. For example,\n\n`pins=udid-fe22c504-3a81-4fcd-adc6-a3507ce866c1||-122 45`\n\nTo use the point geometry from an uploaded GeoJSON document as the pin locations, specify the UDID in the locations\nsection of the pins parameter. For example,\n\n`pins=default||udid-29dc105a-dee7-409f-a3f9-22b066ae4713`\n\nNote that\nonly point and multipoint geometry, points and multipoints from geometry collections, and point geometry from features\nwill be used. Linestring and polygon geometry will be ignored. If the point comes from a feature and the feature\nhas a string property called \"label\", the value of that property will be used as the label for the pin.\n\nYou can mix pin locations from Data Storage and pin locations specified in the pins parameter. Any of the pipe-delimited\npin locations can be a longitude and latitude or a UDID. For example,\n\n`pins=default||-122 45|udid-29dc105a-dee7-409f-a3f9-22b066ae4713|-119 43`\n\n### Scale, Rotation, and Opacity\n\nYou can make pushpins and their labels larger or smaller by using the 'sc' scale style modifier. This is a\nvalue greater than zero. A value of 1 is the standard scale. Values larger than 1 will make the pins larger, and\nvalues smaller than 1 will make them smaller. For example, to draw the pushpins 50% larger than normal, use\n\n`pins=default|sc1.5||-122 45`\n\nYou can rotate pushpins and their labels by using the 'ro' rotation style modifier. This is a number of degrees\nof clockwise rotation. Use a negative number to rotate counter-clockwise. For example, to rotate the pushpins\n90 degrees clockwise and double their size, use\n\n`pins=default|ro90|sc2||-122 45`\n\nYou can make pushpins and their labels partially transparent by specifying the 'al' alpha style modifier.\nThis is a number between 0 and 1 indicating the opacity of the pushpins. Zero makes them completely transparent\n(and not visible) and 1 makes them completely opaque (which is the default). For example, to make pushpins\nand their labels only 67% opaque, use\n\n`pins=default|al.67||-122 45`\n\n### Style Modifier Summary\n\nModifier | Description | Range \n:--------:|-----------------|------------------\nal | Alpha (opacity) | 0 to 1 \nan | Pin anchor | * \nco | Pin color | 000000 to FFFFFF \nla | Label anchor | * \nlc | Label color | 000000 to FFFFFF \nls | Label size | Greater than 0 \nro | Rotation | -360 to 360 \nsc | Scale | Greater than 0 \n\n* X and Y coordinates can be anywhere within pin image or a margin around it.\nThe margin size is the minimum of the pin width and height.", + "in": "query", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "x-publish": true + }, + { + "name": "path", + "description": "Path style and locations. Use this parameter to optionally add lines, polygons or circles to the image.\nThe path style describes the appearance of the line and fill. (Be sure to properly URL-encode values of this\nparameter since it will contain reserved characters such as pipes and punctuation.)\n\nPath parameter is supported in Azure Maps account SKU starting with S1. Multiple instances of the path parameter \nallow to specify multiple geometries with their styles. Number of parameters per request is limited to 10 and\nnumber of locations is limited to 100 per path.\n\nTo render a circle with radius 100 meters and center point at latitude 45°N and longitude 122°W using the default style, add the\nquerystring parameter \n\n`path=ra100||-122 45` \n\nNote that the longitude comes before the latitude.\nAfter URL encoding this will look like\n\n`path=ra100%7C%7C-122+45`\n\nAll of the examples here show the path parameter without URL encoding, for clarity.\n\nTo render a line, separate each location with a pipe character. For example, use\n\n`path=||-122 45|-119.5 43.2|-121.67 47.12`\n\nTo render a polygon, last location must be equal to the start location. For example, use\n\n`path=||-122 45|-119.5 43.2|-121.67 47.12|-122 45`\n\nLongitude and latitude values for locations of lines and polygons can be in the range from -360 to 360 to allow for rendering of geometries crossing the anti-meridian.\n\n### Style Modifiers\n\nYou can modify the appearance of the path by adding style modifiers. These are added before the locations. \nStyle modifiers each have a two-letter name. These abbreviated names are used to help reduce the length\nof the URL.\n\nTo change the color of the outline, use the 'lc' style modifier and specify the color using the HTML/CSS RGB color\nformat which is a six-digit hexadecimal number (the three-digit form is not supported). For example, to use\na deep pink color which you would specify as #FF1493 in CSS, use\n\n`path=lcFF1493||-122 45|-119.5 43.2`\n\nMultiple style modifiers may be combined together to create a more complex visual style.\n\n`lc0000FF|lw3|la0.60|fa0.50||-122.2 47.6|-122.2 47.7|-122.3 47.7|-122.3 47.6|-122.2 47.6`\n\n### Getting Path locations from Azure Maps Data Storage\n\nFor all Azure Maps account SKUs other than S0, the path location information can be obtained from Azure Maps Data Storage. \nAfter uploading a GeoJSON document containing path locations, the Data Storage service returns a Unique Data ID (UDID) that you can use\nto reference the data in the path parameter.\n\nTo use the point geometry from an uploaded GeoJSON document as the path locations, specify the UDID in the locations\nsection of the path parameter. For example,\n\n`path=||udid-29dc105a-dee7-409f-a3f9-22b066ae4713`\n\nNote the it is not allowed to mix path locations from Data Storage with locations specified in the path parameter. \n\n### Style Modifier Summary\n\nModifier | Description | Range \n:--------:|------------------------|------------------\nlc | Line color | 000000 to FFFFFF\nfc | Fill color | 000000 to FFFFFF\nla | Line alpha (opacity) | 0 to 1 \nfa | Fill alpha (opacity) | 0 to 1 \nlw | Line width | Greater than 0 \nra | Circle radius (meters) | Greater than 0", + "in": "query", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "x-publish": true + } + ], + "produces": [ + "application/json", + "image/jpeg", + "image/png" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MapStaticResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/map/tile/{format}": { + "get": { + "x-publish": true, + "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nFetches map tiles in vector or raster format typically to be integrated into a new map control or SDK. By default, Azure uses vector map tiles for its web map control (see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid))\n\n**Note**: Weather tiles are only available via [Get Map Tile V2 API](https://aka.ms/AzureMapsWeatherTiles). We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2).", + "operationId": "Render_GetMapTile", + "x-ms-examples": { + "GetMapTile": { + "$ref": "./examples/GetMapTile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TileFormat" + }, + { + "name": "layer", + "in": "query", + "description": "Map layer requested. Possible values are basic, hybrid, labels and terra.", + "required": true, + "enum": [ + "basic", + "hybrid", + "labels", + "terra" + ], + "type": "string", + "x-ms-enum": { + "name": "MapTileLayer", + "modelAsString": false, + "values": [ + { + "value": "basic", + "description": "Returns a tile containing all map features including polygons, borders, roads and labels." + }, + { + "value": "hybrid", + "description": "Returns a tile containing borders, roads, and labels, and can be overlaid on other tiles (such as satellite imagery) to produce hybrid tiles." + }, + { + "value": "labels", + "description": "Returns a tile of just the map's label information." + }, + { + "value": "terra", + "description": "Map canvas complete with shaded relief tiles. Zoom levels 0-6 (inclusive) are supported. Png is the only supported TileFormat and only available MapTileSize is 512." + } + ] + } + }, + { + "name": "style", + "in": "query", + "description": "Map style to be returned. Possible values are main, dark, and shaded_relief.", + "required": true, + "type": "string", + "enum": [ + "main", + "dark", + "shaded_relief" + ], + "x-ms-enum": { + "name": "MapTileStyle", + "modelAsString": false, + "values": [ + { + "value": "main", + "description": "Azure Maps main style" + }, + { + "value": "dark", + "description": "Dark grey version of the Azure Maps main style. PNG is the only supported TileFormat." + }, + { + "value": "shaded_relief", + "description": "Azure Maps main style completed with shaded relief. Supported by Layer terra." + } + ] + } + }, + { + "$ref": "#/parameters/RasterVectorNaturalEarthZoom" + }, + { + "$ref": "#/parameters/xTileIndex" + }, + { + "$ref": "#/parameters/yTileIndex" + }, + { + "name": "tileSize", + "in": "query", + "description": "The size of the returned map tile in pixels.", + "required": false, + "type": "string", + "default": "256", + "enum": [ + "256", + "512" + ], + "x-ms-enum": { + "name": "MapTileSize", + "modelAsString": false, + "values": [ + { + "value": "256", + "description": "Return a 256 by 256 pixel tile." + }, + { + "value": "512", + "description": "Return a 512 by 512 pixel tile." + } + ] + } + }, + { + "$ref": "#/parameters/Language" + }, + { + "$ref": "#/parameters/View" + } + ], + "produces": [ + "application/json", + "image/jpeg", + "image/png" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MapTileResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/map/statetile": { + "get": { + "x-publish": true, + "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nFetches state tiles in vector format typically to be integrated into indoor maps module of map control or SDK. The map control will call this API after user turns on dynamic styling (see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid))", + "operationId": "Render_GetMapStateTilePreview", + "x-ms-examples": { + "GetMapStateTile": { + "$ref": "./examples/GetMapStateTile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VectorZoom" + }, + { + "$ref": "#/parameters/xTileIndex" + }, + { + "$ref": "#/parameters/yTileIndex" + }, + { + "name": "statesetId", + "in": "query", + "description": "The stateset id.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + ], + "produces": [ + "application/vnd.mapbox-vector-tile", + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MapStateTileResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/map/copyright/caption/{format}": { + "get": { + "x-publish": true, + "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\n\nCopyrights API is designed to serve copyright information for Render Tile \nservice. In addition to basic copyright for the whole map, API is serving \nspecific groups of copyrights for some countries.\n\nAs an alternative to copyrights for map request, one can receive captions\nfor displaying the map provider information on the map.", + "operationId": "Render_GetCopyrightCaption", + "x-ms-examples": { + "GetCopyrightCaption": { + "$ref": "./examples/GetCopyrightCaption.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TextFormat" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CopyrightCaptionResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/map/imagery/{format}": { + "get": { + "x-publish": true, + "description": "**Applies to:** S1 pricing tier.\n\n\nThis service returns a map image tile with size 256x256, given the x and y coordinates and zoom\nlevel. Zoom level ranges from 1 to 19. The current available style value is 'satellite' which provides satellite\nimagery alone.\n\n\n**Note**: We recommend to start to use the new [Get Map Tile V2 API](https://aka.ms/GetMapTileV2).", + "operationId": "Render_GetMapImageryTile", + "x-ms-examples": { + "GetMapImagery": { + "$ref": "./examples/GetMapImageryTile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/RasterTileFormat" + }, + { + "name": "style", + "in": "query", + "description": "Map style to be returned. __Possible values:__ satellite.", + "required": true, + "type": "string", + "enum": [ + "satellite" + ], + "x-ms-enum": { + "name": "MapImageryStyle", + "modelAsString": false, + "values": [ + { + "value": "satellite", + "description": "Satellite imagery" + } + ] + } + }, + { + "$ref": "#/parameters/ImageryRasterZoom" + }, + { + "$ref": "#/parameters/xTileIndex" + }, + { + "$ref": "#/parameters/yTileIndex" + } + ], + "produces": [ + "application/json", + "image/jpeg", + "image/png" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MapImageryResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/map/copyright/bounding/{format}": { + "get": { + "x-publish": true, + "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nReturns copyright information for a given bounding box. Bounding-box requests should specify the minimum and maximum longitude and latitude (EPSG-3857) coordinates", + "operationId": "Render_GetCopyrightFromBoundingBox", + "x-ms-examples": { + "GetCopyrightBounding": { + "$ref": "./examples/GetCopyrightFromBoundingBox.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TextFormat" + }, + { + "name": "mincoordinates", + "in": "query", + "description": "Minimum coordinates of bounding box in latitude longitude coordinate system. E.g. 52.41064,4.84228", + "required": true, + "type": "string" + }, + { + "name": "maxcoordinates", + "in": "query", + "description": "Maximum coordinates of bounding box in latitude longitude coordinate system. E.g. 52.41064,4.84228", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/Text" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CopyrightBoundingResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/map/copyright/tile/{format}": { + "get": { + "x-publish": true, + "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries.\nReturns the copyright information for a given tile. To obtain the copyright information for a particular tile, the request should specify the tile's zoom level and x and y coordinates (see: Zoom Levels and Tile Grid).", + "operationId": "Render_GetCopyrightForTile", + "x-ms-examples": { + "GetCopyrightTile": { + "$ref": "./examples/GetCopyrightForTile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TextFormat" + }, + { + "$ref": "#/parameters/RasterZoom18" + }, + { + "$ref": "#/parameters/xTileIndex" + }, + { + "$ref": "#/parameters/yTileIndex" + }, + { + "$ref": "#/parameters/Text" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CopyrightTileResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/map/copyright/world/{format}": { + "get": { + "x-publish": true, + "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nCopyrights API is designed to serve copyright information for Render Tile service. In addition to basic copyright for the whole map, API is serving specific groups of copyrights for some countries.\nReturns the copyright information for the world. To obtain the default copyright information for the whole world, do not specify a tile or bounding box.", + "operationId": "Render_GetCopyrightForWorld", + "x-ms-examples": { + "GetCopyrightWorld": { + "$ref": "./examples/GetCopyrightForWorld.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TextFormat" + }, + { + "$ref": "#/parameters/Text" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CopyrightWorldResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + } + }, + "definitions": { + "ODataErrorResponse": { + "type": "object", + "description": "This response object is returned when an error occurs in the Maps API.", + "properties": { + "error": { + "$ref": "#/definitions/ODataError" + } + } + }, + "ODataError": { + "type": "object", + "description": "This object is returned when an error occurs in the Maps API.", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The ODataError code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + } + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the target causing the error." + } + } + }, + "CopyrightBoundingResult": { + "description": "This object is returned from a successful Copyright Bounding call", + "type": "object", + "properties": { + "formatVersion": { + "description": "Format Version property", + "type": "string", + "readOnly": true + }, + "generalCopyrights": { + "description": "General Copyrights array", + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "readOnly": true + } + }, + "regions": { + "description": "Regions array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Region" + } + } + } + }, + "Region": { + "type": "object", + "properties": { + "copyrights": { + "description": "Copyrights array", + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "readOnly": true + } + }, + "country": { + "description": "Country property", + "type": "object", + "readOnly": true, + "properties": { + "ISO3": { + "description": "ISO3 property", + "type": "string", + "readOnly": true + }, + "label": { + "description": "Label property", + "type": "string", + "readOnly": true + } + } + } + } + }, + "CopyrightCaptionResult": { + "description": "This object is returned from a successful Copyright Caption call", + "type": "object", + "properties": { + "formatVersion": { + "description": "Format Version property", + "type": "string", + "readOnly": true + }, + "copyrightsCaption": { + "description": "Copyrights Caption property", + "type": "string", + "readOnly": true + } + } + }, + "CopyrightWorldResult": { + "description": "This object is returned from a successful Copyright World call", + "type": "object", + "properties": { + "formatVersion": { + "description": "Format Version property", + "type": "string", + "readOnly": true + }, + "generalCopyrights": { + "description": "General Copyrights array", + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "readOnly": true + } + }, + "regions": { + "description": "Regions array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Region" + } + } + } + }, + "CopyrightTileResult": { + "description": "This object is returned from a successful Copyright Tile call", + "type": "object", + "properties": { + "formatVersion": { + "description": "Format Version property", + "type": "string", + "readOnly": true + }, + "generalCopyrights": { + "description": "General Copyrights array", + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "readOnly": true + } + }, + "regions": { + "description": "Regions array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Region" + } + } + } + }, + "MapStaticResult": { + "description": "This image is returned from a successful Map Static call", + "type": "object", + "format": "file", + "readOnly": true + }, + "MapTileResult": { + "description": "This image is returned from a successful Map Tile call", + "type": "object", + "format": "file", + "readOnly": true + }, + "MapStateTileResult": { + "description": "This tile is returned from a successful Map State Tile call", + "type": "object", + "format": "file", + "readOnly": true + }, + "MapImageryResult": { + "description": "This image is returned from a successful Map Imagery call", + "type": "object", + "format": "file", + "readOnly": true + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/examples/GetRouteDirections.json b/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/examples/GetRouteDirections.json new file mode 100644 index 000000000000..a5937068ffe5 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/examples/GetRouteDirections.json @@ -0,0 +1,156 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "query": "52.50931,13.42936:52.50274,13.43872", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "formatVersion": "0.0.12", + "routes": [ + { + "summary": { + "lengthInMeters": 1147, + "travelTimeInSeconds": 162, + "trafficDelayInSeconds": 0, + "departureTime": "2017-09-07T16:56:58+00:00", + "arrivalTime": "2017-09-07T16:59:40+00:00" + }, + "legs": [ + { + "summary": { + "lengthInMeters": 1147, + "travelTimeInSeconds": 162, + "trafficDelayInSeconds": 0, + "departureTime": "2017-09-07T16:56:58+00:00", + "arrivalTime": "2017-09-07T16:59:40+00:00" + }, + "points": [ + { + "latitude": 52.50931, + "longitude": 13.42937 + }, + { + "latitude": 52.50904, + "longitude": 13.42912 + }, + { + "latitude": 52.50894, + "longitude": 13.42904 + }, + { + "latitude": 52.50867, + "longitude": 13.42879 + }, + { + "latitude": 52.5084, + "longitude": 13.42857 + }, + { + "latitude": 52.50791, + "longitude": 13.42824 + }, + { + "latitude": 52.50757, + "longitude": 13.42772 + }, + { + "latitude": 52.50735, + "longitude": 13.42823 + }, + { + "latitude": 52.5073, + "longitude": 13.42836 + }, + { + "latitude": 52.50573, + "longitude": 13.43194 + }, + { + "latitude": 52.50512, + "longitude": 13.43336 + }, + { + "latitude": 52.50464, + "longitude": 13.43451 + }, + { + "latitude": 52.5045, + "longitude": 13.43481 + }, + { + "latitude": 52.50443, + "longitude": 13.43498 + }, + { + "latitude": 52.50343, + "longitude": 13.43737 + }, + { + "latitude": 52.50274, + "longitude": 13.43872 + } + ] + } + ], + "sections": [ + { + "startPointIndex": 0, + "endPointIndex": 15, + "sectionType": "TRAVEL_MODE", + "travelMode": "car" + } + ] + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/examples/GetRouteRange.json b/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/examples/GetRouteRange.json new file mode 100644 index 000000000000..a013418cbf93 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/examples/GetRouteRange.json @@ -0,0 +1,269 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "query": "50.97452,5.86605", + "subscription-key": "[subscription-key]", + "timeBudgetInSec": 6000 + }, + "responses": { + "200": { + "body": { + "formatVersion": "0.0.1", + "reachableRange": { + "center": { + "latitude": 50.9745, + "longitude": 5.86605 + }, + "boundary": [ + { + "latitude": 52.03704, + "longitude": 5.73602 + }, + { + "latitude": 52.09456, + "longitude": 5.59435 + }, + { + "latitude": 52.16815, + "longitude": 5.42279 + }, + { + "latitude": 52.25047, + "longitude": 5.21276 + }, + { + "latitude": 52.21374, + "longitude": 5.15355 + }, + { + "latitude": 52.25674, + "longitude": 4.96687 + }, + { + "latitude": 52.07834, + "longitude": 4.739 + }, + { + "latitude": 52.05647, + "longitude": 4.72513 + }, + { + "latitude": 51.94553, + "longitude": 4.53237 + }, + { + "latitude": 51.70119, + "longitude": 4.31165 + }, + { + "latitude": 51.5837, + "longitude": 4.28917 + }, + { + "latitude": 51.48463, + "longitude": 3.82685 + }, + { + "latitude": 51.21096, + "longitude": 3.62838 + }, + { + "latitude": 50.681399999999996, + "longitude": 3.89244 + }, + { + "latitude": 50.66791, + "longitude": 3.93493 + }, + { + "latitude": 50.49042, + "longitude": 3.98156 + }, + { + "latitude": 50.30944, + "longitude": 4.47995 + }, + { + "latitude": 50.24448, + "longitude": 4.60502 + }, + { + "latitude": 50.24467, + "longitude": 4.89999 + }, + { + "latitude": 50.08735, + "longitude": 5.04206 + }, + { + "latitude": 49.99214, + "longitude": 5.23042 + }, + { + "latitude": 49.88478, + "longitude": 5.40994 + }, + { + "latitude": 49.85797, + "longitude": 5.46178 + }, + { + "latitude": 49.86279, + "longitude": 5.7196 + }, + { + "latitude": 49.83259, + "longitude": 5.74151 + }, + { + "latitude": 50.22239, + "longitude": 5.9387 + }, + { + "latitude": 50.0011, + "longitude": 6.08535 + }, + { + "latitude": 50.04616, + "longitude": 6.12089 + }, + { + "latitude": 50.09472, + "longitude": 6.28373 + }, + { + "latitude": 49.95863, + "longitude": 6.51654 + }, + { + "latitude": 50.00485, + "longitude": 6.61034 + }, + { + "latitude": 50.00587, + "longitude": 6.70295 + }, + { + "latitude": 50.2947, + "longitude": 6.65865 + }, + { + "latitude": 50.36903, + "longitude": 6.79276 + }, + { + "latitude": 50.31614, + "longitude": 7.32163 + }, + { + "latitude": 50.36737, + "longitude": 7.58782 + }, + { + "latitude": 50.46919, + "longitude": 7.7626 + }, + { + "latitude": 50.96246, + "longitude": 7.9826 + }, + { + "latitude": 51.07086, + "longitude": 7.55924 + }, + { + "latitude": 51.36614, + "longitude": 7.58138 + }, + { + "latitude": 51.52015, + "longitude": 7.67861 + }, + { + "latitude": 51.65781, + "longitude": 7.35175 + }, + { + "latitude": 51.81916, + "longitude": 7.21664 + }, + { + "latitude": 51.9587, + "longitude": 7.0467 + }, + { + "latitude": 51.82713, + "longitude": 6.67267 + }, + { + "latitude": 51.81133, + "longitude": 6.48424 + }, + { + "latitude": 51.9368, + "longitude": 6.27316 + }, + { + "latitude": 52.01701, + "longitude": 6.14452 + }, + { + "latitude": 52.20847, + "longitude": 6.09312 + }, + { + "latitude": 52.23705, + "longitude": 6.01297 + } + ] + } + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/examples/PostMatrixRouteCalculate.json b/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/examples/PostMatrixRouteCalculate.json new file mode 100644 index 000000000000..7457cd7329dd --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/examples/PostMatrixRouteCalculate.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "routeType": "shortest", + "routeMatrixBody": { + "origins": { + "type": "MultiPoint", + "coordinates": [ + [ + 4.85106, + 52.36006 + ], + [ + 4.85056, + 52.36187 + ] + ] + }, + "destinations": { + "type": "MultiPoint", + "coordinates": [ + [ + 4.85003, + 52.36241 + ], + [ + 13.42937, + 52.50931 + ] + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "formatVersion": "0.0.1", + "matrix": [ + [ + { + "statusCode": 200, + "response": { + "routeSummary": { + "lengthInMeters": 495, + "travelTimeInSeconds": 134, + "trafficDelayInSeconds": 0, + "departureTime": "2018-07-27T22:55:29+00:00", + "arrivalTime": "2018-07-27T22:57:43+00:00" + } + } + }, + { + "statusCode": 200, + "response": { + "routeSummary": { + "lengthInMeters": 647651, + "travelTimeInSeconds": 26835, + "trafficDelayInSeconds": 489, + "departureTime": "2018-07-27T22:55:29+00:00", + "arrivalTime": "2018-07-28T06:22:44+00:00" + } + } + } + ], + [ + { + "statusCode": 200, + "response": { + "routeSummary": { + "lengthInMeters": 338, + "travelTimeInSeconds": 104, + "trafficDelayInSeconds": 0, + "departureTime": "2018-07-27T22:55:29+00:00", + "arrivalTime": "2018-07-27T22:57:13+00:00" + } + } + }, + { + "statusCode": 200, + "response": { + "routeSummary": { + "lengthInMeters": 647494, + "travelTimeInSeconds": 26763, + "trafficDelayInSeconds": 469, + "departureTime": "2018-07-27T22:55:29+00:00", + "arrivalTime": "2018-07-28T06:21:32+00:00" + } + } + } + ] + ], + "summary": { + "successfulRoutes": 4, + "totalRoutes": 4 + } + } + }, + "202": { + "headers": { + "Location": "New URL to check the status of the long running request." + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/examples/PostRouteDirections.json b/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/examples/PostRouteDirections.json new file mode 100644 index 000000000000..898a94a17dd5 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/examples/PostRouteDirections.json @@ -0,0 +1,234 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "query": "52.50931,13.42936:52.50274,13.43872", + "subscription-key": "[subscription-key]", + "routeDirectionsRequestBody": { + "supportingPoints": { + "type": "GeometryCollection", + "geometries": [ + { + "type": "Point", + "coordinates": [ + 13.42936, + 52.5093 + ] + }, + { + "type": "Point", + "coordinates": [ + 13.42859, + 52.50844 + ] + } + ] + }, + "avoidVignette": [ + "AUS", + "CHE" + ], + "avoidAreas": { + "type": "MultiPolygon", + "coordinates": [ + [ + [ + [ + -122.39456176757811, + 47.489368981370724 + ], + [ + -122.00454711914061, + 47.489368981370724 + ], + [ + -122.00454711914061, + 47.65151268066222 + ], + [ + -122.39456176757811, + 47.65151268066222 + ], + [ + -122.39456176757811, + 47.489368981370724 + ] + ] + ], + [ + [ + [ + 100.0, + 0.0 + ], + [ + 101.0, + 0.0 + ], + [ + 101.0, + 1.0 + ], + [ + 100.0, + 1.0 + ], + [ + 100.0, + 0.0 + ] + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "formatVersion": "0.0.12", + "routes": [ + { + "summary": { + "lengthInMeters": 1147, + "travelTimeInSeconds": 162, + "trafficDelayInSeconds": 0, + "departureTime": "2017-09-07T16:56:58+00:00", + "arrivalTime": "2017-09-07T16:59:40+00:00" + }, + "legs": [ + { + "summary": { + "lengthInMeters": 1147, + "travelTimeInSeconds": 162, + "trafficDelayInSeconds": 0, + "departureTime": "2017-09-07T16:56:58+00:00", + "arrivalTime": "2017-09-07T16:59:40+00:00" + }, + "points": [ + { + "latitude": 52.50931, + "longitude": 13.42937 + }, + { + "latitude": 52.50904, + "longitude": 13.42912 + }, + { + "latitude": 52.50894, + "longitude": 13.42904 + }, + { + "latitude": 52.50867, + "longitude": 13.42879 + }, + { + "latitude": 52.5084, + "longitude": 13.42857 + }, + { + "latitude": 52.50791, + "longitude": 13.42824 + }, + { + "latitude": 52.50757, + "longitude": 13.42772 + }, + { + "latitude": 52.50735, + "longitude": 13.42823 + }, + { + "latitude": 52.5073, + "longitude": 13.42836 + }, + { + "latitude": 52.50573, + "longitude": 13.43194 + }, + { + "latitude": 52.50512, + "longitude": 13.43336 + }, + { + "latitude": 52.50464, + "longitude": 13.43451 + }, + { + "latitude": 52.5045, + "longitude": 13.43481 + }, + { + "latitude": 52.50443, + "longitude": 13.43498 + }, + { + "latitude": 52.50343, + "longitude": 13.43737 + }, + { + "latitude": 52.50274, + "longitude": 13.43872 + } + ] + } + ], + "sections": [ + { + "startPointIndex": 0, + "endPointIndex": 15, + "sectionType": "TRAVEL_MODE", + "travelMode": "car" + } + ] + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/examples/PostRouteDirectionsBatch.json b/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/examples/PostRouteDirectionsBatch.json new file mode 100644 index 000000000000..185d11981d0a --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/examples/PostRouteDirectionsBatch.json @@ -0,0 +1,212 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "routeDirectionsBatchRequestBody": { + "batchItems": [ + { + "query": "?query=47.639987,-122.128384:47.621252,-122.184408:47.596437,-122.332000&routeType=fastest&travelMode=car&maxAlternatives=99" + }, + { + "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" + }, + { + "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "batchItems": [ + { + "statusCode": 400, + "response": { + "error": { + "code": "400 BadRequest", + "message": "maxAlternatives parameter value should be between 0 and 5 inclusive" + } + } + }, + { + "statusCode": 200, + "response": { + "formatVersion": "0.0.12", + "routes": [ + { + "summary": { + "lengthInMeters": 1754, + "travelTimeInSeconds": 386, + "trafficDelayInSeconds": 0, + "departureTime": "2019-06-21T22:56:23+00:00", + "arrivalTime": "2019-06-21T23:02:49+00:00" + }, + "legs": [ + { + "summary": { + "lengthInMeters": 1754, + "travelTimeInSeconds": 386, + "trafficDelayInSeconds": 0, + "departureTime": "2019-06-21T22:56:23+00:00", + "arrivalTime": "2019-06-21T23:02:49+00:00" + }, + "points": [ + { + "latitude": 47.62094, + "longitude": -122.34892 + }, + { + "latitude": 47.62094, + "longitude": -122.3485 + }, + { + "latitude": 47.62095, + "longitude": -122.3476 + }, + { + "latitude": 47.60995, + "longitude": -122.34174 + }, + { + "latitude": 47.61011, + "longitude": -122.342 + } + ] + } + ], + "sections": [ + { + "startPointIndex": 0, + "endPointIndex": 44, + "sectionType": "TRAVEL_MODE", + "travelMode": "bicycle" + } + ] + } + ] + } + }, + { + "statusCode": 200, + "response": { + "formatVersion": "0.0.12", + "routes": [ + { + "summary": { + "lengthInMeters": 1772, + "travelTimeInSeconds": 1276, + "trafficDelayInSeconds": 0, + "departureTime": "2019-06-21T22:56:23+00:00", + "arrivalTime": "2019-06-21T23:17:38+00:00" + }, + "legs": [ + { + "summary": { + "lengthInMeters": 1772, + "travelTimeInSeconds": 1276, + "trafficDelayInSeconds": 0, + "departureTime": "2019-06-21T22:56:23+00:00", + "arrivalTime": "2019-06-21T23:17:38+00:00" + }, + "points": [ + { + "latitude": 40.75982, + "longitude": -73.98493 + }, + { + "latitude": 40.7601, + "longitude": -73.98483 + }, + { + "latitude": 40.75984, + "longitude": -73.98417 + }, + { + "latitude": 40.76047, + "longitude": -73.9837 + }, + { + "latitude": 40.77095, + "longitude": -73.9736 + }, + { + "latitude": 40.77114, + "longitude": -73.97356 + } + ] + } + ], + "sections": [ + { + "startPointIndex": 0, + "endPointIndex": 47, + "sectionType": "TRAVEL_MODE", + "travelMode": "pedestrian" + } + ] + } + ] + } + } + ], + "summary": { + "successfulRequests": 2, + "totalRequests": 3 + } + } + }, + "202": { + "headers": { + "Location": "URL to download the results of the long-running batch request." + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/route.json b/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/route.json new file mode 100644 index 000000000000..20db41da9378 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Route/preview/1.0/route.json @@ -0,0 +1,2845 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Route Service", + "version": "1.0", + "description": "Azure Maps Route REST APIs" + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json", + "application/xml" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "user_impersonation": "Impersonates a user's Azure Active Directory account." + } + }, + "apiKeyQuery": { + "type": "apiKey", + "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + } + }, + "security": [ + { + "azure_auth": [] + }, + { + "apiKeyQuery": [] + } + ], + "responses": { + "202": { + "description": "Request Accepted: The request has been accepted for processing. Please use the URL in the Location Header to retry or access the results.", + "headers": { + "Location": { + "type": "string", + "description": "New URL to check for the results of the long running process." + } + } + }, + "400": { + "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "401": { + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + }, + "headers": { + "WWW-Authenticate": { + "type": "string", + "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" + } + } + }, + "403": { + "description": "Permission, capacity, or authentication issues.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "404": { + "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "500": { + "description": "An error occurred while processing the request. Please try again later.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "202Async": { + "description": "**Supported only for async request.**\nRequest Accepted: The request has been accepted for processing. Please use the URL in the Location Header to retry or access the results.", + "headers": { + "Location": { + "type": "string", + "description": "New URL to check for the results of the long running process." + } + } + } + }, + "parameters": { + "ClientId": { + "name": "x-ms-client-id", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "client" + }, + "SubscriptionKey": { + "name": "subscription-key", + "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API. Current version is 1.0", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "JsonFormat": { + "name": "format", + "description": "Desired format of the response. Only `json` format is supported.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "json" + ], + "x-ms-enum": { + "name": "JsonFormat", + "modelAsString": false, + "values": [ + { + "value": "json", + "description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "TextFormat": { + "name": "format", + "description": "Desired format of the response. Value can be either _json_ or _xml_.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "json", + "xml" + ], + "x-ms-enum": { + "name": "TextFormat", + "modelAsString": false, + "values": [ + { + "value": "json", + "description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)" + }, + { + "value": "xml", + "description": "[The Extensible Markup Language](https://www.w3.org/TR/xml/)" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "VehicleLoadType": { + "name": "vehicleLoadType", + "in": "query", + "description": "Types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. Values beginning with USHazmat are for US routing while otherHazmat should be used for all other countries. vehicleLoadType can be specified multiple times. This parameter is currently only considered for travelMode=truck.", + "required": false, + "type": "string", + "enum": [ + "USHazmatClass1", + "USHazmatClass2", + "USHazmatClass3", + "USHazmatClass4", + "USHazmatClass5", + "USHazmatClass6", + "USHazmatClass7", + "USHazmatClass8", + "USHazmatClass9", + "otherHazmatExplosive", + "otherHazmatGeneral", + "otherHazmatHarmfulToWater" + ], + "x-ms-enum": { + "name": "VehicleLoadType", + "modelAsString": false, + "values": [ + { + "value": "USHazmatClass1", + "description": "Explosives" + }, + { + "value": "USHazmatClass2", + "description": "Compressed gas" + }, + { + "value": "USHazmatClass3", + "description": "Flammable liquids" + }, + { + "value": "USHazmatClass4", + "description": "Flammable solids" + }, + { + "value": "USHazmatClass5", + "description": "Oxidizers" + }, + { + "value": "USHazmatClass6", + "description": "Poisons" + }, + { + "value": "USHazmatClass7", + "description": "Radioactive" + }, + { + "value": "USHazmatClass8", + "description": "Corrosives" + }, + { + "value": "USHazmatClass9", + "description": "Miscellaneous" + }, + { + "value": "otherHazmatExplosive", + "description": "Explosives" + }, + { + "value": "otherHazmatGeneral", + "description": "Miscellaneous" + }, + { + "value": "otherHazmatHarmfulToWater", + "description": "Harmful to water" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "RouteType": { + "name": "routeType", + "in": "query", + "description": "The type of route requested.", + "required": false, + "type": "string", + "default": "fastest", + "enum": [ + "fastest", + "shortest", + "eco", + "thrilling" + ], + "x-ms-enum": { + "name": "RouteType", + "modelAsString": false, + "values": [ + { + "value": "fastest", + "description": "The fastest route." + }, + { + "value": "shortest", + "description": "The shortest route by distance." + }, + { + "value": "eco", + "description": "A route balanced by economy and speed." + }, + { + "value": "thrilling", + "description": "Includes interesting or challenging roads and uses as few motorways as possible. You can choose the level of turns included and also the degree of hilliness. See the hilliness and windingness parameters for how to set this. There is a limit of 900 km on routes planned with `routeType`=thrilling" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "Windingness": { + "name": "windingness", + "in": "query", + "description": "Level of turns for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling.", + "required": false, + "type": "string", + "default": "normal", + "enum": [ + "low", + "normal", + "high" + ], + "x-ms-enum": { + "name": "Windingness", + "modelAsString": false, + "values": [ + { + "value": "low", + "description": "low" + }, + { + "value": "normal", + "description": "normal" + }, + { + "value": "high", + "description": "high" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "Hilliness": { + "name": "hilliness", + "in": "query", + "description": "Degree of hilliness for thrilling route. This parameter can only be used in conjunction with `routeType`=thrilling.", + "required": false, + "type": "string", + "default": "normal", + "enum": [ + "low", + "normal", + "high" + ], + "x-ms-enum": { + "name": "Hilliness", + "modelAsString": false, + "values": [ + { + "value": "low", + "description": "low" + }, + { + "value": "normal", + "description": "normal" + }, + { + "value": "high", + "description": "high" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "TravelMode": { + "name": "travelMode", + "in": "query", + "description": "The mode of travel for the requested route. If not defined, default is 'car'. Note that the requested travelMode may not be available for the entire route. Where the requested travelMode is not available for a particular section, the travelMode element of the response for that section will be \"other\". Note that travel modes bus, motorcycle, taxi and van are BETA functionality. Full restriction data is not available in all areas. In **calculateReachableRange** requests, the values bicycle and pedestrian must not be used.", + "required": false, + "type": "string", + "default": "car", + "enum": [ + "car", + "truck", + "taxi", + "bus", + "van", + "motorcycle", + "bicycle", + "pedestrian" + ], + "x-ms-enum": { + "name": "TravelMode", + "modelAsString": false, + "values": [ + { + "value": "car", + "description": "The returned routes are optimized for cars." + }, + { + "value": "truck", + "description": "The returned routes are optimized for commercial vehicles, like for trucks." + }, + { + "value": "taxi", + "description": "The returned routes are optimized for taxis. BETA functionality." + }, + { + "value": "bus", + "description": "The returned routes are optimized for buses, including the use of bus only lanes. BETA functionality." + }, + { + "value": "van", + "description": "The returned routes are optimized for vans. BETA functionality." + }, + { + "value": "motorcycle", + "description": "The returned routes are optimized for motorcycles. BETA functionality." + }, + { + "value": "bicycle", + "description": "The returned routes are optimized for bicycles, including use of bicycle lanes." + }, + { + "value": "pedestrian", + "description": "The returned routes are optimized for pedestrians, including the use of sidewalks." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "Avoid": { + "name": "avoid", + "in": "query", + "description": "Specifies something that the route calculation should try to avoid when determining the route. Can be specified multiple times in one request, for example, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. In calculateReachableRange requests, the value alreadyUsedRoads must not be used.", + "required": false, + "type": "string", + "enum": [ + "tollRoads", + "motorways", + "ferries", + "unpavedRoads", + "carpools", + "alreadyUsedRoads", + "borderCrossings" + ], + "x-ms-enum": { + "name": "Avoid", + "modelAsString": false, + "values": [ + { + "value": "tollRoads", + "description": "Avoids toll roads." + }, + { + "value": "motorways", + "description": "Avoids motorways" + }, + { + "value": "ferries", + "description": "Avoids ferries" + }, + { + "value": "unpavedRoads", + "description": "Avoids unpaved roads" + }, + { + "value": "carpools", + "description": "Avoids routes that require the use of carpool (HOV/High Occupancy Vehicle) lanes." + }, + { + "value": "alreadyUsedRoads", + "description": "Avoids using the same road multiple times. Most useful in conjunction with `routeType`=thrilling." + }, + { + "value": "borderCrossings", + "description": "Avoids border crossings in route calculation." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "VehicleEngineType": { + "name": "vehicleEngineType", + "in": "query", + "description": "Engine type of the vehicle. When a detailed Consumption Model is specified, it must be consistent with the value of **vehicleEngineType**.", + "required": false, + "type": "string", + "enum": [ + "combustion", + "electric" + ], + "default": "combustion", + "x-ms-enum": { + "name": "VehicleEngineType", + "modelAsString": false, + "values": [ + { + "value": "combustion", + "description": "Internal combustion engine." + }, + { + "value": "electric", + "description": "Electric engine." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "ConstantSpeedConsumptionInLitersPerHundredkm": { + "name": "constantSpeedConsumptionInLitersPerHundredkm", + "in": "query", + "description": "\n\nSpecifies the speed-dependent component of consumption.\n\nProvided as an unordered list of colon-delimited speed & consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:\n\n * by linear interpolation, if the given speed lies in between two speeds in the list\n\n * by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list\n\nThe list must contain between 1 and 25 points (inclusive), and may not contain duplicate points for the same speed. If it only contains a single point, then the consumption rate of that point is used without further processing.\n\nConsumption specified for the largest speed must be greater than or equal to that of the penultimate largest speed. This ensures that extrapolation does not lead to negative consumption rates.\n\nSimilarly, consumption values specified for the two smallest speeds in the list cannot lead to a negative consumption rate for any smaller speed.\n\nThe valid range for the consumption values(expressed in l/100km) is between 0.01 and 100000.0.\n\nSensible Values : 50,6.3:130,11.5\n\n**Note** : This parameter is required for **The Combustion Consumption Model**.", + "required": false, + "type": "number", + "format": "float", + "x-ms-parameter-location": "method" + }, + "CurrentFuelInLiters": { + "name": "currentFuelInLiters", + "in": "query", + "description": "Specifies the current supply of fuel in liters.\n\nSensible Values : 55", + "required": false, + "type": "number", + "format": "float", + "x-ms-parameter-location": "method" + }, + "AuxiliaryPowerInLitersPerHour": { + "name": "auxiliaryPowerInLitersPerHour", + "in": "query", + "description": "Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour.\n\nIt can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.\n\nSensible Values : 0.2", + "required": false, + "type": "number", + "format": "float", + "x-ms-parameter-location": "method" + }, + "FuelEnergyDensityInMJoulesPerLiter": { + "name": "fuelEnergyDensityInMJoulesPerLiter", + "in": "query", + "description": "Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ). It is used in conjunction with the ***Efficiency** parameters for conversions between saved or consumed energy and fuel. For example, energy density is 34.2 MJ/l for gasoline, and 35.8 MJ/l for Diesel fuel.\n\nThis parameter is required if any ***Efficiency** parameter is set.\n\nSensible Values : 34.2", + "required": false, + "type": "number", + "format": "float", + "x-ms-parameter-location": "method" + }, + "AccelerationEfficiency": { + "name": "accelerationEfficiency", + "in": "query", + "description": "Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates _(i.e. KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed_ is obtained by converting consumed fuel to chemical energy using **fuelEnergyDensityInMJoulesPerLiter**.\n\nMust be paired with **decelerationEfficiency**.\n\nThe range of values allowed are 0.0 to 1/**decelerationEfficiency**.\n\nSensible Values : for **Combustion Model** : 0.33, for **Electric Model** : 0.66", + "required": false, + "type": "number", + "format": "float", + "x-ms-parameter-location": "method" + }, + "DecelerationEfficiency": { + "name": "decelerationEfficiency", + "in": "query", + "description": "Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates _(i.e. ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved_ is obtained by converting saved (not consumed) fuel to energy using **fuelEnergyDensityInMJoulesPerLiter**.\n\nMust be paired with **accelerationEfficiency**.\n\nThe range of values allowed are 0.0 to 1/**accelerationEfficiency**.\n\nSensible Values : for **Combustion Model** : 0.83, for **Electric Model** : 0.91", + "required": false, + "type": "number", + "format": "float", + "x-ms-parameter-location": "method" + }, + "UphillEfficiency": { + "name": "uphillEfficiency", + "in": "query", + "description": "Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation _(i.e. PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed_ is obtained by converting consumed fuel to chemical energy using **fuelEnergyDensityInMJoulesPerLiter**.\n\nMust be paired with **downhillEfficiency**.\n\nThe range of values allowed are 0.0 to 1/**downhillEfficiency**.\n\nSensible Values : for **Combustion Model** : 0.27, for **Electric Model** : 0.74", + "required": false, + "type": "number", + "format": "float", + "x-ms-parameter-location": "method" + }, + "DownhillEfficiency": { + "name": "downhillEfficiency", + "in": "query", + "description": "Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation _(i.e. ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved_ is obtained by converting saved (not consumed) fuel to energy using **fuelEnergyDensityInMJoulesPerLiter**.\n\nMust be paired with **uphillEfficiency**.\n\nThe range of values allowed are 0.0 to 1/**uphillEfficiency**.\n\nSensible Values : for **Combustion Model** : 0.51, for **Electric Model** : 0.73", + "required": false, + "type": "number", + "format": "float", + "x-ms-parameter-location": "method" + }, + "ConstantSpeedConsumptionInkWhPerHundredkm": { + "name": "constantSpeedConsumptionInkWhPerHundredkm", + "in": "query", + "description": "Specifies the speed-dependent component of consumption.\n\nProvided as an unordered list of speed/consumption-rate pairs. The list defines points on a consumption curve. Consumption rates for speeds not in the list are found as follows:\n\n* by linear interpolation, if the given speed lies in between two speeds in the list\n\n* by linear extrapolation otherwise, assuming a constant (ΔConsumption/ΔSpeed) determined by the nearest two points in the list\n\nThe list must contain between 1 and 25 points (inclusive), and may not contain duplicate points for the same speed. If it only contains a single point, then the consumption rate of that point is used without further processing.\n\nConsumption specified for the largest speed must be greater than or equal to that of the penultimate largest speed. This ensures that extrapolation does not lead to negative consumption rates.\n\nSimilarly, consumption values specified for the two smallest speeds in the list cannot lead to a negative consumption rate for any smaller speed.\n\nThe valid range for the consumption values(expressed in kWh/100km) is between 0.01 and 100000.0.\n\nSensible Values : 50,8.2:130,21.3\n\nThis parameter is required for **Electric consumption model**.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "CurrentChargeInkWh": { + "name": "currentChargeInkWh", + "in": "query", + "description": "Specifies the current electric energy supply in kilowatt hours (kWh).\n\nThis parameter co-exists with **maxChargeInkWh** parameter.\n\nThe range of values allowed are 0.0 to **maxChargeInkWh**.\n\nSensible Values : 43", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "MaxChargeInkWh": { + "name": "maxChargeInkWh", + "in": "query", + "description": "Specifies the maximum electric energy supply in kilowatt hours (kWh) that may be stored in the vehicle's battery.\n\nThis parameter co-exists with **currentChargeInkWh** parameter.\n\nMinimum value has to be greater than or equal to **currentChargeInkWh**.\n\nSensible Values : 85", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AuxiliaryPowerInkW": { + "name": "auxiliaryPowerInkW", + "in": "query", + "description": "Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW).\n\nIt can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.\n\nSensible Values : 1.7", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VehicleWeightMatrix": { + "name": "vehicleWeight", + "in": "query", + "description": "Weight of the vehicle in kilograms.", + "required": false, + "type": "integer", + "default": 0, + "x-ms-parameter-location": "method" + }, + "VehicleWeight": { + "name": "vehicleWeight", + "in": "query", + "description": "Weight of the vehicle in kilograms.\n\n* It is mandatory if any of the *Efficiency parameters are set.\n\n* It must be strictly positive when used in the context of the Consumption Model. Weight restrictions are considered.\n\n* If no detailed **Consumption Model** is specified and the value of **vehicleWeight** is non-zero, then weight restrictions are considered.\n\n* In all other cases, this parameter is ignored.\n\nSensible Values : for **Combustion Model** : 1600, for **Electric Model** : 1900", + "required": false, + "type": "integer", + "default": 0, + "x-ms-parameter-location": "method" + }, + "VehicleMaxSpeed": { + "name": "vehicleMaxSpeed", + "in": "query", + "description": "Maximum speed of the vehicle in km/hour. The max speed in the vehicle profile is used to check whether a vehicle is allowed on motorways. \n\n* A value of 0 means that an appropriate value for the vehicle will be determined and applied during route planning.\n\n* A non-zero value may be overridden during route planning. For example, the current traffic flow is 60 km/hour. If the vehicle maximum speed is set to 50 km/hour, the routing engine will consider 60 km/hour as this is the current situation. If the maximum speed of the vehicle is provided as 80 km/hour but the current traffic flow is 60 km/hour, then routing engine will again use 60 km/hour.", + "required": false, + "type": "integer", + "default": 0, + "x-ms-parameter-location": "method" + }, + "VehicleLength": { + "name": "vehicleLength", + "in": "query", + "description": "Length of the vehicle in meters. A value of 0 means that length restrictions are not considered.", + "required": false, + "type": "number", + "format": "float", + "default": 0, + "x-ms-parameter-location": "method" + }, + "VehicleHeight": { + "name": "vehicleHeight", + "in": "query", + "description": "Height of the vehicle in meters. A value of 0 means that height restrictions are not considered.", + "required": false, + "type": "number", + "format": "float", + "default": 0, + "x-ms-parameter-location": "method" + }, + "VehicleWidth": { + "name": "vehicleWidth", + "in": "query", + "description": "Width of the vehicle in meters. A value of 0 means that width restrictions are not considered.", + "required": false, + "type": "number", + "format": "float", + "default": 0, + "x-ms-parameter-location": "method" + }, + "VehicleAxleWeight": { + "name": "vehicleAxleWeight", + "in": "query", + "description": "Weight per axle of the vehicle in kg. A value of 0 means that weight restrictions per axle are not considered.", + "required": false, + "type": "integer", + "default": 0, + "x-ms-parameter-location": "method" + }, + "VehicleCommercial": { + "name": "vehicleCommercial", + "in": "query", + "description": "Vehicle is used for commercial purposes and thus may not be allowed to drive on some roads.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "DepartAt": { + "name": "departAt", + "in": "query", + "description": "The date and time of departure from the origin point. Departure times apart from now must be specified as a dateTime. When a time zone offset is not specified, it will be assumed to be that of the origin point. The departAt value must be in the future in the date-time format (1996-12-19T16:39:57-08:00).", + "type": "string", + "format": "date-time", + "required": false, + "x-ms-parameter-location": "method" + }, + "ArriveAt": { + "name": "arriveAt", + "in": "query", + "description": "The date and time of arrival at the destination point. It must be specified as a dateTime. When a time zone offset is not specified it will be assumed to be that of the destination point. The arriveAt value must be in the future. The arriveAt parameter cannot be used in conjunction with departAt, minDeviationDistance or minDeviationTime.", + "type": "string", + "format": "date-time", + "required": false, + "x-ms-parameter-location": "method" + }, + "SectionType": { + "name": "sectionType", + "in": "query", + "description": "Specifies which of the section types is reported in the route response.

For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned. Multiple types can be used. The default sectionType refers to the travelMode input. By default travelMode is set to car", + "required": false, + "type": "string", + "default": "travelMode", + "enum": [ + "carTrain", + "country", + "ferry", + "motorway", + "pedestrian", + "tollRoad", + "tollVignette", + "traffic", + "travelMode", + "tunnel" + ], + "x-ms-enum": { + "name": "SectionType", + "modelAsString": false, + "values": [ + { + "value": "carTrain", + "description": "Get sections if the route includes car trains." + }, + { + "value": "country", + "description": "Countries the route has parts in." + }, + { + "value": "ferry", + "description": "Get sections if the route includes ferries." + }, + { + "value": "motorway", + "description": "Get sections if the route includes motorways." + }, + { + "value": "pedestrian", + "description": "Get sections which are suited for pedestrians." + }, + { + "value": "tollRoad", + "description": "Get sections which require a toll to be payed." + }, + { + "value": "tollVignette", + "description": "Get sections which require a toll vignette to be present." + }, + { + "value": "traffic", + "description": "Get sections which contain traffic information." + }, + { + "value": "travelMode", + "description": "Get sections in relation to the request parameter `travelMode`." + }, + { + "value": "tunnel", + "description": "Get sections if the route includes tunnels." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "ComputeBestOrder": { + "name": "computeBestOrder", + "in": "query", + "description": "Re-order the route waypoints using a fast heuristic algorithm to reduce the route length. Yields best results when used in conjunction with routeType _shortest_. Notice that origin and destination are excluded from the optimized waypoint indices. To include origin and destination in the response, please increase all the indices by 1 to account for the origin, and then add the destination as the final index. Possible values are true or false. True computes a better order if possible, but is not allowed to be used in conjunction with maxAlternatives value greater than 0 or in conjunction with circle waypoints. False will use the locations in the given order and not allowed to be used in conjunction with routeRepresentation _none_.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "RouteRepresentation": { + "name": "routeRepresentation", + "in": "query", + "description": "Specifies the representation of the set of routes provided as response. This parameter value can only be used in conjunction with computeBestOrder=true.", + "required": false, + "type": "string", + "default": "polyline", + "enum": [ + "polyline", + "summaryOnly", + "none" + ], + "x-ms-enum": { + "name": "RouteRepresentation", + "modelAsString": false, + "values": [ + { + "value": "polyline", + "description": "Includes route geometry in the response." + }, + { + "value": "summaryOnly", + "description": "Summary as per polyline but excluding the point geometry elements for the routes in the response." + }, + { + "value": "none", + "description": "Includes only the optimized waypoint indices but does not include the route geometry in the response." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "ComputeTravelTimeFor": { + "name": "computeTravelTimeFor", + "in": "query", + "description": "Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time.", + "required": false, + "type": "string", + "default": "none", + "enum": [ + "none", + "all" + ], + "x-ms-enum": { + "name": "ComputeTravelTimeFor", + "modelAsString": false, + "values": [ + { + "value": "none", + "description": "Does not compute additional travel times." + }, + { + "value": "all", + "description": "Computes travel times for all types of traffic information and specifies all results in the fields noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds and liveTrafficIncidentsTravelTimeInSeconds being included in the summaries in the route response." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "VehicleHeading": { + "name": "vehicleHeading", + "in": "query", + "description": "The directional heading of the vehicle in degrees starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359", + "required": false, + "type": "integer", + "minimum": 0, + "maximum": 359, + "x-ms-parameter-location": "method" + }, + "Report": { + "name": "report", + "in": "query", + "description": "Specifies which data should be reported for diagnosis purposes. The only possible value is _effectiveSettings_. Reports the effective parameters or data used when calling the API. In the case of defaulted parameters the default will be reflected where the parameter was not specified by the caller.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Traffic": { + "name": "traffic", + "in": "query", + "description": "Possible values: \n * true - Do consider all available traffic information during routing\n * false - Ignore current traffic data during routing. Note that although the current traffic data is ignored \n during routing, the effect of historic traffic on effective road speeds is still incorporated.", + "required": false, + "type": "boolean", + "default": true, + "x-ms-parameter-location": "method" + }, + "AlternativeRouteType": { + "name": "alternativeType", + "in": "query", + "description": "Controls the optimality, with respect to the given planning criteria, of the calculated alternatives compared to the reference route.", + "required": false, + "type": "string", + "default": "anyRoute", + "enum": [ + "anyRoute", + "betterRoute" + ], + "x-ms-enum": { + "name": "AlternativeRouteType", + "modelAsString": false, + "values": [ + { + "value": "anyRoute", + "description": "Allow any alternative route to be returned irrespective of how it compares to the reference route in terms of optimality." + }, + { + "value": "betterRoute", + "description": "Return an alternative route only if it is better than the reference route according to the given planning criteria." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "RouteInstructionsType": { + "name": "instructionsType", + "in": "query", + "description": "If specified, guidance instructions will be returned. Note that the instructionsType parameter cannot be used in conjunction with routeRepresentation=none", + "required": false, + "type": "string", + "enum": [ + "coded", + "text", + "tagged" + ], + "x-ms-enum": { + "name": "RouteInstructionsType", + "modelAsString": false, + "values": [ + { + "value": "coded", + "description": "Returns raw instruction data without human-readable messages." + }, + { + "value": "text", + "description": "Returns raw instructions data with human-readable messages in plain text." + }, + { + "value": "tagged", + "description": "Returns raw instruction data with tagged human-readable messages to permit formatting. A human-readable message is built up from repeatable identified elements. These are tagged to allow client applications to format them correctly. The following message components are tagged when instructionsType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber.\n\nExample of tagged 'Turn left' message:​\n\n```\nTurn left onto A4/E19\ntowards Den Haag\n```" + } + ] + }, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/route/matrix/{format}": { + "post": { + "x-publish": true, + "description": "\n\n**Applies to**: S1 pricing tier.\n\nThe Matrix Routing service allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) or synchronous (sync) POST request. For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "operationId": "Route_PostRouteMatrix", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "MatrixRoute": { + "$ref": "./examples/PostMatrixRouteCalculate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "waitForResults", + "in": "query", + "description": "Boolean to indicate whether to execute the request synchronously. If set to true, user will get a 200 response if the request is finished under 120 seconds. Otherwise, user will get a 202 response right away. Please refer to the API description for more details on 202 response. **Supported only for async request**.", + "required": false, + "type": "boolean", + "default": false + }, + { + "$ref": "#/parameters/ComputeTravelTimeFor" + }, + { + "$ref": "#/parameters/SectionType" + }, + { + "$ref": "#/parameters/ArriveAt" + }, + { + "$ref": "#/parameters/DepartAt" + }, + { + "$ref": "#/parameters/VehicleAxleWeight" + }, + { + "$ref": "#/parameters/VehicleLength" + }, + { + "$ref": "#/parameters/VehicleHeight" + }, + { + "$ref": "#/parameters/VehicleWidth" + }, + { + "$ref": "#/parameters/VehicleMaxSpeed" + }, + { + "$ref": "#/parameters/VehicleWeightMatrix" + }, + { + "$ref": "#/parameters/Windingness" + }, + { + "$ref": "#/parameters/Hilliness" + }, + { + "$ref": "#/parameters/TravelMode" + }, + { + "$ref": "#/parameters/Avoid" + }, + { + "$ref": "#/parameters/Traffic" + }, + { + "$ref": "#/parameters/RouteType" + }, + { + "$ref": "#/parameters/VehicleLoadType" + }, + { + "name": "routeMatrixBody", + "description": "The matrix of origin and destination coordinates to compute the route distance, travel time and other summary for each cell of the matrix based on the input parameters. The minimum and the maximum cell count supported are 1 and **700** for async and **100** for sync respectively. For example, it can be 35 origins and 20 destinations or 25 origins and 25 destinations for async API.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RouteMatrixRequestBody" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RouteMatrixResponse" + } + }, + "202": { + "$ref": "#/responses/202Async" + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "produces": [ + "application/json" + ] + } + }, + "/route/directions/{format}": { + "get": { + "x-publish": true, + "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nReturns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.\n\nInformation returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.\n\nRouting service provides a set of parameters for a detailed description of vehicle-specific Consumption Model. Please check [Consumption Model](https://docs.microsoft.com/azure/azure-maps/consumption-model) for detailed explanation of the concepts and parameters involved.", + "operationId": "Route_GetRouteDirections", + "x-ms-examples": { + "GetRouteDirections": { + "$ref": "./examples/GetRouteDirections.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TextFormat" + }, + { + "name": "query", + "in": "query", + "description": "The Coordinates through which the route is calculated, delimited by a colon. A minimum of two coordinates is required. The first one is the origin and the last is the destination of the route. Optional coordinates in-between act as WayPoints in the route. You can pass up to 150 WayPoints.", + "required": true, + "type": "string" + }, + { + "name": "maxAlternatives", + "in": "query", + "description": "Number of desired alternative routes to be calculated. Default: 0, minimum: 0 and maximum: 5", + "required": false, + "type": "integer", + "minimum": 0, + "maximum": 5, + "default": 0 + }, + { + "$ref": "#/parameters/AlternativeRouteType" + }, + { + "name": "minDeviationDistance", + "in": "query", + "description": "All alternative routes returned will follow the reference route (see section POST Requests) from the origin point of the calculateRoute request for at least this number of meters. Can only be used when reconstructing a route. The minDeviationDistance parameter cannot be used in conjunction with arriveAt", + "required": false, + "type": "integer", + "default": 0 + }, + { + "$ref": "#/parameters/ArriveAt" + }, + { + "$ref": "#/parameters/DepartAt" + }, + { + "name": "minDeviationTime", + "in": "query", + "description": "All alternative routes returned will follow the reference route (see section POST Requests) from the origin point of the calculateRoute request for at least this number of seconds. Can only be used when reconstructing a route. The minDeviationTime parameter cannot be used in conjunction with arriveAt. Default value is 0. Setting )minDeviationTime_ to a value greater than zero has the following consequences:\n - The origin point of the _calculateRoute_ Request must be on\n (or very near) the input reference route.\n - If this is not the case, an error is returned.\n - However, the origin point does not need to be at the beginning\n of the input reference route (it can be thought of as the current\n vehicle position on the reference route).\n - The reference route, returned as the first route in the _calculateRoute_\n Response, will start at the origin point specified in the _calculateRoute_\n Request. The initial part of the input reference route up until the origin\n point will be excluded from the Response.\n - The values of _minDeviationDistance_ and _minDeviationTime_ determine\n how far alternative routes will be guaranteed to follow the reference\n route from the origin point onwards.\n - The route must use _departAt_.\n - The _vehicleHeading_ is ignored.", + "required": false, + "type": "integer", + "default": 0 + }, + { + "$ref": "#/parameters/RouteInstructionsType" + }, + { + "name": "language", + "in": "query", + "description": "The language parameter determines the language of the guidance messages. Proper nouns (the names of streets, plazas, etc.) are returned in the specified language, or if that is not available, they are returned in an available language that is close to it. Allowed values are (a subset of) the IETF language tags. The currently supported languages are listed in the [Supported languages section](https://docs.microsoft.com/azure/azure-maps/supported-languages).\n\nDefault value: en-GB", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/ComputeBestOrder" + }, + { + "$ref": "#/parameters/RouteRepresentation" + }, + { + "$ref": "#/parameters/ComputeTravelTimeFor" + }, + { + "$ref": "#/parameters/VehicleHeading" + }, + { + "$ref": "#/parameters/Report" + }, + { + "$ref": "#/parameters/SectionType" + }, + { + "$ref": "#/parameters/VehicleAxleWeight" + }, + { + "$ref": "#/parameters/VehicleWidth" + }, + { + "$ref": "#/parameters/VehicleHeight" + }, + { + "$ref": "#/parameters/VehicleLength" + }, + { + "$ref": "#/parameters/VehicleMaxSpeed" + }, + { + "$ref": "#/parameters/VehicleWeight" + }, + { + "$ref": "#/parameters/VehicleCommercial" + }, + { + "$ref": "#/parameters/Windingness" + }, + { + "$ref": "#/parameters/Hilliness" + }, + { + "$ref": "#/parameters/TravelMode" + }, + { + "$ref": "#/parameters/Avoid" + }, + { + "$ref": "#/parameters/Traffic" + }, + { + "$ref": "#/parameters/RouteType" + }, + { + "$ref": "#/parameters/VehicleLoadType" + }, + { + "$ref": "#/parameters/VehicleEngineType" + }, + { + "$ref": "#/parameters/ConstantSpeedConsumptionInLitersPerHundredkm" + }, + { + "$ref": "#/parameters/CurrentFuelInLiters" + }, + { + "$ref": "#/parameters/AuxiliaryPowerInLitersPerHour" + }, + { + "$ref": "#/parameters/FuelEnergyDensityInMJoulesPerLiter" + }, + { + "$ref": "#/parameters/AccelerationEfficiency" + }, + { + "$ref": "#/parameters/DecelerationEfficiency" + }, + { + "$ref": "#/parameters/UphillEfficiency" + }, + { + "$ref": "#/parameters/DownhillEfficiency" + }, + { + "$ref": "#/parameters/ConstantSpeedConsumptionInkWhPerHundredkm" + }, + { + "$ref": "#/parameters/CurrentChargeInkWh" + }, + { + "$ref": "#/parameters/MaxChargeInkWh" + }, + { + "$ref": "#/parameters/AuxiliaryPowerInkW" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RouteDirectionsResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + }, + "post": { + "x-publish": true, + "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nReturns a route between an origin and a destination, passing through waypoints if they are specified. The route will take into account factors such as current traffic and the typical road speeds on the requested day of the week and time of day.\n\nInformation returned includes the distance, estimated travel time, and a representation of the route geometry. Additional routing information such as optimized waypoint order or turn by turn instructions is also available, depending on the options selected.\n\nRouting service provides a set of parameters for a detailed description of a vehicle-specific Consumption Model. Please check [Consumption Model](https://docs.microsoft.com/azure/azure-maps/consumption-model) for detailed explanation of the concepts and parameters involved.", + "operationId": "Route_PostRouteDirections", + "x-ms-examples": { + "PostRouteDirections": { + "$ref": "./examples/PostRouteDirections.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TextFormat" + }, + { + "name": "query", + "in": "query", + "description": "The Coordinates through which the route is calculated. Needs two coordinates at least. Delimited by colon. First one is the origin and the last is the destination of the route. The coordinates are in a lat,long format. Optional coordinates in between act as WayPoints in the route.", + "required": true, + "type": "string" + }, + { + "name": "maxAlternatives", + "in": "query", + "description": "Number of desired alternative routes to be calculated. Default: 0, minimum: 0 and maximum: 5", + "required": false, + "type": "integer", + "minimum": 0, + "maximum": 5, + "default": 0 + }, + { + "$ref": "#/parameters/AlternativeRouteType" + }, + { + "name": "minDeviationDistance", + "in": "query", + "description": "All alternative routes returned will follow the reference route (see section POST Requests) from the origin point of the calculateRoute request for at least this number of meters. Can only be used when reconstructing a route. The minDeviationDistance parameter cannot be used in conjunction with arriveAt", + "required": false, + "type": "integer", + "default": 0 + }, + { + "name": "minDeviationTime", + "in": "query", + "description": "All alternative routes returned will follow the reference route (see section POST Requests) from the origin point of the calculateRoute request for at least this number of seconds. Can only be used when reconstructing a route. The minDeviationTime parameter cannot be used in conjunction with arriveAt. Default value is 0. Setting )minDeviationTime_ to a value greater than zero has the following consequences:\n - The origin point of the _calculateRoute_ Request must be on\n (or very near) the input reference route.\n - If this is not the case, an error is returned.\n - However, the origin point does not need to be at the beginning\n of the input reference route (it can be thought of as the current\n vehicle position on the reference route).\n - The reference route, returned as the first route in the _calculateRoute_\n Response, will start at the origin point specified in the _calculateRoute_\n Request. The initial part of the input reference route up until the origin\n point will be excluded from the Response.\n - The values of _minDeviationDistance_ and _minDeviationTime_ determine\n how far alternative routes will be guaranteed to follow the reference\n route from the origin point onwards.\n - The route must use _departAt_.\n - The _vehicleHeading_ is ignored.", + "required": false, + "type": "integer", + "default": 0 + }, + { + "$ref": "#/parameters/RouteInstructionsType" + }, + { + "name": "language", + "in": "query", + "description": "The language parameter determines the language of the guidance messages. It does not affect proper nouns (the names of streets, plazas, etc.) It has no effect when instructionsType=coded. Allowed values are (a subset of) the IETF language tags described", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/ComputeBestOrder" + }, + { + "$ref": "#/parameters/RouteRepresentation" + }, + { + "$ref": "#/parameters/ComputeTravelTimeFor" + }, + { + "$ref": "#/parameters/VehicleHeading" + }, + { + "$ref": "#/parameters/Report" + }, + { + "$ref": "#/parameters/SectionType" + }, + { + "$ref": "#/parameters/ArriveAt" + }, + { + "$ref": "#/parameters/DepartAt" + }, + { + "$ref": "#/parameters/VehicleAxleWeight" + }, + { + "$ref": "#/parameters/VehicleLength" + }, + { + "$ref": "#/parameters/VehicleHeight" + }, + { + "$ref": "#/parameters/VehicleWidth" + }, + { + "$ref": "#/parameters/VehicleMaxSpeed" + }, + { + "$ref": "#/parameters/VehicleWeight" + }, + { + "$ref": "#/parameters/VehicleCommercial" + }, + { + "$ref": "#/parameters/Windingness" + }, + { + "$ref": "#/parameters/Hilliness" + }, + { + "$ref": "#/parameters/TravelMode" + }, + { + "$ref": "#/parameters/Avoid" + }, + { + "$ref": "#/parameters/Traffic" + }, + { + "$ref": "#/parameters/RouteType" + }, + { + "$ref": "#/parameters/VehicleLoadType" + }, + { + "$ref": "#/parameters/VehicleEngineType" + }, + { + "$ref": "#/parameters/ConstantSpeedConsumptionInLitersPerHundredkm" + }, + { + "$ref": "#/parameters/CurrentFuelInLiters" + }, + { + "$ref": "#/parameters/AuxiliaryPowerInLitersPerHour" + }, + { + "$ref": "#/parameters/FuelEnergyDensityInMJoulesPerLiter" + }, + { + "$ref": "#/parameters/AccelerationEfficiency" + }, + { + "$ref": "#/parameters/DecelerationEfficiency" + }, + { + "$ref": "#/parameters/UphillEfficiency" + }, + { + "$ref": "#/parameters/DownhillEfficiency" + }, + { + "$ref": "#/parameters/ConstantSpeedConsumptionInkWhPerHundredkm" + }, + { + "$ref": "#/parameters/CurrentChargeInkWh" + }, + { + "$ref": "#/parameters/MaxChargeInkWh" + }, + { + "$ref": "#/parameters/AuxiliaryPowerInkW" + }, + { + "name": "routeDirectionsRequestBody", + "description": "Used for reconstructing a route and for calculating zero or more alternative routes to this reference route. The provided sequence of coordinates is used as input for route reconstruction. The alternative routes are calculated between the origin and destination points specified in the base path parameter locations. If both minDeviationDistance and minDeviationTime are set to zero, then these origin and destination points are expected to be at (or very near) the beginning and end of the reference route, respectively. Intermediate locations (waypoints) are not supported when using supportingPoints.\n\nSetting at least one of minDeviationDistance or minDeviationTime to a value greater than zero has the following consequences:\n\n* The origin point of the calculateRoute request must be on (or very near) the input reference route. If this is not the case, an error is returned. However, the origin point does not need to be at the beginning of the input reference route (it can be thought of as the current vehicle position on the reference route).\n* The reference route, returned as the first route in the calculateRoute response, will start at the origin point specified in the calculateRoute request. The initial part of the input reference route up until the origin point will be excluded from the response.\n* The values of minDeviationDistance and minDeviationTime determine how far alternative routes will be guaranteed to follow the reference route from the origin point onwards.\n* The route must use departAt.\n* The vehicleHeading is ignored.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RouteDirectionsRequestBody" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RouteDirectionsResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/route/range/{format}": { + "get": { + "x-publish": true, + "description": "__Route Range (Isochrone) API__\n\n\n**Applies to**: S1 pricing tier.\n\nThis service will calculate a set of locations that can be reached from the origin point based on fuel, energy, time or distance budget that is specified. A polygon boundary (or Isochrone) is returned in a counterclockwise orientation as well as the precise polygon center which was the result of the origin point.\n\nThe returned polygon can be used for further processing such as [Search Inside Geometry](https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry) to search for POIs within the provided Isochrone.", + "operationId": "Route_GetRouteRange", + "x-ms-examples": { + "GetRouteRange": { + "$ref": "./examples/GetRouteRange.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TextFormat" + }, + { + "name": "query", + "in": "query", + "description": "The Coordinate from which the range calculation should start.", + "required": true, + "type": "string" + }, + { + "name": "fuelBudgetInLiters", + "in": "query", + "description": "Fuel budget in liters that determines maximal range which can be travelled using the specified Combustion Consumption Model.
When fuelBudgetInLiters is used, it is mandatory to specify a detailed Combustion Consumption Model.
Exactly one budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec, or distanceBudgetInMeters) must be used.", + "required": false, + "type": "number", + "format": "float" + }, + { + "name": "energyBudgetInkWh", + "in": "query", + "description": "Electric energy budget in kilowatt hours (kWh) that determines maximal range which can be travelled using the specified Electric Consumption Model.
When energyBudgetInkWh is used, it is mandatory to specify a detailed Electric Consumption Model.
Exactly one budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec, or distanceBudgetInMeters) must be used.", + "required": false, + "type": "number", + "format": "float" + }, + { + "name": "timeBudgetInSec", + "in": "query", + "description": "Time budget in seconds that determines maximal range which can be travelled using driving time. The Consumption Model will only affect the range when routeType is eco.
Exactly one budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec, or distanceBudgetInMeters) must be used.", + "required": false, + "type": "number", + "format": "float" + }, + { + "name": "distanceBudgetInMeters", + "in": "query", + "description": "Distance budget in meters that determines maximal range which can be travelled using driving distance. The Consumption Model will only affect the range when routeType is eco.
Exactly one budget (fuelBudgetInLiters, energyBudgetInkWh, timeBudgetInSec, or distanceBudgetInMeters) must be used.", + "required": false, + "type": "number", + "format": "float" + }, + { + "$ref": "#/parameters/DepartAt" + }, + { + "$ref": "#/parameters/RouteType" + }, + { + "$ref": "#/parameters/Traffic" + }, + { + "$ref": "#/parameters/Avoid" + }, + { + "$ref": "#/parameters/TravelMode" + }, + { + "$ref": "#/parameters/Hilliness" + }, + { + "$ref": "#/parameters/Windingness" + }, + { + "$ref": "#/parameters/VehicleAxleWeight" + }, + { + "$ref": "#/parameters/VehicleWidth" + }, + { + "$ref": "#/parameters/VehicleHeight" + }, + { + "$ref": "#/parameters/VehicleLength" + }, + { + "$ref": "#/parameters/VehicleMaxSpeed" + }, + { + "$ref": "#/parameters/VehicleWeight" + }, + { + "$ref": "#/parameters/VehicleCommercial" + }, + { + "$ref": "#/parameters/VehicleLoadType" + }, + { + "$ref": "#/parameters/VehicleEngineType" + }, + { + "$ref": "#/parameters/ConstantSpeedConsumptionInLitersPerHundredkm" + }, + { + "$ref": "#/parameters/CurrentFuelInLiters" + }, + { + "$ref": "#/parameters/AuxiliaryPowerInLitersPerHour" + }, + { + "$ref": "#/parameters/FuelEnergyDensityInMJoulesPerLiter" + }, + { + "$ref": "#/parameters/AccelerationEfficiency" + }, + { + "$ref": "#/parameters/DecelerationEfficiency" + }, + { + "$ref": "#/parameters/UphillEfficiency" + }, + { + "$ref": "#/parameters/DownhillEfficiency" + }, + { + "$ref": "#/parameters/ConstantSpeedConsumptionInkWhPerHundredkm" + }, + { + "$ref": "#/parameters/CurrentChargeInkWh" + }, + { + "$ref": "#/parameters/MaxChargeInkWh" + }, + { + "$ref": "#/parameters/AuxiliaryPowerInkW" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RouteRangeResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/route/directions/batch/{format}": { + "post": { + "x-publish": true, + "description": "**Route Directions Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Route Directions Batch API sends batches of queries to [Route Directions API](https://docs.microsoft.com/en-us/rest/api/maps/route/getroutedirections) using just a single API call. You can call Route Directions Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/route/directions/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex route requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **700** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Route Directions Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n``` GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0 ```\nNote:- Please remember to add AUTH information (subscription-key/azure_auth - See [Security](#security)) to the _status URI_ before running it.
\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _route directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 3 _route directions_ queries:\n\n\n```json\n{\n \"batchItems\": [\n { \"query\": \"?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false\" },\n { \"query\": \"?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest\" },\n { \"query\": \"?query=48.923159,-122.557362:32.621279,-116.840362\" }\n ]\n}\n```\n\nA _route directions_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _route directions_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/route/getroutedirections#uri-parameters). The string values in the _route directions_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **700** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirectionsResponse`](https://docs.microsoft.com/en-us/rest/api/maps/route/getroutedirections#routedirectionsresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "operationId": "Route_PostRouteDirectionsBatch", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "A Route Directions Batch API call containing 3 Route Directions API queries": { + "$ref": "./examples/PostRouteDirectionsBatch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "routeDirectionsBatchRequestBody", + "in": "body", + "description": "The list of route directions queries/requests to process. The list can contain a max of 700 queries for async and 100 queries for sync version and must contain at least 1 query.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchRequestBody" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BatchResponse" + } + }, + "202": { + "$ref": "#/responses/202Async" + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "produces": [ + "application/json" + ] + } + } + }, + "definitions": { + "ODataErrorResponse": { + "type": "object", + "description": "This response object is returned when an error occurs in the Maps API.", + "properties": { + "error": { + "$ref": "#/definitions/ODataError" + } + } + }, + "ODataError": { + "type": "object", + "description": "This object is returned when an error occurs in the Maps API.", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The ODataError code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + } + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the target causing the error." + } + } + }, + "Redirect": { + "type": "object", + "description": "This object is returned when the request is accepted but the processing has not been completed. The location header in the response contains the new URL to retry." + }, + "BatchResponse": { + "description": "This object is returned from a successful Batch service call", + "type": "object", + "properties": { + "summary": { + "description": "Summary for the batch request", + "type": "object", + "readOnly": true, + "properties": { + "successfulRequests": { + "description": "Number of successful requests in the batch", + "type": "integer", + "readOnly": true + }, + "totalRequests": { + "description": "Total number of requests in the batch", + "type": "integer", + "readOnly": true + } + } + }, + "batchItems": { + "description": "Array containing the batch results", + "type": "array", + "readOnly": true, + "items": { + "type": "object" + } + } + } + }, + "GeoJSONGeometry": { + "description": "A valid `GeoJSON` geometry object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1) for details.", + "type": "object", + "discriminator": "type", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "Specifies the `GeoJSON` geometry type. Must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection.", + "type": "string", + "enum": [ + "Point", + "MultiPoint", + "LineString", + "MultiLineString", + "Polygon", + "MultiPolygon", + "GeometryCollection" + ], + "x-ms-enum": { + "name": "GeoJSONGeometryType", + "modelAsString": false, + "values": [ + { + "value": "Point", + "description": "`GeoJSON Point` geometry." + }, + { + "value": "MultiPoint", + "description": "`GeoJSON MultiPoint` geometry." + }, + { + "value": "LineString", + "description": "`GeoJSON LineString` geometry." + }, + { + "value": "MultiLineString", + "description": "`GeoJSON MultiLineString` geometry." + }, + { + "value": "Polygon", + "description": "`GeoJSON Polygon` geometry." + }, + { + "value": "MultiPolygon", + "description": "`GeoJSON MultiPolygon` geometry." + }, + { + "value": "GeometryCollection", + "description": "`GeoJSON GeometryCollection` geometry." + } + ] + } + } + } + }, + "MultiPoint": { + "description": "A valid `GeoJSON MultiPoint` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.3) for details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJSONGeometry" + }, + { + "properties": { + "type": { + "description": "Specifies the `type` for the geometry. Value should always be equal to \"MultiPoint\".", + "type": "string" + }, + "coordinates": { + "description": "Coordinates for the `MultiPoint` geometry.", + "type": "array", + "items": { + "$ref": "#/definitions/GeoJSONPosition" + } + } + }, + "required": [ + "coordinates" + ] + } + ] + }, + "GeoJSONLinearRing": { + "description": "Though a linear ring is not explicitly represented as a GeoJSON geometry type, it helps in defining the polygon as an array of linear rings. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.6) for details.", + "type": "array", + "items": { + "$ref": "#/definitions/GeoJSONPosition" + } + }, + "GeoJSONPosition": { + "description": "A valid `GeoJSON Position` geometry type. A `Position` is an array of numbers with two or more elements. The first two elements are _longitude_ and _latitude_, precisely in that order. _Altitude/Elevation_ is an optional third element. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.1) for details.", + "type": "array", + "items": { + "type": "number", + "format": "double" + } + }, + "Point": { + "description": "A valid `GeoJSON Point` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.2) for details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJSONGeometry" + }, + { + "properties": { + "type": { + "description": "Specifies the `type` for the geometry. Value should always be equal to \"Point\".", + "type": "string" + }, + "coordinates": { + "$ref": "#/definitions/GeoJSONPosition" + } + }, + "required": [ + "coordinates" + ] + } + ] + }, + "MultiPolygon": { + "description": "A valid `GeoJSON MultiPolygon` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.7) for details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJSONGeometry" + }, + { + "properties": { + "type": { + "description": "Specifies the `type` for the object. Value should always be equal to \"MultiPolygon\".", + "type": "string" + }, + "coordinates": { + "description": "Contains a list of valid `GeoJSON` Polygon objects. **Note** that coordinates in GeoJSON are in x, y order (longitude, latitude).", + "type": "array", + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/GeoJSONLinearRing" + } + } + } + }, + "required": [ + "coordinates" + ] + } + ] + }, + "GeoJSONGeometryCollection": { + "description": "A valid `GeoJSON GeometryCollection` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.8) for details.", + "type": "object", + "properties": { + "type": { + "description": "Specifies the `type` for the object. Value should always be equal to \"GeometryCollection\".", + "type": "string" + }, + "geometries": { + "description": "Contains a list of valid `GeoJSON` geometry objects. **Note** that coordinates in GeoJSON are in x, y order (longitude, latitude).", + "type": "array", + "items": { + "$ref": "#/definitions/GeoJSONGeometry" + } + } + }, + "required": [ + "geometries" + ] + }, + "BatchRequestBody": { + "description": "This type represents the request body for the Batch service.", + "type": "object", + "properties": { + "batchItems": { + "description": "The list of queries/requests to process", + "type": "array", + "items": { + "description": "Batch Query object", + "type": "object", + "properties": { + "query": { + "description": "Partial query string", + "type": "string" + } + } + } + } + } + }, + "Coordinate": { + "description": "A location represented as a latitude and longitude.", + "type": "object", + "properties": { + "latitude": { + "description": "Latitude property", + "type": "number", + "format": "double", + "readOnly": true + }, + "longitude": { + "description": "Longitude property", + "type": "number", + "format": "double", + "readOnly": true + } + } + }, + "RouteDirectionsRequestBody": { + "type": "object", + "description": "Post body parameters for Route directions.", + "properties": { + "supportingPoints": { + "description": "A GeoJSON Geometry collection representing sequence of coordinates used as input for route reconstruction and for calculating zero or more alternative routes to this reference route.\n - The provided sequence of supporting points is used as input for route reconstruction.\n - The alternative routes are calculated between the origin and destination points specified in the base path parameter locations.\n - If both _minDeviationDistance_ and _minDeviationTime_ are set to zero, then these origin and destination points are\n expected to be at (or very near) the beginning and end of the reference route, respectively.\n - Intermediate locations (_waypoints_) are not supported when using <_supportingPoints_>.\n - The reference route may contain traffic incidents of type _ROAD_CLOSURE_, which are\n ignored for the calculation of the reference route's travel time and traffic delay.", + "allOf": [ + { + "$ref": "#/definitions/GeoJSONGeometryCollection" + }, + { + "properties": { + "geometries": { + "type": "array", + "items": { + "$ref": "#/definitions/Point" + } + } + } + } + ] + }, + "avoidVignette": { + "description": "This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided, e.g. \"AUS,CHE\". Toll roads with vignettes in countries not in the list are unaffected. Note: It is an error to specify both **avoidVignette** and **allowVignette**.", + "type": "array", + "items": { + "type": "string" + } + }, + "allowVignette": { + "description": "This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which toll roads with vignettes are allowed, e.g. \"AUS,CHE\". Specifying **allowVignette** with some countries X is equivalent to specifying **avoidVignette** with all countries but X. Specifying **allowVignette** with an empty list is the same as avoiding all toll roads with vignettes. Note: It is an error to specify both **avoidVignette** and **allowVignette**.", + "type": "array", + "items": { + "type": "string" + } + }, + "avoidAreas": { + "description": "A GeoJSON MultiPolygon representing list of areas to avoid. Only rectangle polygons are supported. The maximum size of a rectangle is about 160x160 km. Maximum number of avoided areas is **10**. It cannot cross the 180th meridian. It must be between -80 and +80 degrees of latitude.", + "$ref": "#/definitions/MultiPolygon" + } + } + }, + "RouteDirectionsResponse": { + "description": "This object is returned from a successful Route Directions call", + "type": "object", + "properties": { + "formatVersion": { + "description": "Format Version property", + "type": "string", + "readOnly": true + }, + "routes": { + "description": "Routes array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RouteDirectionsResult" + } + }, + "optimizedWaypoints": { + "description": "Optimized sequence of waypoints. It shows the index from the user provided waypoint sequence for the original and optimized list. For instance, a response: \n\n```\n\n\n\n\n\n```\n\nmeans that the original sequence is [0, 1, 2] and optimized sequence is [1, 2, 0]. Since the index starts by 0 the original is \"first, second, third\" while the optimized is \"second, third, first\".", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RouteOptimizedWaypoint" + } + }, + "report": { + "$ref": "#/definitions/RouteResponseReport" + } + } + }, + "RouteDirectionsResult": { + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/RouteDirectionsSummary" + }, + "legs": { + "description": "Legs array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RouteResultLeg" + } + }, + "sections": { + "description": "Sections array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RouteResultSection" + } + }, + "guidance": { + "$ref": "#/definitions/RouteResultGuidance" + } + } + }, + "RouteDirectionsSummary": { + "description": "Summary object", + "type": "object", + "readOnly": true, + "properties": { + "lengthInMeters": { + "description": "Length In Meters property", + "type": "integer", + "readOnly": true + }, + "travelTimeInSeconds": { + "description": "Estimated travel time in seconds property that includes the delay due to real-time traffic. Note that even when traffic=false travelTimeInSeconds still includes the delay due to traffic. If DepartAt is in the future, travel time is calculated using time-dependent historic traffic data.", + "type": "integer", + "readOnly": true + }, + "trafficDelayInSeconds": { + "description": "Estimated delay in seconds caused by the real-time incident(s) according to traffic information. For routes planned with departure time in the future, delays is always 0. To return additional travel times using different types of traffic information, parameter computeTravelTimeFor=all needs to be added.", + "type": "integer", + "readOnly": true + }, + "departureTime": { + "description": "Departure Time property", + "type": "string", + "readOnly": true + }, + "arrivalTime": { + "description": "Arrival Time property", + "type": "string", + "readOnly": true + } + } + }, + "RouteOptimizedWaypoint": { + "description": "Optimized way point object.", + "type": "object", + "properties": { + "providedIndex": { + "description": "Way point index provided by the user.", + "type": "integer", + "readOnly": true + }, + "optimizedIndex": { + "description": "Optimized way point index from the system.", + "type": "integer", + "readOnly": true + } + } + }, + "RouteResultLeg": { + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/RouteResultLegSummary" + }, + "points": { + "description": "Points array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Coordinate" + } + } + } + }, + "RouteResultLegSummary": { + "description": "Summary object for route section.", + "type": "object", + "readOnly": true, + "properties": { + "lengthInMeters": { + "description": "Length In Meters property", + "type": "integer", + "readOnly": true + }, + "travelTimeInSeconds": { + "description": "Estimated travel time in seconds property that includes the delay due to real-time traffic. Note that even when traffic=false travelTimeInSeconds still includes the delay due to traffic. If DepartAt is in the future, travel time is calculated using time-dependent historic traffic data.", + "type": "integer", + "readOnly": true + }, + "trafficDelayInSeconds": { + "description": "Estimated delay in seconds caused by the real-time incident(s) according to traffic information. For routes planned with departure time in the future, delays is always 0. To return additional travel times using different types of traffic information, parameter computeTravelTimeFor=all needs to be added.", + "type": "integer", + "readOnly": true + }, + "departureTime": { + "description": "Departure Time property", + "type": "string", + "readOnly": true + }, + "arrivalTime": { + "description": "Arrival Time property", + "type": "string", + "readOnly": true + }, + "noTrafficTravelTimeInSeconds": { + "description": "Estimated travel time calculated as if there are no delays on the route due to traffic conditions (e.g. congestion). Included only if computeTravelTimeFor = all is used in the query.", + "type": "integer", + "readOnly": true + }, + "historicTrafficTravelTimeInSeconds": { + "description": "Estimated travel time calculated using time-dependent historic traffic data. Included only if computeTravelTimeFor = all is used in the query.", + "type": "integer", + "readOnly": true + }, + "liveTrafficIncidentsTravelTimeInSeconds": { + "description": "Estimated travel time calculated using real-time speed data. Included only if computeTravelTimeFor = all is used in the query.", + "type": "integer", + "readOnly": true + }, + "fuelConsumptionInLiters": { + "description": "Estimated fuel consumption in liters using the Combustion Consumption Model. Included if vehicleEngineType is set to _combustion_ and constantSpeedConsumptionInLitersPerHundredkm is specified. The value will be non-negative.", + "type": "number", + "format": "float", + "readOnly": true + }, + "batteryConsumptionInkWh": { + "description": "Estimated electric energy consumption in kilowatt hours (kWh) using the Electric Consumption Model. Included if vehicleEngineType is set to electric and constantSpeedConsumptionInkWhPerHundredkm is specified. The value of batteryConsumptionInkWh includes the recuperated electric energy and can therefore be negative (which indicates gaining energy). If both maxChargeInkWh and currentChargeInkWh are specified, recuperation will be capped to ensure that the battery charge level never exceeds maxChargeInkWh. If neither maxChargeInkWh nor currentChargeInkWh are specified, unconstrained recuperation is assumed in the consumption calculation.", + "type": "number", + "format": "float", + "readOnly": true + } + } + }, + "RouteResultSection": { + "type": "object", + "properties": { + "startPointIndex": { + "description": "Start Point Index property", + "type": "integer", + "readOnly": true + }, + "endPointIndex": { + "description": "End Point Index property", + "type": "integer", + "readOnly": true + }, + "sectionType": { + "description": "Section Type property", + "type": "string", + "readOnly": true + }, + "travelMode": { + "description": "Travel Mode property", + "type": "string", + "readOnly": true + }, + "simpleCategory": { + "description": "Type of the incident. Can currently be JAM, ROAD_WORK, ROAD_CLOSURE, or OTHER. See \"tec\" for detailed information.", + "type": "string", + "readOnly": true + }, + "effectiveSpeedInKmh": { + "description": "Effective speed of the incident in km/h, averaged over its entire length.", + "type": "integer", + "readOnly": true + }, + "delayInSeconds": { + "description": "Delay in seconds caused by the incident.", + "type": "integer", + "readOnly": true + }, + "magnitudeOfDelay": { + "description": "The magnitude of delay caused by the incident. These values correspond to the values of the response field ty of the [Get Traffic Incident Detail API](https://docs.microsoft.com/rest/api/maps/traffic/gettrafficincidentdetail). ", + "readOnly": true, + "type": "string", + "enum": [ + "0", + "1", + "2", + "3", + "4" + ], + "x-ms-enum": { + "name": "MagnitudeOfDelay", + "modelAsString": false, + "values": [ + { + "value": "0", + "description": "Unknown." + }, + { + "value": "1", + "description": "Minor." + }, + { + "value": "2", + "description": "Moderate." + }, + { + "value": "3", + "description": "Major." + }, + { + "value": "4", + "description": "Undefined, used for road closures and other indefinite delays." + } + ] + } + }, + "tec": { + "$ref": "#/definitions/RouteResultSectionTec" + } + } + }, + "RouteResultSectionTec": { + "description": "Details of the traffic event, using definitions in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard. Can contain effectCode and causes elements.", + "type": "object", + "properties": { + "effectCode": { + "description": "The effect on the traffic flow. Contains a value in the tec001:EffectCode table, as defined in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard. Can be used to color-code traffic events according to severity.", + "type": "integer", + "readOnly": true + }, + "causes": { + "description": "Causes array", + "type": "array", + "items": { + "$ref": "#/definitions/RouteResultSectionTecCause" + } + } + } + }, + "RouteResultSectionTecCause": { + "description": "The cause of the traffic event. Can contain mainCauseCode and subCauseCode elements. Can be used to define iconography and descriptions.", + "type": "object", + "properties": { + "mainCauseCode": { + "description": "The main cause of the traffic event. Contains a value in the tec002:CauseCode table, as defined in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard.", + "type": "integer", + "readOnly": true + }, + "subCauseCode": { + "description": "The subcause of the traffic event. Contains a value in the sub cause table defined by the mainCauseCode, as defined in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard.", + "type": "integer", + "readOnly": true + } + } + }, + "RouteResultInstruction": { + "description": "A set of attributes describing a maneuver, e.g. 'Turn right', 'Keep left', 'Take the ferry', 'Take the motorway', 'Arrive'.", + "type": "object", + "properties": { + "routeOffsetInMeters": { + "description": "Distance from the start of the route to the point of the instruction.", + "type": "integer", + "readOnly": true + }, + "travelTimeInSeconds": { + "description": "Estimated travel time up to the point corresponding to routeOffsetInMeters.", + "type": "integer", + "readOnly": true + }, + "point": { + "$ref": "#/definitions/Coordinate" + }, + "pointIndex": { + "description": "The index of the point in the list of polyline \"points\" corresponding to the point of the instruction.", + "type": "integer", + "readOnly": true + }, + "instructionType": { + "description": "Type of the instruction, e.g., turn or change of road form.", + "type": "string", + "enum": [ + "TURN", + "ROAD_CHANGE", + "LOCATION_DEPARTURE", + "LOCATION_ARRIVAL", + "DIRECTION_INFO", + "LOCATION_WAYPOINT" + ], + "x-ms-enum": { + "name": "GuidanceInstructionType", + "modelAsString": false, + "values": [ + { + "value": "TURN", + "description": "Turn." + }, + { + "value": "ROAD_CHANGE", + "description": "Road Change." + }, + { + "value": "LOCATION_DEPARTURE", + "description": "Departure location." + }, + { + "value": "LOCATION_ARRIVAL", + "description": "Arrival location." + }, + { + "value": "DIRECTION_INFO", + "description": "Direction information." + }, + { + "value": "LOCATION_WAYPOINT", + "description": "Way point location." + } + ] + } + }, + "roadNumbers": { + "description": "The road number(s) of the next significant road segment(s) after the maneuver, or of the road(s) to be followed. Example: [\"E34\", \"N205\"]", + "type": "array", + "items": { + "type": "string", + "readOnly": true + }, + "readOnly": true + }, + "exitNumber": { + "description": "The number(s) of a highway exit taken by the current maneuver. If an exit has multiple exit numbers, they will be separated by \",\" and possibly aggregated by \"-\", e.g., \"10, 13-15\".", + "type": "string", + "readOnly": true + }, + "street": { + "description": "Street name of the next significant road segment after the maneuver, or of the street that should be followed.", + "type": "string", + "readOnly": true + }, + "signpostText": { + "description": "The text on a signpost which is most relevant to the maneuver, or to the direction that should be followed.", + "type": "string", + "readOnly": true + }, + "countryCode": { + "description": "3-character [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-3 country code. E.g. USA.", + "type": "string", + "readOnly": true + }, + "stateCode": { + "description": "A subdivision (e.g., state) of the country, represented by the second part of an [ISO 3166-2](https://www.iso.org/standard/63546.html) code. This is only available for some countries like the US, Canada, and Mexico.", + "type": "string", + "readOnly": true + }, + "junctionType": { + "description": "The type of the junction where the maneuver takes place. For larger roundabouts, two separate instructions are generated for entering and leaving the roundabout.", + "type": "string", + "readOnly": true, + "enum": [ + "REGULAR", + "ROUNDABOUT", + "BIFURCATION" + ], + "x-ms-enum": { + "name": "JunctionType", + "modelAsString": false, + "values": [ + { + "value": "REGULAR", + "description": "regular" + }, + { + "value": "ROUNDABOUT", + "description": "roundabout" + }, + { + "value": "BIFURCATION", + "description": "bifurcation" + } + ] + } + }, + "turnAngleInDecimalDegrees": { + "description": "Indicates the direction of an instruction. If junctionType indicates a turn instruction:\n\n * 180 = U-turn\n * [-179, -1] = Left turn\n * 0 = Straight on (a '0 degree' turn)\n * [1, 179] = Right turn\n\nIf junctionType indicates a bifurcation instruction:\n\n * <0 - keep left\n * \\>0 - keep right", + "type": "integer", + "readOnly": true + }, + "roundaboutExitNumber": { + "description": "This indicates which exit to take at a roundabout.", + "type": "string", + "readOnly": true + }, + "possibleCombineWithNext": { + "description": "It is possible to optionally combine the instruction with the next one. This can be used to build messages like \"Turn left and then turn right\".", + "type": "boolean", + "readOnly": true + }, + "drivingSide": { + "description": "Indicates left-hand vs. right-hand side driving at the point of the maneuver.", + "type": "string", + "readOnly": true, + "enum": [ + "LEFT", + "RIGHT" + ], + "x-ms-enum": { + "name": "DrivingSide", + "modelAsString": false, + "values": [ + { + "value": "LEFT", + "description": "Left side." + }, + { + "value": "RIGHT", + "description": "Right side." + } + ] + } + }, + "maneuver": { + "description": "A code identifying the maneuver.", + "type": "string", + "readOnly": true, + "enum": [ + "ARRIVE", + "ARRIVE_LEFT", + "ARRIVE_RIGHT", + "DEPART", + "STRAIGHT", + "KEEP_RIGHT", + "BEAR_RIGHT", + "TURN_RIGHT", + "SHARP_RIGHT", + "KEEP_LEFT", + "BEAR_LEFT", + "TURN_LEFT", + "SHARP_LEFT", + "MAKE_UTURN", + "ENTER_MOTORWAY", + "ENTER_FREEWAY", + "ENTER_HIGHWAY", + "TAKE_EXIT", + "MOTORWAY_EXIT_LEFT", + "MOTORWAY_EXIT_RIGHT", + "TAKE_FERRY", + "ROUNDABOUT_CROSS", + "ROUNDABOUT_RIGHT", + "ROUNDABOUT_LEFT", + "ROUNDABOUT_BACK", + "TRY_MAKE_UTURN", + "FOLLOW", + "SWITCH_PARALLEL_ROAD", + "SWITCH_MAIN_ROAD", + "ENTRANCE_RAMP", + "WAYPOINT_LEFT", + "WAYPOINT_RIGHT", + "WAYPOINT_REACHED" + ], + "x-ms-enum": { + "name": "GuidanceManeuver", + "modelAsString": false, + "values": [ + { + "value": "ARRIVE", + "description": "You have arrived." + }, + { + "value": "ARRIVE_LEFT", + "description": "You have arrived. Your destination is on the left." + }, + { + "value": "ARRIVE_RIGHT", + "description": "You have arrived. Your destination is on the right." + }, + { + "value": "DEPART", + "description": "Leave." + }, + { + "value": "STRAIGHT", + "description": "Keep straight on." + }, + { + "value": "KEEP_RIGHT", + "description": "Keep right." + }, + { + "value": "BEAR_RIGHT", + "description": "Bear right." + }, + { + "value": "TURN_RIGHT", + "description": "Turn right." + }, + { + "value": "SHARP_RIGHT", + "description": "Turn sharp right." + }, + { + "value": "KEEP_LEFT", + "description": "Keep left." + }, + { + "value": "BEAR_LEFT", + "description": "Bear left." + }, + { + "value": "TURN_LEFT", + "description": "Turn left." + }, + { + "value": "SHARP_LEFT", + "description": "Turn sharp left." + }, + { + "value": "MAKE_UTURN", + "description": "Make a U-turn." + }, + { + "value": "ENTER_MOTORWAY", + "description": "Take the motorway." + }, + { + "value": "ENTER_FREEWAY", + "description": "Take the freeway." + }, + { + "value": "ENTER_HIGHWAY", + "description": "Take the highway." + }, + { + "value": "TAKE_EXIT", + "description": "Take the exit." + }, + { + "value": "MOTORWAY_EXIT_LEFT", + "description": "Take the left exit." + }, + { + "value": "MOTORWAY_EXIT_RIGHT", + "description": "Take the right exit." + }, + { + "value": "TAKE_FERRY", + "description": "Take the ferry." + }, + { + "value": "ROUNDABOUT_CROSS", + "description": "Cross the roundabout." + }, + { + "value": "ROUNDABOUT_RIGHT", + "description": "At the roundabout take the exit on the right." + }, + { + "value": "ROUNDABOUT_LEFT", + "description": "At the roundabout take the exit on the left." + }, + { + "value": "ROUNDABOUT_BACK", + "description": "Go around the roundabout." + }, + { + "value": "TRY_MAKE_UTURN", + "description": "Try to make a U-turn." + }, + { + "value": "FOLLOW", + "description": "Follow." + }, + { + "value": "SWITCH_PARALLEL_ROAD", + "description": "Switch to the parallel road." + }, + { + "value": "SWITCH_MAIN_ROAD", + "description": "Switch to the main road." + }, + { + "value": "ENTRANCE_RAMP", + "description": "Take the ramp." + }, + { + "value": "WAYPOINT_LEFT", + "description": "You have reached the waypoint. It is on the left." + }, + { + "value": "WAYPOINT_RIGHT", + "description": "You have reached the waypoint. It is on the right." + }, + { + "value": "WAYPOINT_REACHED", + "description": "You have reached the waypoint." + } + ] + } + }, + "message": { + "description": "A human-readable message for the maneuver.", + "type": "string", + "readOnly": true + }, + "combinedMessage": { + "description": "A human-readable message for the maneuver combined with the message from the next instruction. Sometimes it is possible to combine two successive instructions into a single instruction making it easier to follow. When this is the case the possibleCombineWithNext flag will be true. For example:\n\n```\n10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam\n11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam\n```\n\nThe possibleCombineWithNext flag on instruction 10 is true. This indicates to the clients of coded guidance that it can be combined with instruction 11. The instructions will be combined automatically for clients requesting human-readable guidance. The combinedMessage field contains the combined message:\n\n```\nTurn left onto Einsteinweg/A10/E22 towards Ring Amsterdam\nthen follow Einsteinweg/A10/E22 towards Ring Amsterdam.\n```", + "type": "string", + "readOnly": true + } + } + }, + "RouteResultInstructionGroup": { + "description": "Groups a sequence of instruction elements which are related to each other. The sequence range is constrained with firstInstructionIndex and lastInstructionIndex. When human-readable text messages are requested for guidance (instructionType=text or tagged), then the instructionGroup has a summary message returned when available.", + "type": "object", + "properties": { + "firstInstructionIndex": { + "description": "Index of the first instruction.", + "type": "integer", + "readOnly": true + }, + "lastInstructionIndex": { + "description": "Index of the last instruction.", + "type": "integer", + "readOnly": true + }, + "groupLengthInMeters": { + "description": "Length of the group.", + "type": "integer", + "readOnly": true + }, + "groupMessage": { + "description": "Summary message when human-readable text messages are requested for guidance (instructionType=text or tagged).", + "type": "string", + "readOnly": true + } + } + }, + "RouteResultGuidance": { + "description": "Contains guidance related elements. This field is present only when guidance was requested and is available.", + "type": "object", + "readOnly": true, + "properties": { + "instructions": { + "description": "A list of instructions describing maneuvers.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RouteResultInstruction" + } + }, + "instructionGroups": { + "description": "Groups a sequence of instruction elements which are related to each other.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RouteResultInstructionGroup" + } + } + } + }, + "RouteRangeResponse": { + "description": "This object is returned from a successful Route Reachable Range call", + "type": "object", + "properties": { + "formatVersion": { + "description": "Format Version property", + "type": "string", + "readOnly": true + }, + "reachableRange": { + "$ref": "#/definitions/RouteRange" + }, + "report": { + "$ref": "#/definitions/RouteResponseReport" + } + } + }, + "RouteRange": { + "description": "Reachable Range", + "type": "object", + "properties": { + "center": { + "description": "Center point of the reachable range", + "$ref": "#/definitions/Coordinate" + }, + "boundary": { + "description": "Polygon boundary of the reachable range represented as a list of points.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Coordinate" + } + } + } + }, + "RouteResponseReport": { + "description": "Reports the effective settings used in the current call.", + "type": "object", + "properties": { + "effectiveSettings": { + "description": "Effective parameters or data used when calling this Route API.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RouteResponseReportEffectiveSetting" + } + } + } + }, + "RouteResponseReportEffectiveSetting": { + "description": "Effective parameter or data used when calling this Route API.", + "type": "object", + "properties": { + "key": { + "description": "Name of the parameter used.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Value of the parameter used.", + "type": "string", + "readOnly": true + } + } + }, + "RouteMatrixResponse": { + "description": "This object is returned from a successful Route Matrix call. For ex, if 2 origins and 3 destinations are provided, there are going to 2 arrays with 3 elements in each. Each element's content depends on the options provided in the query.", + "type": "object", + "properties": { + "formatVersion": { + "description": "Format Version property", + "type": "string", + "readOnly": true + }, + "matrix": { + "description": "Results as a 2 dimensional array of route summaries.", + "type": "array", + "readOnly": true, + "items": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RouteMatrixResult" + } + } + }, + "summary": { + "$ref": "#/definitions/RouteMatrixSummary" + } + } + }, + "RouteMatrixSummary": { + "description": "Summary object", + "type": "object", + "readOnly": true, + "properties": { + "successfulRoutes": { + "description": "Number of successful routes in the response.", + "type": "integer", + "readOnly": true + }, + "totalRoutes": { + "description": "Total number of routes requested. Number of cells in the input matrix.", + "type": "integer", + "readOnly": true + } + } + }, + "RouteMatrixResult": { + "description": "Matrix result object", + "type": "object", + "readOnly": true, + "properties": { + "statusCode": { + "description": "StatusCode property for the current cell in the input matrix.", + "type": "integer", + "readOnly": true + }, + "response": { + "$ref": "#/definitions/RouteMatrixResultResponse" + } + } + }, + "RouteMatrixResultResponse": { + "description": "Response object of the current cell in the input matrix.", + "type": "object", + "readOnly": true, + "properties": { + "routeSummary": { + "$ref": "#/definitions/RouteResultLegSummary" + } + } + }, + "RouteMatrixRequestBody": { + "description": "An object with a matrix of coordinates.", + "type": "object", + "properties": { + "origins": { + "$ref": "#/definitions/MultiPoint" + }, + "destinations": { + "$ref": "#/definitions/MultiPoint" + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetPOICategoryTree.json b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetPOICategoryTree.json new file mode 100644 index 000000000000..1a1114c83bc7 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetPOICategoryTree.json @@ -0,0 +1,252 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "poiCategories": [ + { + "id": 7320, + "name": "Sports Center", + "childCategoryIds": [ + 7320002, + 7320003, + 7320005 + ], + "synonyms": [ + "Gym", + "Indoors Sports", + "Sports Centre" + ] + }, + { + "id": 7374, + "name": "Stadium", + "childCategoryIds": [ + 7374002, + 7374009, + 7374012, + 7374003, + 7374010, + 7374005, + 7374008, + 7374011, + 7374006, + 7374014, + 7374013, + 7374007, + 7374004 + ], + "synonyms": [ + "Arena", + "Gymnasium", + "Sports Ground", + "Sports Stadium" + ] + }, + { + "id": 7315, + "name": "Restaurant", + "childCategoryIds": [ + 7315081, + 7315002, + 7315082, + 7315003, + 7315083, + 7315084, + 7315085, + 7315062, + 7315086, + 7315004, + 7315146, + 7315005, + 7315087, + 7315006, + 7315007, + 7315088, + 7315089, + 7315072, + 7315008, + 7315142, + 7315090, + 7315091, + 7315147, + 7315009, + 7315092, + 7315010, + 7315011, + 7315070, + 7315093, + 7315012, + 7315094, + 7315095, + 7315063, + 7315013, + 7315096, + 7315097, + 7315068, + 7315098, + 7315099, + 7315057, + 7315079, + 7315014, + 7315100, + 7315101, + 7315132, + 7315102, + 7315133, + 7315015, + 7315016, + 7315104, + 7315134, + 7315017, + 7315071, + 7315018, + 7315019, + 7315020, + 7315054, + 7315069, + 7315021, + 7315058, + 7315052, + 7315022, + 7315078, + 7315023, + 7315024, + 7315073, + 7315105, + 7315065, + 7315106, + 7315025, + 7315066, + 7315026, + 7315027, + 7315028, + 7315067, + 7315029, + 7315030, + 7315107, + 7315135, + 7315108, + 7315031, + 7315109, + 7315032, + 7315033, + 7315034, + 7315110, + 7315074, + 7315136, + 7315111, + 7315112, + 7315075, + 7315035, + 7315127, + 7315061, + 7315036, + 7315037, + 7315129, + 7315038, + 7315130, + 7315039, + 7315041, + 7315131, + 7315040, + 7315143, + 7315042, + 7315113, + 7315114, + 7315115, + 7315043, + 7315053, + 7315055, + 7315056, + 7315116, + 7315117, + 7315080, + 7315139, + 7315064, + 7315140, + 7315044, + 7315045, + 7315118, + 7315046, + 7315148, + 7315119, + 7315047, + 7315120, + 7315059, + 7315145, + 7315076, + 7315121, + 7315048, + 7315122, + 7315123, + 7315049, + 7315124, + 7315050, + 7315125, + 7315051, + 7315126, + 7315060, + 7315149 + ], + "synonyms": [ + "Dining", + "Eatery", + "Eating House", + "Eating Place" + ] + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchAddress.json b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchAddress.json new file mode 100644 index 000000000000..25f04a4c64ec --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchAddress.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "query": "15127 NE 24th Street, Redmond, WA 98052", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "summary": { + "query": "15127 NE 24th Street, Redmond, WA 98052", + "queryType": "NON_NEAR", + "queryTime": 58, + "numResults": 1, + "offset": 0, + "totalResults": 1, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "Point Address", + "id": "US/PAD/p0/19173426", + "score": 14.51, + "address": { + "streetNumber": "15127", + "streetName": "NE 24th St", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond, Adelaide, Ames Lake, Avondale, Earlmount", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980525544", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "15127 NE 24th St, Redmond, WA 980525544", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.6308, + "lon": -122.1385 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.6317, + "lon": -122.13983 + }, + "btmRightPoint": { + "lat": 47.6299, + "lon": -122.13717 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.6315, + "lon": -122.13852 + } + } + ] + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchAddressReverse.json b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchAddressReverse.json new file mode 100644 index 000000000000..097316bfd647 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchAddressReverse.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "query": "37.337,-121.89", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "summary": { + "queryTime": 5, + "numResults": 1 + }, + "addresses": [ + { + "address": { + "buildingNumber": "31", + "streetNumber": "31", + "routeNumbers": [], + "street": "N 2nd St", + "streetName": "N 2nd St", + "streetNameAndNumber": "31 N 2nd St", + "countryCode": "US", + "countrySubdivision": "CA", + "countrySubdivisionName": "California", + "municipality": "San Jose", + "postalCode": "95113", + "country": "United States of America", + "countryCodeISO3": "USA", + "freeformAddress": "31 N 2nd St, San Jose CA 95113", + "extendedPostalCode": "951131217" + }, + "position": "37.337090,-121.889820" + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchAddressReverseCrossStreet.json b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchAddressReverseCrossStreet.json new file mode 100644 index 000000000000..762140c8db64 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchAddressReverseCrossStreet.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "query": "37.337,-121.89", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "summary": { + "numResults": 1, + "queryTime": 41 + }, + "addresses": [ + { + "address": { + "streetName": "East Santa Clara Street & North 2nd Street", + "crossStreet": "East Santa Clara Street", + "municipalitySubdivision": "San Jose, Downtown San Jose", + "municipality": "San Jose", + "countrySecondarySubdivision": "Santa Clara", + "countryTertiarySubdivision": "San Jose", + "countrySubdivision": "CA", + "postalCode": "95113", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "East Santa Clara Street & North 2nd Street, San Jose, CA 95113", + "countrySubdivisionName": "California", + "street": "North 2nd Street" + }, + "position": "37.33666,-121.88951" + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchAddressStructured.json b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchAddressStructured.json new file mode 100644 index 000000000000..666e45fb7327 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchAddressStructured.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "countryCode": "US", + "streetName": "NE%2024th%20Street", + "streetNumber": "15127", + "municipality": "Redmond", + "countrySubdivision": "WA", + "postalCode": "98052", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "summary": { + "query": "15127 98052 ne redmond wa", + "queryType": "NON_NEAR", + "queryTime": 57, + "numResults": 1, + "offset": 0, + "totalResults": 34, + "fuzzyLevel": 1, + "geoBias": { + "lat": 47.30129317913035, + "lon": -120.88247999999997 + } + }, + "results": [ + { + "type": "Point Address", + "id": "US/PAD/p0/37974392", + "score": 8.074, + "dist": 101274.64693865852, + "address": { + "streetNumber": "15127", + "streetName": "NE 24th St", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond, Earlmount, Avondale, Ames Lake, Adelaide", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980525544", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "15127 NE 24th St, Redmond, WA 98052", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.6308, + "lon": -122.1385 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.6317, + "lon": -122.13983 + }, + "btmRightPoint": { + "lat": 47.6299, + "lon": -122.13717 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.6315, + "lon": -122.13852 + } + } + ] + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchFuzzy.json b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchFuzzy.json new file mode 100644 index 000000000000..1fbb11c89ff5 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchFuzzy.json @@ -0,0 +1,703 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "query": "seattle", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "summary": { + "query": "seattle", + "queryType": "NON_NEAR", + "queryTime": 66, + "numResults": 10, + "offset": 0, + "totalResults": 3720, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "Geography", + "id": "US/GEO/p0/188055", + "score": 2.531, + "entityType": "Municipality", + "address": { + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "Seattle, WA", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.60323, + "lon": -122.33028 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.7344, + "lon": -122.4594 + }, + "btmRightPoint": { + "lat": 47.48106, + "lon": -122.22497 + } + }, + "dataSources": { + "geometry": { + "id": "00005557-4100-3c00-0000-0000596ae8ed" + } + } + }, + { + "type": "Geography", + "id": "US/GEO/p0/183911", + "score": 2.382, + "entityType": "Municipality", + "address": { + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countrySubdivision": "WA", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "Seattle, WA", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.55342, + "lon": -122.25007 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.58995, + "lon": -122.26723 + }, + "btmRightPoint": { + "lat": 47.5169, + "lon": -122.23291 + } + }, + "dataSources": { + "geometry": { + "id": "00005557-4100-3c00-0000-00006553f33d" + } + } + }, + { + "type": "POI", + "id": "ZA/POI/p0/449288", + "score": 2.226, + "info": "search:ta:710009004165863-ZA", + "poi": { + "name": "Seattle Coffee Co - Groote Kerk Sentrum", + "brands": [ + { + "name": "Seattle Coffee Company" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.seattlecoffeecompany.co.za", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetName": "Kloof Street", + "municipalitySubdivision": "Cape Town", + "municipality": "Cape Town", + "countrySecondarySubdivision": "City of Cape Town", + "countrySubdivision": "Western Cape", + "postalCode": "8001", + "countryCode": "ZA", + "country": "South Africa", + "countryCodeISO3": "ZAF", + "freeformAddress": "Kloof Street, Gardens, City of Cape Town, Western Cape, 8001", + "localName": "Gardens" + }, + "position": { + "lat": -33.92917, + "lon": 18.41178 + }, + "viewport": { + "topLeftPoint": { + "lat": -33.92827, + "lon": 18.4107 + }, + "btmRightPoint": { + "lat": -33.93007, + "lon": 18.41286 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": -33.92907, + "lon": 18.41162 + } + } + ] + }, + { + "type": "POI", + "id": "ZA/POI/p0/449396", + "score": 2.226, + "info": "search:ta:710009004163591-ZA", + "poi": { + "name": "Seattle Coffee Co - Pietermaritzburg", + "phone": "+(27)-(33)-3458486", + "brands": [ + { + "name": "Seattle Coffee Company" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.seattlecoffeecompany.co.za", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "9", + "streetName": "Armitage Road", + "municipalitySubdivision": "Pietermaritzburg City, Pietermaritzburg", + "municipality": "Pietermaritzburg", + "countrySecondarySubdivision": "The Msunduzi", + "countrySubdivision": "KwaZulu-Natal", + "postalCode": "3201", + "countryCode": "ZA", + "country": "South Africa", + "countryCodeISO3": "ZAF", + "freeformAddress": "Armitage Road 9, Athlone, The Msunduzi, KwaZulu-Natal, 3201", + "localName": "Athlone" + }, + "position": { + "lat": -29.58611, + "lon": 30.37508 + }, + "viewport": { + "topLeftPoint": { + "lat": -29.58521, + "lon": 30.37405 + }, + "btmRightPoint": { + "lat": -29.58701, + "lon": 30.37611 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": -29.58668, + "lon": 30.37531 + } + } + ] + }, + { + "type": "POI", + "id": "ZA/POI/p0/451868", + "score": 2.226, + "info": "search:ta:710009002195538-ZA", + "poi": { + "name": "Seattle Coffee Co - Bedford Village", + "phone": "+(27)-(84)-5451111", + "brands": [ + { + "name": "Seattle Coffee Company" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.seattlecoffeecompany.co.za", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetName": "Van Buuren Road", + "municipalitySubdivision": "Bedfordview", + "municipality": "Germiston", + "countrySecondarySubdivision": "Ekurhuleni", + "countrySubdivision": "Gauteng", + "postalCode": "2007", + "countryCode": "ZA", + "country": "South Africa", + "countryCodeISO3": "ZAF", + "freeformAddress": "Van Buuren Road, Bedfordview, Ekurhuleni, Gauteng, 2007", + "localName": "Bedfordview" + }, + "position": { + "lat": -26.18009, + "lon": 28.13544 + }, + "viewport": { + "topLeftPoint": { + "lat": -26.17919, + "lon": 28.13444 + }, + "btmRightPoint": { + "lat": -26.18099, + "lon": 28.13644 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": -26.18006, + "lon": 28.13636 + } + } + ] + }, + { + "type": "POI", + "id": "ZA/POI/p0/488888", + "score": 2.226, + "info": "search:ta:710009002102639-ZA", + "poi": { + "name": "Seattle Coffee Co - Caltex Starstop Milly's", + "phone": "+(27)-(13)-2560340", + "brands": [ + { + "name": "Seattle Coffee Company" + } + ], + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "municipality": "Wonderfontein", + "countrySecondarySubdivision": "Emakhazeni", + "countrySubdivision": "Mpumalanga", + "countryCode": "ZA", + "country": "South Africa", + "countryCodeISO3": "ZAF", + "freeformAddress": "Wonderfontein, Emakhazeni, Mpumalanga" + }, + "position": { + "lat": -25.68842, + "lon": 30.21291 + }, + "viewport": { + "topLeftPoint": { + "lat": -25.68752, + "lon": 30.21191 + }, + "btmRightPoint": { + "lat": -25.68932, + "lon": 30.21391 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": -25.68913, + "lon": 30.21343 + } + } + ] + }, + { + "type": "POI", + "id": "ZA/POI/p0/489433", + "score": 2.226, + "info": "search:ta:710009002184068-ZA", + "poi": { + "name": "Seattle Coffee Co - Southcoast Mall", + "phone": "+(27)-(39)-3150816", + "brands": [ + { + "name": "Seattle Coffee Company" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.seattlecoffeecompany.co.za", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "municipalitySubdivision": "Shelly Beach", + "municipality": "Shelly Beach", + "countrySecondarySubdivision": "Hibiscus Coast", + "countrySubdivision": "KwaZulu-Natal", + "postalCode": "4265", + "countryCode": "ZA", + "country": "South Africa", + "countryCodeISO3": "ZAF", + "freeformAddress": "Shelly Beach, Hibiscus Coast, KwaZulu-Natal, 4265", + "localName": "Shelly Beach" + }, + "position": { + "lat": -30.79937, + "lon": 30.40569 + }, + "viewport": { + "topLeftPoint": { + "lat": -30.79847, + "lon": 30.40464 + }, + "btmRightPoint": { + "lat": -30.80027, + "lon": 30.40674 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": -30.7994, + "lon": 30.40618 + } + } + ] + }, + { + "type": "POI", + "id": "ZA/POI/p0/489976", + "score": 2.226, + "info": "search:ta:710009004261897-ZA", + "poi": { + "name": "Seattle Cofee Co", + "phone": "+(27)-(39)-3150816", + "brands": [ + { + "name": "Seattle Coffee Company" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.seattlecoffeecompany.co.za", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "municipalitySubdivision": "Shelly Beach", + "municipality": "Shelly Beach", + "countrySecondarySubdivision": "Hibiscus Coast", + "countrySubdivision": "KwaZulu-Natal", + "postalCode": "4265", + "countryCode": "ZA", + "country": "South Africa", + "countryCodeISO3": "ZAF", + "freeformAddress": "Shelly Beach, Hibiscus Coast, KwaZulu-Natal, 4265", + "localName": "Shelly Beach" + }, + "position": { + "lat": -30.79801, + "lon": 30.40557 + }, + "viewport": { + "topLeftPoint": { + "lat": -30.79711, + "lon": 30.40452 + }, + "btmRightPoint": { + "lat": -30.79891, + "lon": 30.40662 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": -30.79784, + "lon": 30.40523 + } + } + ] + }, + { + "type": "POI", + "id": "ZA/POI/p0/490056", + "score": 2.226, + "info": "search:ta:710009004149612-ZA", + "poi": { + "name": "Seattle Coffee Co - Constantia Village", + "brands": [ + { + "name": "Seattle Coffee Company" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.seattlecoffeecompany.co.za", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetName": "Constantia Main Road", + "municipalitySubdivision": "Cape Town", + "municipality": "Cape Town", + "countrySecondarySubdivision": "City of Cape Town", + "countrySubdivision": "Western Cape", + "postalCode": "7708", + "countryCode": "ZA", + "country": "South Africa", + "countryCodeISO3": "ZAF", + "freeformAddress": "Constantia Main Road, Constantia, City of Cape Town, Western Cape, 7708", + "localName": "Constantia" + }, + "position": { + "lat": -34.02087, + "lon": 18.44503 + }, + "viewport": { + "topLeftPoint": { + "lat": -34.01997, + "lon": 18.44394 + }, + "btmRightPoint": { + "lat": -34.02177, + "lon": 18.44612 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": -34.02017, + "lon": 18.44476 + } + } + ] + }, + { + "type": "POI", + "id": "ZA/POI/p0/494340", + "score": 2.226, + "info": "search:ta:710009004152570-ZA", + "poi": { + "name": "Seattle Coffee Co - Canal Walk Shopping Centre", + "brands": [ + { + "name": "Seattle Coffee Company" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.seattlecoffeecompany.co.za", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetName": "Century Boulevard", + "municipalitySubdivision": "Milnerton", + "municipality": "Cape Town", + "countrySecondarySubdivision": "City of Cape Town", + "countrySubdivision": "Western Cape", + "postalCode": "7441", + "countryCode": "ZA", + "country": "South Africa", + "countryCodeISO3": "ZAF", + "freeformAddress": "Century Boulevard, Century City, City of Cape Town, Western Cape, 7441", + "localName": "Century City" + }, + "position": { + "lat": -33.89348, + "lon": 18.5122 + }, + "viewport": { + "topLeftPoint": { + "lat": -33.89258, + "lon": 18.51112 + }, + "btmRightPoint": { + "lat": -33.89438, + "lon": 18.51328 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": -33.8943, + "lon": 18.51328 + } + } + ] + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchNearby.json b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchNearby.json new file mode 100644 index 000000000000..ceae81b5d908 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchNearby.json @@ -0,0 +1,763 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "lat": 40.706270, + "lon": -74.011454, + "radius": 8046, + "limit": 10, + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "summary": { + "queryType": "NEARBY", + "queryTime": 137, + "numResults": 10, + "offset": 0, + "totalResults": 256620, + "fuzzyLevel": 1, + "geoBias": { + "lat": 40.70627, + "lon": -74.011454 + } + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p1/7652731", + "score": 1, + "dist": 14.736843483489132, + "info": "search:ta:840369002225435-US", + "poi": { + "name": "Ycd Multimedia", + "phone": "+(1)-(212)-5091049", + "categorySet": [ + { + "id": 9152 + } + ], + "classifications": [ + { + "code": "NON_GOVERNMENTAL_ORGANIZATION", + "names": [ + { + "nameLocale": "en-US", + "name": "non governmental organization" + } + ] + } + ] + }, + "address": { + "streetNumber": "55", + "streetName": "Exchange Pl", + "municipalitySubdivision": "New York City, NYC, New York, Financial District", + "municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "extendedPostalCode": "100042320", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "55 Exchange Pl, New York, NY 10004", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.7064, + "lon": -74.01142 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.7073, + "lon": -74.01261 + }, + "btmRightPoint": { + "lat": 40.7055, + "lon": -74.01023 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.70636, + "lon": -74.01145 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/7652732", + "score": 1, + "dist": 14.736843483489132, + "info": "search:ta:840369001882610-US", + "poi": { + "name": "Grubb & Ellis Management Services", + "phone": "+(1)-(212)-7851619", + "categorySet": [ + { + "id": 9352039 + } + ], + "classifications": [ + { + "code": "COMPANY", + "names": [ + { + "nameLocale": "en-US", + "name": "company" + }, + { + "nameLocale": "en-US", + "name": "services" + } + ] + } + ] + }, + "address": { + "streetNumber": "55", + "streetName": "Exchange Pl", + "municipalitySubdivision": "New York City, NYC, New York, Financial District", + "municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "extendedPostalCode": "100042320", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "55 Exchange Pl, New York, NY 10004", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.7064, + "lon": -74.01142 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.7073, + "lon": -74.01261 + }, + "btmRightPoint": { + "lat": 40.7055, + "lon": -74.01023 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.70636, + "lon": -74.01145 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/7652735", + "score": 1, + "dist": 14.736843483489132, + "info": "search:ta:840369001322824-US", + "poi": { + "name": "Hispanic Federation", + "phone": "+(1)-(212)-7420480", + "categorySet": [ + { + "id": 9910004 + } + ], + "url": "Hispanicfederation.org", + "classifications": [ + { + "code": "AUTOMOTIVE_DEALER", + "names": [ + { + "nameLocale": "en-US", + "name": "boat" + }, + { + "nameLocale": "en-US", + "name": "automotive dealer" + } + ] + } + ] + }, + "address": { + "streetNumber": "55", + "streetName": "Exchange Pl", + "municipalitySubdivision": "New York City, NYC, New York, Financial District", + "municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "extendedPostalCode": "100042320", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "55 Exchange Pl, New York, NY 10004", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.7064, + "lon": -74.01142 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.7073, + "lon": -74.01261 + }, + "btmRightPoint": { + "lat": 40.7055, + "lon": -74.01023 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.70636, + "lon": -74.01145 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/7652736", + "score": 1, + "dist": 14.736843483489132, + "info": "search:ta:840369000631230-US", + "poi": { + "name": "Edwin Gould Foundation", + "phone": "+(1)-(212)-9825200", + "categorySet": [ + { + "id": 9152 + } + ], + "url": "edwingouldfoundation.org", + "classifications": [ + { + "code": "NON_GOVERNMENTAL_ORGANIZATION", + "names": [ + { + "nameLocale": "en-US", + "name": "non governmental organization" + } + ] + } + ] + }, + "address": { + "streetNumber": "55", + "streetName": "Exchange Pl", + "municipalitySubdivision": "New York City, NYC, New York, Financial District", + "municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "extendedPostalCode": "100042320", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "55 Exchange Pl, New York, NY 10004", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.7064, + "lon": -74.01142 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.7073, + "lon": -74.01261 + }, + "btmRightPoint": { + "lat": 40.7055, + "lon": -74.01023 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.70636, + "lon": -74.01145 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/7652737", + "score": 1, + "dist": 14.736843483489132, + "info": "search:ta:840369001196585-US", + "poi": { + "name": "Newmark Grubb Knight Frank", + "phone": "+(1)-(646)-6951990", + "categorySet": [ + { + "id": 9361015 + } + ], + "url": "www.newmarkkf.com", + "classifications": [ + { + "code": "SHOP", + "names": [ + { + "nameLocale": "en-US", + "name": "shop" + }, + { + "nameLocale": "en-US", + "name": "real estate agents" + } + ] + } + ] + }, + "address": { + "streetNumber": "55", + "streetName": "Exchange Pl", + "municipalitySubdivision": "New York City, NYC, New York, Financial District", + "municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "extendedPostalCode": "100042320", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "55 Exchange Pl, New York, NY 10004", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.7064, + "lon": -74.01142 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.7073, + "lon": -74.01261 + }, + "btmRightPoint": { + "lat": 40.7055, + "lon": -74.01023 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.70636, + "lon": -74.01145 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/7652738", + "score": 1, + "dist": 14.736843483489132, + "info": "search:ta:840369002164164-US", + "poi": { + "name": "Sponsors For Educational Opportunity", + "phone": "+(1)-(212)-7851361", + "categorySet": [ + { + "id": 9152 + } + ], + "url": "www.seo-usa.org", + "classifications": [ + { + "code": "NON_GOVERNMENTAL_ORGANIZATION", + "names": [ + { + "nameLocale": "en-US", + "name": "non governmental organization" + } + ] + } + ] + }, + "address": { + "streetNumber": "55", + "streetName": "Exchange Pl", + "municipalitySubdivision": "New York City, NYC, New York, Financial District", + "municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "extendedPostalCode": "100042320", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "55 Exchange Pl, New York, NY 10004", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.7064, + "lon": -74.01142 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.7073, + "lon": -74.01261 + }, + "btmRightPoint": { + "lat": 40.7055, + "lon": -74.01023 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.70636, + "lon": -74.01145 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/7373205", + "score": 1, + "dist": 14.736843483489132, + "info": "search:ta:840361001736646-US", + "poi": { + "name": "Visiting Nurse Service", + "phone": "+(1)-(212)-7428259", + "categorySet": [ + { + "id": 9663 + } + ], + "url": "www.vnsny.org", + "classifications": [ + { + "code": "HEALTH_CARE_SERVICE", + "names": [ + { + "nameLocale": "en-US", + "name": "health care service" + } + ] + } + ] + }, + "address": { + "streetNumber": "55", + "streetName": "Exchange Pl", + "municipalitySubdivision": "New York City, NYC, New York, Financial District", + "municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "extendedPostalCode": "100042320", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "55 Exchange Pl, New York, NY 10004", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.7064, + "lon": -74.01142 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.7073, + "lon": -74.01261 + }, + "btmRightPoint": { + "lat": 40.7055, + "lon": -74.01023 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.70636, + "lon": -74.01145 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/7373206", + "score": 1, + "dist": 14.736843483489132, + "info": "search:ta:840361001326915-US", + "poi": { + "name": "Hispanic In Philanthropy", + "phone": "+(1)-(646)-2777101", + "categorySet": [ + { + "id": 9152 + } + ], + "url": "www.hiponline.org", + "classifications": [ + { + "code": "NON_GOVERNMENTAL_ORGANIZATION", + "names": [ + { + "nameLocale": "en-US", + "name": "non governmental organization" + } + ] + } + ] + }, + "address": { + "streetNumber": "55", + "streetName": "Exchange Pl", + "municipalitySubdivision": "New York City, NYC, New York, Financial District", + "municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "extendedPostalCode": "100042320", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "55 Exchange Pl, New York, NY 10004", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.7064, + "lon": -74.01142 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.7073, + "lon": -74.01261 + }, + "btmRightPoint": { + "lat": 40.7055, + "lon": -74.01023 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.70636, + "lon": -74.01145 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/7373207", + "score": 1, + "dist": 14.736843483489132, + "info": "search:ta:840369002316633-US", + "poi": { + "name": "Advantage Technical Resourcing", + "phone": "+(1)-(212)-2691140", + "categorySet": [ + { + "id": 9352039 + } + ], + "classifications": [ + { + "code": "COMPANY", + "names": [ + { + "nameLocale": "en-US", + "name": "company" + }, + { + "nameLocale": "en-US", + "name": "services" + } + ] + } + ] + }, + "address": { + "streetNumber": "55", + "streetName": "Exchange Pl", + "municipalitySubdivision": "New York City, NYC, New York, Financial District", + "municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "extendedPostalCode": "100042320", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "55 Exchange Pl, New York, NY 10004", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.7064, + "lon": -74.01142 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.7073, + "lon": -74.01261 + }, + "btmRightPoint": { + "lat": 40.7055, + "lon": -74.01023 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.70636, + "lon": -74.01145 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/7373208", + "score": 1, + "dist": 14.736843483489132, + "info": "search:ta:840369002031974-US", + "poi": { + "name": "Workshop In Bus Opportunities", + "phone": "+(1)-(212)-6840854", + "categorySet": [ + { + "id": 9352039 + } + ], + "url": "www.wibo.org", + "classifications": [ + { + "code": "COMPANY", + "names": [ + { + "nameLocale": "en-US", + "name": "company" + }, + { + "nameLocale": "en-US", + "name": "services" + } + ] + } + ] + }, + "address": { + "streetNumber": "55", + "streetName": "Exchange Pl", + "municipalitySubdivision": "New York City, NYC, New York, Financial District", + "municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "extendedPostalCode": "100042320", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "55 Exchange Pl, New York, NY 10004", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.7064, + "lon": -74.01142 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.7073, + "lon": -74.01261 + }, + "btmRightPoint": { + "lat": 40.7055, + "lon": -74.01023 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.70636, + "lon": -74.01145 + } + } + ] + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchPOI.json b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchPOI.json new file mode 100644 index 000000000000..308853a33a68 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchPOI.json @@ -0,0 +1,457 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "query": "juice bars", + "subscription-key": "[subscription-key]", + "limit": 5, + "lat": 47.606038, + "lon": -122.333345, + "radius": 8046 + }, + "responses": { + "200": { + "body": { + "summary": { + "query": "juice bars", + "queryType": "NON_NEAR", + "queryTime": 36, + "numResults": 5, + "offset": 0, + "totalResults": 12, + "fuzzyLevel": 1, + "geoBias": { + "lat": 47.606038, + "lon": -122.333345 + } + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/9223158", + "score": 5.664, + "dist": 667.2710170950347, + "info": "search:ta:840539001755244-US", + "poi": { + "name": "Pressed Juicery", + "phone": "+(1)-(206)-6240804", + "brands": [ + { + "name": "Pressed Juicery" + } + ], + "categorySet": [ + { + "id": 7315149 + } + ], + "url": "www.pressedjuicery.com", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "yogurt/juice bar" + }, + { + "nameLocale": "en-US", + "name": "restaurant" + } + ] + } + ] + }, + "address": { + "streetNumber": "400", + "streetName": "Pine St", + "municipalitySubdivision": "Seattle, Central Business District", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98101", + "extendedPostalCode": "981011628", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "400 Pine St, Seattle, WA 98101", + "localName": "Seattle", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.61138, + "lon": -122.3374 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.61228, + "lon": -122.33873 + }, + "btmRightPoint": { + "lat": 47.61048, + "lon": -122.33607 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.61134, + "lon": -122.33737 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/9222534", + "score": 5.663, + "dist": 1101.6849025777728, + "info": "search:ta:840539001760125-US", + "poi": { + "name": "Pressed Juicery", + "phone": "+(1)-(206)-4533785", + "brands": [ + { + "name": "Pressed Juicery" + } + ], + "categorySet": [ + { + "id": 7315149 + } + ], + "url": "www.pressedjuicery.com", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "yogurt/juice bar" + }, + { + "nameLocale": "en-US", + "name": "restaurant" + } + ] + } + ] + }, + "address": { + "streetNumber": "315", + "streetName": "E Pine St", + "municipalitySubdivision": "Seattle, Broadway", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98122", + "extendedPostalCode": "9812200", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "315 E Pine St, Seattle, WA 98122", + "localName": "Seattle", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.61518, + "lon": -122.32768 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.61608, + "lon": -122.32901 + }, + "btmRightPoint": { + "lat": 47.61428, + "lon": -122.32635 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.61523, + "lon": -122.32768 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/9133689", + "score": 5.659, + "dist": 2649.8700791555398, + "info": "search:ta:840539001339220-US", + "poi": { + "name": "Pressed Juicery", + "phone": "+(1)-(206)-2820651", + "brands": [ + { + "name": "Pressed Juicery" + } + ], + "categorySet": [ + { + "id": 7315149 + } + ], + "url": "www.pressedjuicery.com", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "yogurt/juice bar" + }, + { + "nameLocale": "en-US", + "name": "restaurant" + } + ] + } + ] + }, + "address": { + "streetNumber": "604", + "streetName": "1st Ave N", + "municipalitySubdivision": "Seattle, Lower Queen Anne", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98109", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "604 1st Ave N, Seattle, WA 98109", + "localName": "Seattle", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.6247, + "lon": -122.35533 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.6256, + "lon": -122.35666 + }, + "btmRightPoint": { + "lat": 47.6238, + "lon": -122.354 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.6247, + "lon": -122.3554 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/9131285", + "score": 5.646, + "dist": 5097.757019046541, + "info": "search:ta:840539001743255-US", + "poi": { + "name": "Custom Smoothie & Sports Nutrition", + "phone": "+(1)-(206)-5475522", + "categorySet": [ + { + "id": 7315149 + } + ], + "url": "www.customsmoothie.com", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "yogurt/juice bar" + }, + { + "nameLocale": "en-US", + "name": "restaurant" + } + ] + } + ] + }, + "address": { + "streetNumber": "462", + "streetName": "N 34th St", + "municipalitySubdivision": "Seattle, Fremont", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98103", + "extendedPostalCode": "981038600", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "462 N 34th St, Seattle, WA 98103", + "localName": "Seattle", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.65016, + "lon": -122.35182 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.65106, + "lon": -122.35315 + }, + "btmRightPoint": { + "lat": 47.64926, + "lon": -122.35049 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.64991, + "lon": -122.3519 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/9228250", + "score": 5.637, + "dist": 6235.798481758295, + "info": "search:ta:840531000416784-US", + "poi": { + "name": "Jamba Juice", + "phone": "+(1)-(206)-6322060", + "brands": [ + { + "name": "Jamba Juice" + } + ], + "categorySet": [ + { + "id": 7315149 + } + ], + "url": "www.jambajuice.com", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "yogurt/juice bar" + }, + { + "nameLocale": "en-US", + "name": "restaurant" + } + ] + } + ] + }, + "address": { + "streetNumber": "4555", + "streetName": "Stone Way N", + "municipalitySubdivision": "Wallingford, Seattle", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98103", + "extendedPostalCode": "981036600", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "4555 Stone Way N, Seattle, WA 98103", + "localName": "Seattle", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.66179, + "lon": -122.34233 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.66269, + "lon": -122.34367 + }, + "btmRightPoint": { + "lat": 47.66089, + "lon": -122.34099 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.66188, + "lon": -122.34211 + } + } + ] + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchPOICategory.json b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchPOICategory.json new file mode 100644 index 000000000000..a54650c2539c --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchPOICategory.json @@ -0,0 +1,275 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "query": "atm", + "subscription-key": "[subscription-key]", + "limit": 3, + "lat": 40.758953, + "lon": -73.985263, + "radius": 3200 + }, + "responses": { + "200": { + "body": { + "summary": { + "query": "atm", + "queryType": "NON_NEAR", + "queryTime": 28, + "numResults": 3, + "offset": 0, + "totalResults": 3696, + "fuzzyLevel": 1, + "geoBias": { + "lat": 40.758953, + "lon": -73.985263 + } + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/7014613", + "score": 2.575, + "dist": 10.743802093311858, + "info": "search:ta:840369001846523-US", + "poi": { + "name": "FISERV MASTERMONEY", + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "1560", + "streetName": "Broadway", + "municipalitySubdivision": "Times Square, New York, Midtown", + "municipality": "New York, Manhattan", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10036", + "extendedPostalCode": "100361517", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1560 Broadway, New York, NY 10036", + "localName": "New York", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.75901, + "lon": -73.98516 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.75991, + "lon": -73.98635 + }, + "btmRightPoint": { + "lat": 40.75811, + "lon": -73.98397 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.75902, + "lon": -73.98522 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/6830011", + "score": 2.575, + "dist": 58.68107354501256, + "info": "search:ta:840369011803697-US", + "poi": { + "name": "METABANK", + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "1567", + "streetName": "Broadway", + "municipalitySubdivision": "Times Square, New York, Midtown", + "municipality": "New York, Manhattan", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10036", + "extendedPostalCode": "100361517", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1567 Broadway, New York, NY 10036", + "localName": "New York", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.75937, + "lon": -73.98569 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.76027, + "lon": -73.98688 + }, + "btmRightPoint": { + "lat": 40.75847, + "lon": -73.9845 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.75924, + "lon": -73.98513 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/6830013", + "score": 2.575, + "dist": 55.009653221373966, + "info": "search:ta:840369010525390-US", + "poi": { + "name": "ATM", + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "1552", + "streetName": "Broadway", + "municipalitySubdivision": "Times Square, New York, Midtown", + "municipality": "New York, Manhattan", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10036", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1552 Broadway, New York, NY 10036", + "localName": "New York", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.75873, + "lon": -73.98468 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.75963, + "lon": -73.98587 + }, + "btmRightPoint": { + "lat": 40.75783, + "lon": -73.98349 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.7588, + "lon": -73.98492 + } + } + ] + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchPolygon.json b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchPolygon.json new file mode 100644 index 000000000000..46186f7c933a --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/GetSearchPolygon.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "geometries": "[geometry-ids]", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "additionalData": [ + { + "providerID": "1111-2222-32-4444444444444", + "geometryData": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "properties": {}, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + -122.0665062, + 47.6496252 + ], + [ + -122.0664863, + 47.6496113 + ], + [ + -122.0664843, + 47.6496014 + ], + [ + -122.0663693, + 47.6495247 + ], + [ + -122.0663017, + 47.6494664 + ], + [ + -122.0662679, + 47.6494247 + ], + [ + -122.0661647, + 47.6493314 + ], + [ + -122.067177, + 47.649298 + ], + [ + -122.090715, + 47.6543598 + ], + [ + -122.0907846, + 47.6542921 + ], + [ + -122.0908284, + 47.6542603 + ] + ] + ] + }, + "id": "1111-2222-32-4444444444444" + } + ] + } + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchAddressBatch.json b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchAddressBatch.json new file mode 100644 index 000000000000..6db886460bff --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchAddressBatch.json @@ -0,0 +1,351 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "searchAddressBatchRequestBody": { + "batchItems": [ + { + "query": "?query=400 Broad St, Seattle, WA 98109&limit=3" + }, + { + "query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3" + }, + { + "query": "?query=350 5th Ave, New York, NY 10118&limit=1" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "summary": { + "successfulRequests": 3, + "totalRequests": 3 + }, + "batchItems": [ + { + "statusCode": 200, + "response": { + "summary": { + "query": "400 broad st seattle wa 98109", + "queryType": "NON_NEAR", + "queryTime": 127, + "numResults": 3, + "offset": 0, + "totalResults": 9, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "Point Address", + "id": "US/PAD/p0/20843845", + "score": 11.966, + "address": { + "streetNumber": "400", + "streetName": "Broad Street", + "municipalitySubdivision": "Seattle, South Lake Union, Lower Queen Anne", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98109", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "400 Broad Street, Seattle, WA 98109", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62039, + "lon": -122.34928 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62129, + "lon": -122.35061 + }, + "btmRightPoint": { + "lat": 47.61949, + "lon": -122.34795 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.61982, + "lon": -122.34886 + } + } + ] + }, + { + "type": "Street", + "id": "US/STR/p0/388442", + "score": 10.225, + "address": { + "streetName": "Broad Street", + "municipalitySubdivision": "Seattle, South Lake Union", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98109", + "extendedPostalCode": "981094612", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "Broad Street, Seattle, WA 98109", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62001, + "lon": -122.34843 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.61965, + "lon": -122.34761 + }, + "btmRightPoint": { + "lat": 47.62066, + "lon": -122.349 + } + } + }, + { + "type": "Street", + "id": "US/STR/p0/388680", + "score": 10.225, + "address": { + "streetName": "Broad Street", + "municipalitySubdivision": "Seattle, Belltown", + "municipality": "Seattle", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "countrySubdivision": "WA", + "postalCode": "98109,98121", + "extendedPostalCode": "981094991,981211117,981211237,981213206", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "Broad Street, Seattle, WA", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.61691, + "lon": -122.35251 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.61502, + "lon": -122.35041 + }, + "btmRightPoint": { + "lat": 47.61857, + "lon": -122.35484 + } + } + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "query": "one microsoft way redmond wa 98052", + "queryType": "NON_NEAR", + "queryTime": 169, + "numResults": 2, + "offset": 0, + "totalResults": 3292, + "fuzzyLevel": 2 + }, + "results": [ + { + "type": "Street", + "id": "US/STR/p0/1692663", + "score": 10.225, + "address": { + "streetName": "Microsoft Way", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980526399,980528300", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "Microsoft Way, Redmond, WA 98052", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63989, + "lon": -122.12509 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63748, + "lon": -122.12309 + }, + "btmRightPoint": { + "lat": 47.64223, + "lon": -122.13061 + } + } + }, + { + "type": "Cross Street", + "id": "US/XSTR/p1/4779971", + "score": 8.506, + "address": { + "streetName": "Microsoft Way & 157th Avenue Northeast, Microsoft Way", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "Microsoft Way & 157th Avenue Northeast, Redmond, WA 98052", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63962, + "lon": -122.13061 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.64052, + "lon": -122.13194 + }, + "btmRightPoint": { + "lat": 47.63872, + "lon": -122.12928 + } + } + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "query": "350 5th ave new york ny 10118", + "queryType": "NON_NEAR", + "queryTime": 233, + "numResults": 1, + "offset": 0, + "totalResults": 8032, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "Point Address", + "id": "US/PAD/p0/48052000", + "score": 14.334, + "address": { + "streetNumber": "350", + "streetName": "5th Avenue", + "municipalitySubdivision": "New York, Midtown South", + "municipality": "New York, Manhattan", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10118", + "extendedPostalCode": "1011800", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "350 5th Avenue, NYC, NY 10118", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.74817, + "lon": -73.985 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.74907, + "lon": -73.98619 + }, + "btmRightPoint": { + "lat": 40.74727, + "lon": -73.98381 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.74808, + "lon": -73.98482 + } + } + ] + } + ] + } + } + ] + } + }, + "202": { + "headers": { + "Location": "URL to download the results of the long-running batch request." + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchAddressReverseBatch.json b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchAddressReverseBatch.json new file mode 100644 index 000000000000..91a8a6bcd46b --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchAddressReverseBatch.json @@ -0,0 +1,190 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "searchAddressReverseBatchRequestBody": { + "batchItems": [ + { + "query": "?query=48.858561,2.294911" + }, + { + "query": "?query=47.639765,-122.127896&radius=5000&limit=2" + }, + { + "query": "?query=47.621028,-122.348170" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "summary": { + "successfulRequests": 3, + "totalRequests": 3 + }, + "batchItems": [ + { + "statusCode": 200, + "response": { + "summary": { + "queryTime": 8, + "numResults": 1 + }, + "addresses": [ + { + "address": { + "buildingNumber": "7", + "streetNumber": "7", + "routeNumbers": [], + "street": "Avenue Anatole France", + "streetName": "Avenue Anatole France", + "streetNameAndNumber": "7 Avenue Anatole France", + "countryCode": "FR", + "countrySubdivision": "Île-de-France", + "countrySecondarySubdivision": "Paris", + "municipality": "Paris", + "postalCode": "75007", + "municipalitySubdivision": "7ème Arrondissement", + "country": "France", + "countryCodeISO3": "FRA", + "freeformAddress": "7 Avenue Anatole France, Paris, 75007", + "boundingBox": { + "northEast": "48.858321,2.295167", + "southWest": "48.858136,2.295027", + "entity": "position" + } + }, + "position": "48.858231,2.295089" + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "queryTime": 8, + "numResults": 1 + }, + "addresses": [ + { + "address": { + "routeNumbers": [], + "countryCode": "US", + "countrySubdivision": "WA", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "municipality": "Redmond", + "postalCode": "98052", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "Redmond, WA 98052", + "boundingBox": { + "northEast": "47.639765,-122.128661", + "southWest": "47.639502,-122.129456", + "entity": "position" + }, + "countrySubdivisionName": "Washington" + }, + "position": "47.639687,-122.128677" + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "queryTime": 19, + "numResults": 1 + }, + "addresses": [ + { + "address": { + "buildingNumber": "410", + "streetNumber": "410", + "routeNumbers": [], + "street": "Thomas Street", + "streetName": "Thomas Street", + "streetNameAndNumber": "410 Thomas Street", + "countryCode": "US", + "countrySubdivision": "WA", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle", + "municipality": "Seattle", + "postalCode": "98109", + "municipalitySubdivision": "Seattle, Lower Queen Anne", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "410 Thomas Street, Seattle, WA 98109", + "boundingBox": { + "northEast": "47.620954,-122.347601", + "southWest": "47.620944,-122.348498", + "entity": "position" + }, + "extendedPostalCode": "981094621", + "countrySubdivisionName": "Washington" + }, + "position": "47.620945,-122.348175" + } + ] + } + } + ] + } + }, + "202": { + "headers": { + "Location": "URL to download the results of the long-running batch request." + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchAlongRoute.json b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchAlongRoute.json new file mode 100644 index 000000000000..dd9fdb3a7301 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchAlongRoute.json @@ -0,0 +1,249 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "query": "burger", + "maxDetourTime": 1000, + "limit": 2, + "subscription-key": "[subscription-key]", + "searchAlongRouteRequestBody": { + "route": { + "type": "LineString", + "coordinates": [ + [ + -122.143035, + 47.653536 + ], + [ + -122.187164, + 47.617556 + ], + [ + -122.114981, + 47.570599 + ], + [ + -122.132756, + 47.654009 + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "summary": { + "query": "burger", + "queryType": "NON_NEAR", + "queryTime": 394, + "numResults": 2, + "offset": 0, + "totalResults": 2, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/8596348", + "score": 3.104, + "dist": 1754.9604168059973, + "info": "search:ta:840531000465150-US", + "poi": { + "name": "BURGER KING", + "phone": "+(1)-(425)-7467508", + "brands": [ + { + "name": "BURGER KING" + } + ], + "categorySet": [ + { + "id": 7315015 + } + ], + "url": "www.burgerking.com", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "restaurant" + }, + { + "nameLocale": "en-US", + "name": "fast food" + } + ] + } + ] + }, + "address": { + "streetNumber": "14620", + "streetName": "NE 24th St", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "14620 NE 24th St, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63188, + "lon": -122.14462 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63278, + "lon": -122.14595 + }, + "btmRightPoint": { + "lat": 47.63098, + "lon": -122.14329 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.63155, + "lon": -122.14462 + } + } + ], + "detourTime": -55 + }, + { + "type": "POI", + "id": "US/POI/p0/8596112", + "score": 3.111, + "dist": 161.17565489389224, + "info": "search:ta:840531000465149-US", + "poi": { + "name": "BURGER KING", + "phone": "+(1)-(425)-4535775", + "brands": [ + { + "name": "BURGER KING" + } + ], + "categorySet": [ + { + "id": 7315015 + } + ], + "url": "www.burgerking.com", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "restaurant" + }, + { + "nameLocale": "en-US", + "name": "fast food" + } + ] + } + ] + }, + "address": { + "streetNumber": "11723", + "streetName": "NE 8th St", + "municipalitySubdivision": "Willburton, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98005", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "11723 NE 8th St, Bellevue, WA 98005", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.61683, + "lon": -122.18338 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.61773, + "lon": -122.18471 + }, + "btmRightPoint": { + "lat": 47.61593, + "lon": -122.18205 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.61723, + "lon": -122.1834 + } + } + ], + "detourTime": 12 + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchFuzzyBatch.json b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchFuzzyBatch.json new file mode 100644 index 000000000000..c9aa1bd64ebe --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchFuzzyBatch.json @@ -0,0 +1,1454 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "searchFuzzyBatchRequestBody": { + "batchItems": [ + { + "query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5" + }, + { + "query": "?query=Statue Of Liberty&limit=2" + }, + { + "query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "batchItems": [ + { + "statusCode": 200, + "response": { + "summary": { + "query": "atm", + "queryType": "NON_NEAR", + "queryTime": 5, + "numResults": 5, + "offset": 0, + "totalResults": 262, + "fuzzyLevel": 1, + "geoBias": { + "lat": 47.639769, + "lon": -122.128362 + } + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/3656546", + "score": 2.671, + "dist": 1336.1815386162032, + "info": "search:ta:840539002005905-US", + "poi": { + "name": "US Bank ATM-MONEYPASS", + "brands": [ + { + "name": "US Bank ATM" + } + ], + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "14808", + "streetName": "NE 24th St", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "14808 NE 24th St, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63229, + "lon": -122.14232 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63319, + "lon": -122.14365 + }, + "btmRightPoint": { + "lat": 47.63139, + "lon": -122.14099 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.63154, + "lon": -122.1423 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/8673325", + "score": 2.671, + "dist": 1206.8488178244172, + "info": "search:ta:840539002022072-US", + "poi": { + "name": "US Bank ATM NATIONAL ASSOCIATION", + "brands": [ + { + "name": "US Bank ATM" + } + ], + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "15000", + "streetName": "Northeast 24Th Street", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980525522", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "15000 Northeast 24Th Street, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63265, + "lon": -122.14052 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63355, + "lon": -122.14185 + }, + "btmRightPoint": { + "lat": 47.63175, + "lon": -122.13919 + } + }, + "entryPoints": [ + { + "type": "minor", + "position": { + "lat": 47.63156, + "lon": -122.14056 + } + }, + { + "type": "minor", + "position": { + "lat": 47.63156, + "lon": -122.14058 + } + }, + { + "type": "main", + "position": { + "lat": 47.63156, + "lon": -122.14048 + } + }, + { + "type": "main", + "position": { + "lat": 47.6324, + "lon": -122.13938 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/2736315", + "score": 2.671, + "dist": 864.75917765198585, + "info": "search:ta:840539002187855-US", + "poi": { + "name": "US Bank ATM-MONEYPASS", + "brands": [ + { + "name": "US Bank ATM" + } + ], + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "15521", + "streetName": "Bel Red Rd", + "municipalitySubdivision": "Redmond, Northeast Bellevue, Bellevue", + "municipality": "Redmond, Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980525501", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "15521 Bel Red Rd, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63259, + "lon": -122.1328 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63349, + "lon": -122.13413 + }, + "btmRightPoint": { + "lat": 47.63169, + "lon": -122.13147 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.63255, + "lon": -122.13275 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/3656412", + "score": 2.67, + "dist": 2140.1985385809412, + "info": "search:ta:840539001998867-US", + "poi": { + "name": "US Bank ATM NATIONAL ASSOCIATION", + "brands": [ + { + "name": "US Bank ATM" + } + ], + "categorySet": [ + { + "id": 7397 + } + ], + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "1128", + "streetName": "156th Ave NE", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62069, + "lon": -122.13213 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62159, + "lon": -122.13346 + }, + "btmRightPoint": { + "lat": 47.61979, + "lon": -122.1308 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.62069, + "lon": -122.13236 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/2736876", + "score": 2.67, + "dist": 2140.1985385809412, + "info": "search:ta:840539001396789-US", + "poi": { + "name": "US Bank ATM", + "phone": "+(1)-(800)-8722657", + "brands": [ + { + "name": "US Bank ATM" + } + ], + "categorySet": [ + { + "id": 7397 + } + ], + "url": "www.usbank.com", + "classifications": [ + { + "code": "CASH_DISPENSER", + "names": [ + { + "nameLocale": "en-US", + "name": "cash dispenser" + } + ] + } + ] + }, + "address": { + "streetNumber": "1128", + "streetName": "156th Ave NE", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1128 156th Ave NE, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62069, + "lon": -122.13213 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62159, + "lon": -122.13346 + }, + "btmRightPoint": { + "lat": 47.61979, + "lon": -122.1308 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.62069, + "lon": -122.13236 + } + } + ] + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "query": "statue of liberty", + "queryType": "NON_NEAR", + "queryTime": 37, + "numResults": 2, + "offset": 0, + "totalResults": 18, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/9189660", + "score": 6.942, + "info": "search:ta:840369001174316-US", + "poi": { + "name": "Statue of Liberty", + "categorySet": [ + { + "id": 7376003 + } + ], + "classifications": [ + { + "code": "IMPORTANT_TOURIST_ATTRACTION", + "names": [ + { + "nameLocale": "en-US", + "name": "monument" + }, + { + "nameLocale": "en-US", + "name": "important tourist attraction" + } + ] + } + ] + }, + "address": { + "municipalitySubdivision": "New York", + "municipality": "New York", + "countrySecondarySubdivision": "New York", + "countryTertiarySubdivision": "Manhattan", + "countrySubdivision": "NY", + "postalCode": "10004", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "New York, NY 10004", + "localName": "New York", + "countrySubdivisionName": "New York" + }, + "position": { + "lat": 40.68955, + "lon": -74.04483 + }, + "viewport": { + "topLeftPoint": { + "lat": 40.69045, + "lon": -74.04602 + }, + "btmRightPoint": { + "lat": 40.68865, + "lon": -74.04364 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 40.69001, + "lon": -74.04683 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/3264566", + "score": 6.942, + "info": "search:ta:840019000670588-US", + "poi": { + "name": "Statue of Liberty", + "phone": "+(1)-(205)-9700251", + "categorySet": [ + { + "id": 7376003 + } + ], + "url": "www.1bsa.org", + "classifications": [ + { + "code": "IMPORTANT_TOURIST_ATTRACTION", + "names": [ + { + "nameLocale": "en-US", + "name": "important tourist attraction" + } + ] + } + ] + }, + "address": { + "streetNumber": "516", + "streetName": "Liberty Pkwy", + "municipalitySubdivision": "Vestavia Hills", + "municipality": "Vestavia Hills, Birmingham", + "countrySecondarySubdivision": "Jefferson", + "countryTertiarySubdivision": "Leeds", + "countrySubdivision": "AL", + "postalCode": "35242", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "516 Liberty Pkwy, Vestavia Hills, AL 35242", + "localName": "Vestavia Hills", + "countrySubdivisionName": "Alabama" + }, + "position": { + "lat": 33.48234, + "lon": -86.70719 + }, + "viewport": { + "topLeftPoint": { + "lat": 33.48324, + "lon": -86.70827 + }, + "btmRightPoint": { + "lat": 33.48144, + "lon": -86.70611 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 33.48129, + "lon": -86.7065 + } + } + ] + } + ] + } + }, + { + "statusCode": 200, + "response": { + "summary": { + "query": "starbucks", + "queryType": "NON_NEAR", + "queryTime": 35, + "numResults": 10, + "offset": 0, + "totalResults": 17, + "fuzzyLevel": 1, + "geoBias": { + "lat": 47.639769, + "lon": -122.128362 + } + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/153678", + "score": 2.671, + "dist": 1206.8488178244172, + "info": "search:ta:840531000006554-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8695816", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "15000", + "streetName": "NE 24th St", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980525522", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "15000 NE 24th St, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63265, + "lon": -122.14052 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63355, + "lon": -122.14185 + }, + "btmRightPoint": { + "lat": 47.63175, + "lon": -122.13919 + } + }, + "entryPoints": [ + { + "type": "minor", + "position": { + "lat": 47.63156, + "lon": -122.14056 + } + }, + { + "type": "minor", + "position": { + "lat": 47.63156, + "lon": -122.14058 + } + }, + { + "type": "main", + "position": { + "lat": 47.63156, + "lon": -122.14048 + } + }, + { + "type": "main", + "position": { + "lat": 47.6324, + "lon": -122.13938 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/152316", + "score": 2.67, + "dist": 2315.294397491255, + "info": "search:ta:840539000484552-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-6436471", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/store/15097", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "15600", + "streetName": "NE 8th St", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98008", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "15600 NE 8th St, Bellevue, WA 98008", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.61896, + "lon": -122.12945 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.61986, + "lon": -122.13078 + }, + "btmRightPoint": { + "lat": 47.61806, + "lon": -122.12812 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.619, + "lon": -122.12945 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/167545", + "score": 2.67, + "dist": 1979.2222952267998, + "info": "search:ta:840539001950429-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-7470690", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "1350", + "streetName": "156th Ave NE", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1350 156th Ave NE, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62212, + "lon": -122.13179 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62302, + "lon": -122.13312 + }, + "btmRightPoint": { + "lat": 47.62122, + "lon": -122.13046 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.62213, + "lon": -122.13236 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/168519", + "score": 2.67, + "dist": 2490.3337046455963, + "info": "search:ta:840539001015090-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-4556500", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "https://www.starbucks.com/store-locator/store/15901", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "1645", + "streetName": "140th Ave NE", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98005", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "1645 140th Ave NE, Bellevue, WA 98005", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62626, + "lon": -122.15487 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62716, + "lon": -122.1562 + }, + "btmRightPoint": { + "lat": 47.62536, + "lon": -122.15354 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.62645, + "lon": -122.15446 + } + }, + { + "type": "minor", + "position": { + "lat": 47.62579, + "lon": -122.15377 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/152428", + "score": 2.668, + "dist": 3529.7080738812224, + "info": "search:ta:840539001033722-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-3789496", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "180", + "streetName": "148th Ave SE", + "municipalitySubdivision": "West Lake Hills, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "180 148th Ave SE, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.60901, + "lon": -122.14 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.60991, + "lon": -122.14133 + }, + "btmRightPoint": { + "lat": 47.60811, + "lon": -122.13867 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.60901, + "lon": -122.14008 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/167147", + "score": 2.668, + "dist": 3479.393294615887, + "info": "search:ta:840539000326896-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8619198", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "7425", + "streetName": "166th Ave NE", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980526288", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "7425 166th Ave NE, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.67055, + "lon": -122.12001 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.67145, + "lon": -122.12135 + }, + "btmRightPoint": { + "lat": 47.66965, + "lon": -122.11867 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.67069, + "lon": -122.11889 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/153695", + "score": 2.667, + "dist": 3622.4410746187291, + "info": "search:ta:840531000006551-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8822881", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/store/15022", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "7625", + "streetName": "170th Ave NE", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980520910", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "7625 170th Ave NE, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.67086, + "lon": -122.11392 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.67176, + "lon": -122.11526 + }, + "btmRightPoint": { + "lat": 47.66996, + "lon": -122.11258 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.67073, + "lon": -122.1135 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/167420", + "score": 2.667, + "dist": 3818.293513029088, + "info": "search:ta:840539000640782-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8853323", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "17246", + "streetName": "Redmond Way", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980524403", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "17246 Redmond Way, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.67174, + "lon": -122.10976 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.67264, + "lon": -122.1111 + }, + "btmRightPoint": { + "lat": 47.67084, + "lon": -122.10842 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.6706, + "lon": -122.11026 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/153686", + "score": 2.666, + "dist": 4009.9222051470738, + "info": "search:ta:840531000006548-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8859590", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "15738", + "streetName": "Redmond Way Pad 3 Redmond Center", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "980523873", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "15738 Redmond Way Pad 3 Redmond Center, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.67583, + "lon": -122.12877 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.67673, + "lon": -122.13011 + }, + "btmRightPoint": { + "lat": 47.67493, + "lon": -122.12743 + } + }, + "entryPoints": [ + { + "type": "minor", + "position": { + "lat": 47.67456, + "lon": -122.12887 + } + }, + { + "type": "main", + "position": { + "lat": 47.67668, + "lon": -122.12829 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/168511", + "score": 2.666, + "dist": 3987.80992387863, + "info": "search:ta:840531000006669-US", + "poi": { + "name": "Starbucks", + "phone": "+(1)-(425)-8818265", + "brands": [ + { + "name": "Starbucks" + } + ], + "categorySet": [ + { + "id": 9376006 + } + ], + "url": "www.starbucks.com/site-selector", + "classifications": [ + { + "code": "CAFE_PUB", + "names": [ + { + "nameLocale": "en-US", + "name": "coffee shop" + }, + { + "nameLocale": "en-US", + "name": "café/pub" + } + ] + } + ] + }, + "address": { + "streetNumber": "6617", + "streetName": "132Nd Ave Ne Bridle Trails Shopping Center", + "municipalitySubdivision": "Kirkland, Bridle Trails", + "municipality": "Kirkland", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98033", + "extendedPostalCode": "980338234", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "6617 132Nd Ave Ne Bridle Trails Shopping Center, Kirkland, WA 98033", + "localName": "Kirkland", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.66514, + "lon": -122.16599 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.66604, + "lon": -122.16733 + }, + "btmRightPoint": { + "lat": 47.66424, + "lon": -122.16465 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.666, + "lon": -122.16669 + } + }, + { + "type": "minor", + "position": { + "lat": 47.66553, + "lon": -122.16405 + } + } + ] + } + ] + } + } + ], + "summary": { + "successfulRequests": 3, + "totalRequests": 3 + } + } + }, + "202": { + "headers": { + "Location": "URL to download the results of the long-running batch request." + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchInsideFeatureCollection.json b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchInsideFeatureCollection.json new file mode 100644 index 000000000000..16beafcf6e8b --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchInsideFeatureCollection.json @@ -0,0 +1,261 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "query": "pizza", + "limit": 2, + "subscription-key": "[subscription-key]", + "searchInsideGeometryRequestBody": { + "geometry": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + -122.143035, + 47.653536 + ], + [ + -122.187164, + 47.617556 + ], + [ + -122.114981, + 47.570599 + ], + [ + -122.132756, + 47.654009 + ], + [ + -122.143035, + 47.653536 + ] + ] + ] + }, + "properties": {} + }, + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.126986, + 47.639754 + ] + }, + "properties": { + "subType": "Circle", + "radius": 100 + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "summary": { + "query": "pizza", + "queryType": "NON_NEAR", + "queryTime": 45, + "numResults": 2, + "offset": 0, + "totalResults": 18, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p1/199865", + "score": 4, + "info": "search:decarta:ta:840539000519519-US", + "poi": { + "name": "Tutta Bella", + "phone": "+(1)-(425)-5027402", + "categorySet": [ + { + "id": 7315036 + } + ], + "url": "TuttaBella.com", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "restaurant" + }, + { + "nameLocale": "en-US", + "name": "pizza" + } + ] + } + ] + }, + "address": { + "streetNumber": "15600", + "streetName": "NE 8th St", + "municipalitySubdivision": "Bellevue, Crossroads", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98008", + "extendedPostalCode": "980084084", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "15600 NE 8th St, Bellevue, WA 98008", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.61705, + "lon": -122.13228 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.61795, + "lon": -122.13361 + }, + "btmRightPoint": { + "lat": 47.61615, + "lon": -122.13095 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.61701, + "lon": -122.13228 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p1/205464", + "score": 4, + "info": "search:decarta:ta:840539000714286-US", + "poi": { + "name": "Q & S Food Co LLC", + "phone": "+(1)-(425)-7464764", + "categorySet": [ + { + "id": 7315036 + } + ], + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "restaurant" + }, + { + "nameLocale": "en-US", + "name": "pizza" + } + ] + } + ] + }, + "address": { + "streetNumber": "511", + "streetName": "141st Ave SE", + "municipalitySubdivision": "Bellevue, West Lake Hills", + "municipality": "Bellevue, Eastgate", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States Of America", + "countryCodeISO3": "USA", + "freeformAddress": "511 141st Ave SE, Bellevue, WA 98007", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.6051, + "lon": -122.15226 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.606, + "lon": -122.15359 + }, + "btmRightPoint": { + "lat": 47.6042, + "lon": -122.15093 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.6051, + "lon": -122.15219 + } + } + ] + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchInsideGeometry.json b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchInsideGeometry.json new file mode 100644 index 000000000000..91505d07f5db --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchInsideGeometry.json @@ -0,0 +1,247 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "query": "burger", + "limit": 2, + "subscription-key": "[subscription-key]", + "searchInsideGeometryRequestBody": { + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + -122.43576049804686, + 37.7524152343544 + ], + [ + -122.43301391601562, + 37.70660472542312 + ], + [ + -122.36434936523438, + 37.712059855877314 + ], + [ + -122.43576049804686, + 37.7524152343544 + ] + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "summary": { + "query": "pizza", + "queryType": "NON_NEAR", + "queryTime": 9, + "numResults": 2, + "offset": 0, + "totalResults": 18, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/8596331", + "score": 2.226, + "info": "search:ta:840539000722333-US", + "poi": { + "name": "Mod Pizza", + "phone": "+(1)-(425)-2149903", + "brands": [ + { + "name": "Mod Pizza" + } + ], + "categorySet": [ + { + "id": 7315036 + } + ], + "url": "https://modpizza.com/locations/bellevue-overlake", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "pizza" + }, + { + "nameLocale": "en-US", + "name": "restaurant" + } + ] + } + ] + }, + "address": { + "streetNumber": "14309", + "streetName": "NE 20th St", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "14309 NE 20th St, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62779, + "lon": -122.14971 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62869, + "lon": -122.15104 + }, + "btmRightPoint": { + "lat": 47.62689, + "lon": -122.14838 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.62789, + "lon": -122.14977 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/8596385", + "score": 2.226, + "info": "search:ta:840539000366535-US", + "poi": { + "name": "Pizza Hut", + "phone": "+(1)-(425)-8619900", + "brands": [ + { + "name": "Pizza Hut" + } + ], + "categorySet": [ + { + "id": 7315036 + } + ], + "url": "www.pizzahut.com", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "pizza" + }, + { + "nameLocale": "en-US", + "name": "restaurant" + } + ] + } + ] + }, + "address": { + "streetNumber": "2560", + "streetName": "152nd Ave NE", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "9805207", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "2560 152nd Ave NE, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63255, + "lon": -122.137 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63345, + "lon": -122.13833 + }, + "btmRightPoint": { + "lat": 47.63165, + "lon": -122.13567 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.63255, + "lon": -122.1377 + } + } + ] + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchInsideGeometryCollection.json b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchInsideGeometryCollection.json new file mode 100644 index 000000000000..d7b8f93a7da9 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/examples/PostSearchInsideGeometryCollection.json @@ -0,0 +1,275 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "query": "pizza", + "limit": 2, + "subscription-key": "[subscription-key]", + "searchInsideGeometryRequestBody": { + "geometry": { + "type": "GeometryCollection", + "geometries": [ + { + "type": "Polygon", + "coordinates": [ + [ + [ + -122.43576049804686, + 37.7524152343544 + ], + [ + -122.43301391601563, + 37.706604725423119 + ], + [ + -122.36434936523438, + 37.712059855877314 + ], + [ + -122.43576049804686, + 37.7524152343544 + ] + ] + ] + }, + { + "type": "Polygon", + "coordinates": [ + [ + [ + -123.43576049804686, + 37.7524152343544 + ], + [ + -123.43301391601563, + 37.706604725423119 + ], + [ + -123.36434936523438, + 37.712059855877314 + ], + [ + -123.43576049804686, + 37.7524152343544 + ] + ] + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "summary": { + "query": "pizza", + "queryType": "NON_NEAR", + "queryTime": 9, + "numResults": 2, + "offset": 0, + "totalResults": 18, + "fuzzyLevel": 1 + }, + "results": [ + { + "type": "POI", + "id": "US/POI/p0/8596331", + "score": 2.226, + "info": "search:ta:840539000722333-US", + "poi": { + "name": "Mod Pizza", + "phone": "+(1)-(425)-2149903", + "brands": [ + { + "name": "Mod Pizza" + } + ], + "categorySet": [ + { + "id": 7315036 + } + ], + "url": "https://modpizza.com/locations/bellevue-overlake", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "pizza" + }, + { + "nameLocale": "en-US", + "name": "restaurant" + } + ] + } + ] + }, + "address": { + "streetNumber": "14309", + "streetName": "NE 20th St", + "municipalitySubdivision": "Crossroads, Bellevue", + "municipality": "Bellevue", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98007", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "14309 NE 20th St, Bellevue, WA 98007", + "localName": "Bellevue", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.62779, + "lon": -122.14971 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.62869, + "lon": -122.15104 + }, + "btmRightPoint": { + "lat": 47.62689, + "lon": -122.14838 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.62789, + "lon": -122.14977 + } + } + ] + }, + { + "type": "POI", + "id": "US/POI/p0/8596385", + "score": 2.226, + "info": "search:ta:840539000366535-US", + "poi": { + "name": "Pizza Hut", + "phone": "+(1)-(425)-8619900", + "brands": [ + { + "name": "Pizza Hut" + } + ], + "categorySet": [ + { + "id": 7315036 + } + ], + "url": "www.pizzahut.com", + "classifications": [ + { + "code": "RESTAURANT", + "names": [ + { + "nameLocale": "en-US", + "name": "pizza" + }, + { + "nameLocale": "en-US", + "name": "restaurant" + } + ] + } + ] + }, + "address": { + "streetNumber": "2560", + "streetName": "152nd Ave NE", + "municipalitySubdivision": "Redmond", + "municipality": "Redmond", + "countrySecondarySubdivision": "King", + "countryTertiarySubdivision": "Seattle East", + "countrySubdivision": "WA", + "postalCode": "98052", + "extendedPostalCode": "9805207", + "countryCode": "US", + "country": "United States", + "countryCodeISO3": "USA", + "freeformAddress": "2560 152nd Ave NE, Redmond, WA 98052", + "localName": "Redmond", + "countrySubdivisionName": "Washington" + }, + "position": { + "lat": 47.63255, + "lon": -122.137 + }, + "viewport": { + "topLeftPoint": { + "lat": 47.63345, + "lon": -122.13833 + }, + "btmRightPoint": { + "lat": 47.63165, + "lon": -122.13567 + } + }, + "entryPoints": [ + { + "type": "main", + "position": { + "lat": 47.63255, + "lon": -122.1377 + } + } + ] + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/search.json b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/search.json new file mode 100644 index 000000000000..8546751c3d02 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Search/preview/1.0/search.json @@ -0,0 +1,3580 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Search Service", + "version": "1.0", + "description": "Azure Maps Search REST APIs" + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json", + "application/xml" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "user_impersonation": "Impersonates a user's Azure Active Directory account." + } + }, + "apiKeyQuery": { + "type": "apiKey", + "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + } + }, + "security": [ + { + "azure_auth": [] + }, + { + "apiKeyQuery": [] + } + ], + "responses": { + "202": { + "description": "Request Accepted: The request has been accepted for processing. Please use the URL in the Location Header to retry or access the results.", + "headers": { + "Location": { + "type": "string", + "description": "New URL to check for the results of the long running process." + } + } + }, + "400": { + "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "401": { + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + }, + "headers": { + "WWW-Authenticate": { + "type": "string", + "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" + } + } + }, + "403": { + "description": "Permission, capacity, or authentication issues.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "404": { + "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "500": { + "description": "An error occurred while processing the request. Please try again later.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "202Async": { + "description": "**Supported only for async request.**\nRequest Accepted: The request has been accepted for processing. Please use the URL in the Location Header to retry or access the results.", + "headers": { + "Location": { + "type": "string", + "description": "New URL to check for the results of the long running process." + } + } + } + }, + "parameters": { + "ClientId": { + "name": "x-ms-client-id", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "client" + }, + "SubscriptionKey": { + "name": "subscription-key", + "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API. Current version is 1.0", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "JsonFormat": { + "name": "format", + "description": "Desired format of the response. Only `json` format is supported.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "json" + ], + "x-ms-enum": { + "name": "JsonFormat", + "modelAsString": false, + "values": [ + { + "value": "json", + "description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "TextFormat": { + "name": "format", + "description": "Desired format of the response. Value can be either _json_ or _xml_.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "json", + "xml" + ], + "x-ms-enum": { + "name": "TextFormat", + "modelAsString": false, + "values": [ + { + "value": "json", + "description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)" + }, + { + "value": "xml", + "description": "[The Extensible Markup Language](https://www.w3.org/TR/xml/)" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "LimitSearch": { + "name": "limit", + "in": "query", + "description": "Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100", + "required": false, + "type": "integer", + "default": 10, + "minimum": 1, + "maximum": 100, + "x-ms-parameter-location": "method" + }, + "Offset": { + "name": "ofs", + "in": "query", + "description": "Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900", + "required": false, + "type": "integer", + "default": 0, + "minimum": 0, + "maximum": 1900, + "x-ms-parameter-location": "method" + }, + "OptionalBiasLat": { + "name": "lat", + "in": "query", + "description": "Latitude where results should be biased. E.g. 37.337", + "required": false, + "type": "number", + "x-ms-parameter-location": "method" + }, + "OptionalBiasLon": { + "name": "lon", + "in": "query", + "description": "Longitude where results should be biased. E.g. -121.89", + "required": false, + "type": "number", + "x-ms-parameter-location": "method" + }, + "BoundingBoxTopLeft": { + "x-client-name": "BoundingBoxTopLeft", + "name": "topLeft", + "in": "query", + "description": "Top left position of the bounding box. E.g. 37.553,-122.453", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BoundingBoxBottomRight": { + "x-client-name": "BoundingBoxBottomRight", + "name": "btmRight", + "in": "query", + "description": "Bottom right position of the bounding box. E.g. 37.553,-122.453", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "RequiredBiasLat": { + "name": "lat", + "in": "query", + "description": "Latitude where results should be biased. E.g. 37.337.", + "required": true, + "type": "number", + "x-ms-parameter-location": "method" + }, + "RequiredBiasLon": { + "name": "lon", + "in": "query", + "description": "Longitude where results should be biased. E.g. -121.89.", + "required": true, + "type": "number", + "x-ms-parameter-location": "method" + }, + "Language": { + "name": "language", + "in": "query", + "description": "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Query": { + "name": "query", + "in": "query", + "description": "The applicable query string. Must be properly URL encoded.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Position": { + "name": "query", + "in": "query", + "description": "The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "View": { + "name": "view", + "in": "query", + "description": "The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SearchIndexSet": { + "name": "idxSet", + "in": "query", + "description": "A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: Addr = Address range interpolation, Geo = Geographies, PAD = Point Addresses, POI = Points of interest, Str = Streets, Xstr = Cross Streets (intersections)", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "Addr", + "Geo", + "PAD", + "POI", + "Str", + "Xstr" + ], + "x-ms-enum": { + "name": "SearchIndexSet", + "modelAsString": false, + "values": [ + { + "value": "Addr", + "description": "Address range interpolation" + }, + { + "value": "Geo", + "description": "Geographies" + }, + { + "value": "PAD", + "description": "Point Addresses" + }, + { + "value": "POI", + "description": "Points of interest" + }, + { + "value": "Str", + "description": "Streets" + }, + { + "value": "Xstr", + "description": "Cross Streets (Intersections)" + } + ] + } + }, + "collectionFormat": "csv", + "x-ms-parameter-location": "method" + }, + "ExtendedPostalCodesFor": { + "name": "extendedPostalCodesFor", + "in": "query", + "description": "Indexes for which extended postal codes should be included in the results.\n\nAvailable indexes are: \n\n **Addr** = Address ranges \n\n **Geo** = Geographies \n\n **PAD** = Point Addresses \n\n **POI** = Points of Interest \n\n **Str** = Streets \n\n **XStr** = Cross Streets (intersections)\n\nValue should be a comma separated list of index types (in any order) or **None** for no indexes.\n\nBy default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed.\n\nUsage examples:\n\n extendedPostalCodesFor=POI \n\n extendedPostalCodesFor=PAD,Addr,POI \n\n extendedPostalCodesFor=None\n\nExtended postal code is returned as an **extendedPostalCode** property of an address. Availability is region-dependent.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ExtendedPostalCodesForPoi": { + "name": "extendedPostalCodesFor", + "in": "query", + "description": "Indexes for which extended postal codes should be included in the results.\n\nAvailable indexes are: \n\n **POI** = Points of Interest \n\nValue should be **POI** or **None** to disable extended postal codes.\n\nBy default extended postal codes are included.\n\nUsage examples:\n\n extendedPostalCodesFor=POI \n\n extendedPostalCodesFor=None\n\nExtended postal code is returned as an **extendedPostalCode** property of an address. Availability is region-dependent.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Typeahead": { + "name": "typeahead", + "in": "query", + "description": "Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode", + "required": false, + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "CategorySet": { + "name": "categorySet", + "in": "query", + "description": "A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using  [POI Categories API](https://aka.ms/AzureMapsPOICategoryTree). Usage examples: \n\n* **categorySet=7315** (Search Points of Interest from category Restaurant)\n\n* **categorySet=7315025,7315017** (Search Points of Interest of category either Italian or French Restaurant) ", + "required": false, + "type": "array", + "items": { + "type": "integer" + }, + "collectionFormat": "csv", + "x-ms-parameter-location": "method" + }, + "CountrySet": { + "name": "countrySet", + "in": "query", + "description": "Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", + "x-ms-parameter-location": "method" + }, + "Radius": { + "name": "radius", + "in": "query", + "description": "The radius in meters to for the results to be constrained to the defined area", + "required": false, + "type": "number", + "x-ms-parameter-location": "method" + }, + "PoiQuery": { + "name": "query", + "in": "query", + "description": "The POI name to search for (e.g., \"statue of liberty\", \"starbucks\", \"pizza\"). Must be properly URL encoded.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BrandSet": { + "name": "brandSet", + "in": "query", + "description": "A comma-separated list of brand names which could be used to restrict the result to specific brands. Item order does not matter. When multiple brands are provided, only results that belong to (at least) one of the provided list will be returned. Brands that contain a \",\" in their name should be put into quotes.\n\nUsage examples:\n\n brandSet=Foo\n\n brandSet=Foo,Bar\n\n brandSet=\"A,B,C Comma\",Bar", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", + "x-ms-parameter-location": "method" + }, + "ConnectorSet": { + "name": "connectorSet", + "in": "query", + "description": "A comma-separated list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types. Item order does not matter. When multiple connector types are provided, only results that belong to (at least) one of the provided list will be returned.\n\nAvailable connector types are:\n * `StandardHouseholdCountrySpecific` - These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage. See also: [Plug & socket types - World Standards](https://www.worldstandards.eu/electricity/plugs-and-sockets).\n * `IEC62196Type1` - Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure.\n * `IEC62196Type1CCS` - Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.\n * `IEC62196Type2CableAttached` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point.\n * `IEC62196Type2Outlet` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point.\n * `IEC62196Type2CCS` - Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.\n * `IEC62196Type3` - Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure.\n * `Chademo` - CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging.\n * `IEC60309AC1PhaseBlue` - Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the \"P+N+E, 6h\" configuration.\n * `IEC60309DCWhite` - Industrial White connector is a DC connector defined in the IEC 60309 standard.\n * `Tesla` - The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe.\n\nUsage examples:\n\n connectorSet=IEC62196Type2CableAttached\n connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "StandardHouseholdCountrySpecific", + "IEC62196Type1", + "IEC62196Type1CCS", + "IEC62196Type2CableAttached", + "IEC62196Type2Outlet", + "IEC62196Type2CCS", + "IEC62196Type3", + "Chademo", + "IEC60309AC1PhaseBlue", + "IEC60309DCWhite", + "Tesla" + ], + "x-ms-enum": { + "name": "ConnectorSet", + "modelAsString": false, + "values": [ + { + "value": "StandardHouseholdCountrySpecific", + "description": "These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage.\n\nSee also: [Plug & socket types - World Standards](https://www.worldstandards.eu/electricity/plugs-and-sockets)" + }, + { + "value": "IEC62196Type1", + "description": "Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure." + }, + { + "value": "IEC62196Type1CCS", + "description": "Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging." + }, + { + "value": "IEC62196Type2CableAttached", + "description": "Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point" + }, + { + "value": "IEC62196Type2Outlet", + "description": "Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point." + }, + { + "value": "IEC62196Type2CCS", + "description": "Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging." + }, + { + "value": "IEC62196Type3", + "description": "Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure." + }, + { + "value": "Chademo", + "description": "CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging." + }, + { + "value": "IEC60309AC1PhaseBlue", + "description": "Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the \"P+N+E, 6h\" configuration." + }, + { + "value": "IEC60309DCWhite", + "description": "Industrial White connector is a DC connector defined in the IEC 60309 standard." + }, + { + "value": "Tesla", + "description": "The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe." + } + ] + } + }, + "collectionFormat": "csv", + "x-ms-parameter-location": "method" + }, + "OpeningHours": { + "name": "openingHours", + "description": "Hours of operation for a POI (Points of Interest). The availability of hours of operation will vary based on the data available.\nSupported value: nextSevenDays", + "type": "string", + "in": "query", + "required": false, + "enum": [ + "nextSevenDays" + ], + "x-ms-enum": { + "name": "OpeningHours", + "modelAsString": false, + "values": [ + { + "value": "nextSevenDays", + "description": "Shows the hours of operation for the next week, starting with the current day in the local time of the POI." + } + ] + }, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/search/polygon/{format}": { + "get": { + "x-publish": true, + "description": "**Get Polygon**\n\n\n**Applies to**: S1 pricing tier.\n\n\nThe Get Polygon service allows you to request the geometry data such as a city or country outline for a set of entities, previously retrieved from an Online Search request in GeoJSON format. The geometry ID is returned in the dataSources object under \"geometry\" and \"id\" in either a Search Address or Search Fuzzy call.\n\nPlease note that any geometry ID retrieved from an Online Search endpoint has a limited lifetime. The client should not store geometry IDs in persistent storage for later referral, as the stability of these identifiers is not guaranteed for a long period of time. It is expected that a request to the Polygon method is made within a few minutes of the request to the Online Search method that provided the ID. The service allows for batch requests up to 20 identifiers.", + "operationId": "Search_GetSearchPolygon", + "x-ms-examples": { + "Get the Geometry using the geometry id returned by the previous Search": { + "$ref": "./examples/GetSearchPolygon.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "geometries", + "in": "query", + "description": "Comma separated list of geometry UUIDs, previously retrieved from an Online Search request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchPolygonResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "produces": [ + "application/json" + ] + } + }, + "/search/fuzzy/{format}": { + "get": { + "x-publish": true, + "description": "\n**Free Form Search**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThe basic default API is Free Form Search which handles the most fuzzy of inputs handling any combination of address or POI tokens. This search API is the canonical 'single line search'. The Free Form Search API is a seamless combination of POI search and geocoding. The API can also be weighted with a contextual position (lat./lon. pair), or fully constrained by a coordinate and radius, or it can be executed more generally without any geo biasing anchor point.

We strongly advise you to use the 'countrySet' parameter to specify only the countries for which your application needs coverage, as the default behavior will be to search the entire world, potentially returning unnecessary results.

E.g.: `countrySet`=US,FR

Please see [Search Coverage](https://docs.microsoft.com/azure/location-based-services/geocoding-coverage) for a complete list of all the supported countries.

Most Search queries default to `maxFuzzyLevel`=2 to gain performance and also reduce unusual results. This new default can be overridden as needed per request by passing in the query param `maxFuzzyLevel`=3 or 4.", + "operationId": "Search_GetSearchFuzzy", + "x-ms-examples": { + "Search City Seattle": { + "$ref": "./examples/GetSearchFuzzy.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TextFormat" + }, + { + "name": "query", + "in": "query", + "description": "The applicable query string (e.g., \"seattle\", \"pizza\"). Can _also_ be specified as a comma separated string composed by latitude followed by longitude (e.g., \"47.641268, -122.125679\"). Must be properly URL encoded.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/Typeahead" + }, + { + "$ref": "#/parameters/LimitSearch" + }, + { + "$ref": "#/parameters/Offset" + }, + { + "$ref": "#/parameters/CategorySet" + }, + { + "$ref": "#/parameters/CountrySet" + }, + { + "$ref": "#/parameters/OptionalBiasLat" + }, + { + "$ref": "#/parameters/OptionalBiasLon" + }, + { + "$ref": "#/parameters/Radius" + }, + { + "$ref": "#/parameters/BoundingBoxTopLeft" + }, + { + "$ref": "#/parameters/BoundingBoxBottomRight" + }, + { + "$ref": "#/parameters/Language" + }, + { + "$ref": "#/parameters/ExtendedPostalCodesFor" + }, + { + "name": "minFuzzyLevel", + "in": "query", + "description": "Minimum fuzziness level to be used. Default: 1, minimum: 1 and maximum: 4\n\n* Level 1 has no spell checking.\n\n* Level 2 uses normal n-gram spell checking. For example, query \"restrant\" can be matched to \"restaurant.\"\n\n* Level 3 uses sound-like spell checking, and shingle spell checking. Sound-like spell checking is for \"rstrnt\" to \"restaurant\" matching. Shingle spell checking is for \"mountainview\" to \"mountain view\" matching.\n\n* Level 4 doesn’t add any more spell checking functions.\n\n\n\nThe search engine will start looking for a match on the level defined by minFuzzyLevel, and will stop searching at the level specified by maxFuzzyLevel.", + "required": false, + "type": "integer", + "default": 1, + "minimum": 1, + "maximum": 4 + }, + { + "name": "maxFuzzyLevel", + "in": "query", + "description": "Maximum fuzziness level to be used. Default: 2, minimum: 1 and maximum: 4\n\n* Level 1 has no spell checking.\n\n* Level 2 uses normal n-gram spell checking. For example, query \"restrant\" can be matched to \"restaurant.\"\n\n* Level 3 uses sound-like spell checking, and shingle spell checking. Sound-like spell checking is for \"rstrnt\" to \"restaurant\" matching. Shingle spell checking is for \"mountainview\" to \"mountain view\" matching.\n\n* Level 4 doesn’t add any more spell checking functions.\n\n\n\nThe search engine will start looking for a match on the level defined by minFuzzyLevel, and will stop searching at the level specified by maxFuzzyLevel.", + "required": false, + "type": "integer", + "default": 2, + "minimum": 1, + "maximum": 4 + }, + { + "$ref": "#/parameters/SearchIndexSet" + }, + { + "$ref": "#/parameters/BrandSet" + }, + { + "$ref": "#/parameters/ConnectorSet" + }, + { + "$ref": "#/parameters/View" + }, + { + "$ref": "#/parameters/OpeningHours" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchFuzzyResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/search/poi/{format}": { + "get": { + "x-publish": true, + "description": "**Get POI by Name**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nPoints of Interest (POI) Search allows you to request POI results by name. Search supports additional query parameters such as language and filtering results by area of interest driven by country or bounding box. Endpoint will return only POI results matching the query string. Response includes POI details such as address, coordinate location and category.", + "operationId": "Search_GetSearchPOI", + "x-ms-examples": { + "Search for juice bars within 5 miles of Seattle Downtown and limit the response to 5 results": { + "$ref": "./examples/GetSearchPOI.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TextFormat" + }, + { + "name": "query", + "in": "query", + "description": "The POI name to search for (e.g., \"statue of liberty\", \"starbucks\"), must be properly URL encoded.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/Typeahead" + }, + { + "$ref": "#/parameters/LimitSearch" + }, + { + "$ref": "#/parameters/Offset" + }, + { + "$ref": "#/parameters/CategorySet" + }, + { + "$ref": "#/parameters/CountrySet" + }, + { + "$ref": "#/parameters/OptionalBiasLat" + }, + { + "$ref": "#/parameters/OptionalBiasLon" + }, + { + "$ref": "#/parameters/Radius" + }, + { + "$ref": "#/parameters/BoundingBoxTopLeft" + }, + { + "$ref": "#/parameters/BoundingBoxBottomRight" + }, + { + "$ref": "#/parameters/Language" + }, + { + "$ref": "#/parameters/ExtendedPostalCodesForPoi" + }, + { + "$ref": "#/parameters/BrandSet" + }, + { + "$ref": "#/parameters/ConnectorSet" + }, + { + "$ref": "#/parameters/View" + }, + { + "$ref": "#/parameters/OpeningHours" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchPoiResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/search/nearby/{format}": { + "get": { + "x-publish": true, + "description": "**Nearby Search**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nIf you have a use case for only retrieving POI results around a specific location, the nearby search method may be the right choice. This endpoint will only return POI results, and does not take in a search query parameter.", + "operationId": "Search_GetSearchNearby", + "x-ms-examples": { + "Search for any points of interest (POI) within 5 miles of Manhattan NY and return the top 10 results": { + "$ref": "./examples/GetSearchNearby.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TextFormat" + }, + { + "$ref": "#/parameters/RequiredBiasLat" + }, + { + "$ref": "#/parameters/RequiredBiasLon" + }, + { + "$ref": "#/parameters/LimitSearch" + }, + { + "$ref": "#/parameters/Offset" + }, + { + "$ref": "#/parameters/CategorySet" + }, + { + "$ref": "#/parameters/CountrySet" + }, + { + "name": "radius", + "in": "query", + "description": "The radius in meters to for the results to be constrained to the defined area, Min value is 1, Max Value is 50000.", + "required": false, + "type": "number" + }, + { + "$ref": "#/parameters/Language" + }, + { + "$ref": "#/parameters/ExtendedPostalCodesFor" + }, + { + "$ref": "#/parameters/BrandSet" + }, + { + "$ref": "#/parameters/ConnectorSet" + }, + { + "$ref": "#/parameters/View" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchNearbyResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/search/poi/category/{format}": { + "get": { + "x-publish": true, + "description": "**Get POI by Category**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nPoints of Interest (POI) Category Search allows you to request POI results from given category. Search allows to query POIs from one category at a time. Endpoint will only return POI results which are categorized as specified. Response includes POI details such as address, coordinate location and classification.", + "operationId": "Search_GetSearchPOICategory", + "x-ms-examples": { + "Search for atm's within 2 miles of Times Square NY and return the top 3 results": { + "$ref": "./examples/GetSearchPOICategory.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TextFormat" + }, + { + "name": "query", + "in": "query", + "description": "The POI category to search for (e.g., \"AIRPORT\", \"RESTAURANT\"), must be properly URL encoded. Supported main categories can be requested by calling [Get Search POI Category Tree API](https://aka.ms/AzureMapsPOICategoryTree). List of available categories can also be found [here](https://docs.microsoft.com/azure/azure-maps/supported-search-categories). We recommend to use POI Search Category Tree API to request the supported categories.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/Typeahead" + }, + { + "$ref": "#/parameters/LimitSearch" + }, + { + "$ref": "#/parameters/Offset" + }, + { + "$ref": "#/parameters/CategorySet" + }, + { + "$ref": "#/parameters/CountrySet" + }, + { + "$ref": "#/parameters/OptionalBiasLat" + }, + { + "$ref": "#/parameters/OptionalBiasLon" + }, + { + "$ref": "#/parameters/Radius" + }, + { + "$ref": "#/parameters/BoundingBoxTopLeft" + }, + { + "$ref": "#/parameters/BoundingBoxBottomRight" + }, + { + "$ref": "#/parameters/Language" + }, + { + "$ref": "#/parameters/ExtendedPostalCodesFor" + }, + { + "$ref": "#/parameters/BrandSet" + }, + { + "$ref": "#/parameters/ConnectorSet" + }, + { + "$ref": "#/parameters/View" + }, + { + "$ref": "#/parameters/OpeningHours" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchPoiCategoryResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/search/poi/category/tree/{format}": { + "get": { + "x-publish": true, + "description": "**Get POI Category Tree**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nPOI Category API provides a full list of supported Points of Interest (POI) categories and subcategories together with their translations and synonyms. The returned content can be used to provide more meaningful results through other Search Service APIs, like [Get Search POI](https://docs.microsoft.com/rest/api/maps/search/getsearchpoi).", + "operationId": "Search_GetSearchPOICategoryTreePreview", + "x-ms-examples": { + "Get the POI Category Tree (only partial response shown below)": { + "$ref": "./examples/GetPOICategoryTree.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "language", + "in": "query", + "description": "Language in which search results should be returned. Should be one of supported IETF language tags, except NGT and NGT-Latn. Language tag is case insensitive. When data in specified language is not available for a specific field, default language is used (English).\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PoiCategoryResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/search/address/{format}": { + "get": { + "x-publish": true, + "description": "**Address Geocoding**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nIn many cases, the complete search service might be too much, for instance if you are only interested in traditional geocoding. Search can also be accessed for address look up exclusively. The geocoding is performed by hitting the geocode endpoint with just the address or partial address in question. The geocoding search index will be queried for everything above the street level data. No POIs will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties, states etc.", + "operationId": "Search_GetSearchAddress", + "x-ms-examples": { + "Search detail address 15127 NE 24th Street, Redmond, WA 98052": { + "$ref": "./examples/GetSearchAddress.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TextFormat" + }, + { + "name": "query", + "in": "query", + "description": "The address to search for (e.g., \"1 Microsoft way, Redmond, WA\"), must be properly URL encoded.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/Typeahead" + }, + { + "$ref": "#/parameters/LimitSearch" + }, + { + "$ref": "#/parameters/Offset" + }, + { + "$ref": "#/parameters/CountrySet" + }, + { + "$ref": "#/parameters/OptionalBiasLat" + }, + { + "$ref": "#/parameters/OptionalBiasLon" + }, + { + "$ref": "#/parameters/Radius" + }, + { + "$ref": "#/parameters/BoundingBoxTopLeft" + }, + { + "$ref": "#/parameters/BoundingBoxBottomRight" + }, + { + "$ref": "#/parameters/Language" + }, + { + "$ref": "#/parameters/ExtendedPostalCodesFor" + }, + { + "$ref": "#/parameters/View" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchAddressResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/search/address/reverse/{format}": { + "get": { + "x-publish": true, + "description": "**Reverse Geocode to an Address**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThere may be times when you need to translate a coordinate (example: 37.786505, -122.3862) into a human understandable street address. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located. This endpoint will return address information for a given coordinate.", + "operationId": "Search_GetSearchAddressReverse", + "x-ms-examples": { + "GetSearchAddressReverse": { + "$ref": "./examples/GetSearchAddressReverse.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TextFormat" + }, + { + "$ref": "#/parameters/Position" + }, + { + "$ref": "#/parameters/Language" + }, + { + "name": "returnSpeedLimit", + "in": "query", + "description": "Boolean. To enable return of the posted speed limit", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "heading", + "in": "query", + "description": "The directional heading of the vehicle in degrees, for travel along a segment of roadway. 0 is North, 90 is East and so on, values range from -360 to 360. The precision can include upto one decimal place", + "required": false, + "type": "number", + "minimum": -360, + "maximum": 360 + }, + { + "$ref": "#/parameters/Radius" + }, + { + "name": "number", + "in": "query", + "description": "If a number is sent in along with the request, the response may include the side of the street (Left/Right) and also an offset position for that number", + "required": false, + "type": "string" + }, + { + "name": "returnRoadUse", + "in": "query", + "description": "Boolean. To enable return of the road use array for reverse geocodes at street level", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "roadUse", + "in": "query", + "description": "To restrict reverse geocodes to a certain type of road use. The road use array for reverse geocodes can be one or more of LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet", + "required": false, + "type": "string" + }, + { + "name": "allowFreeformNewline", + "in": "query", + "description": "Format of newlines in the formatted address.\n\nIf true, the address will contain newlines.\nIf false, newlines will be converted to commas.", + "required": false, + "type": "boolean" + }, + { + "name": "returnMatchType", + "in": "query", + "description": "Include information on the type of match the geocoder achieved in the response.", + "required": false, + "type": "boolean" + }, + { + "name": "entityType", + "in": "query", + "description": "Specifies the level of filtering performed on geographies. Narrows the search for specified geography entity types, e.g. return only municipality. The resulting response will contain the geography ID as well as the entity type matched. If you provide more than one entity as a comma separated list, endpoint will return the 'smallest entity available'. Returned Geometry ID can be used to get the geometry of that geography via [Get Search Polygon](https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon) API. The following parameters are ignored when entityType is set:\n\n* heading\n* number\n* returnRoadUse\n* returnSpeedLimit\n* roadUse\n* returnMatchType", + "required": false, + "type": "string", + "enum": [ + "Country", + "CountrySubdivision", + "CountrySecondarySubdivision", + "CountryTertiarySubdivision", + "Municipality", + "MunicipalitySubdivision", + "Neighbourhood", + "PostalCodeArea" + ], + "x-ms-enum": { + "name": "EntityType", + "modelAsString": false, + "values": [ + { + "value": "Country", + "description": "Country name" + }, + { + "value": "CountrySubdivision", + "description": "State or Province" + }, + { + "value": "CountrySecondarySubdivision", + "description": "County" + }, + { + "value": "CountryTertiarySubdivision", + "description": "Named Area" + }, + { + "value": "Municipality", + "description": "City / Town" + }, + { + "value": "MunicipalitySubdivision", + "description": "Sub / Super City" + }, + { + "value": "Neighbourhood", + "description": "Neighbourhood" + }, + { + "value": "PostalCodeArea", + "description": "Postal Code / Zip Code" + } + ] + }, + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/View" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchAddressReverseResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/search/address/reverse/crossStreet/{format}": { + "get": { + "x-publish": true, + "description": "**Reverse Geocode to a Cross Street**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThere may be times when you need to translate a coordinate (example: 37.786505, -122.3862) into a human understandable cross street. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located.\nThis endpoint will return cross street information for a given coordinate.", + "operationId": "Search_GetSearchAddressReverseCrossStreet", + "x-ms-examples": { + "GetSearchAddressReverseCrossStreet": { + "$ref": "./examples/GetSearchAddressReverseCrossStreet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TextFormat" + }, + { + "$ref": "#/parameters/Position" + }, + { + "$ref": "#/parameters/LimitSearch" + }, + { + "name": "heading", + "in": "query", + "description": "The directional heading of the vehicle in degrees, for travel along a segment of roadway. 0 is North, 90 is East and so on, values range from -360 to 360. The precision can include upto one decimal place", + "required": false, + "type": "number", + "minimum": -360, + "maximum": 360 + }, + { + "$ref": "#/parameters/Radius" + }, + { + "$ref": "#/parameters/Language" + }, + { + "$ref": "#/parameters/View" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchAddressReverseCrossStreetResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/search/address/structured/{format}": { + "get": { + "x-publish": true, + "description": "**Structured Address Geocoding**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nAzure Address Geocoding can also be accessed for structured address look up exclusively. The geocoding search index will be queried for everything above the street level data. No POIs will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties, states etc.", + "operationId": "Search_GetSearchAddressStructured", + "x-ms-examples": { + "GetSearchAddressStructured": { + "$ref": "./examples/GetSearchAddressStructured.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TextFormat" + }, + { + "$ref": "#/parameters/Language" + }, + { + "name": "countryCode", + "in": "query", + "description": "The 2 or 3 letter [ISO3166-1](https://www.iso.org/iso-3166-country-codes.html) country code portion of an address. E.g. US.", + "required": true, + "default": "US", + "type": "string" + }, + { + "$ref": "#/parameters/LimitSearch" + }, + { + "$ref": "#/parameters/Offset" + }, + { + "name": "streetNumber", + "in": "query", + "description": "The street number portion of an address", + "required": false, + "type": "string" + }, + { + "name": "streetName", + "in": "query", + "description": "The street name portion of an address", + "required": false, + "type": "string" + }, + { + "name": "crossStreet", + "in": "query", + "description": "The cross street name for the structured address", + "required": false, + "type": "string" + }, + { + "name": "municipality", + "in": "query", + "description": "The municipality portion of an address", + "required": false, + "type": "string" + }, + { + "name": "municipalitySubdivision", + "in": "query", + "description": "The municipality subdivision (sub/super city) for the structured address", + "required": false, + "type": "string" + }, + { + "name": "countryTertiarySubdivision", + "in": "query", + "description": "The named area for the structured address", + "required": false, + "type": "string" + }, + { + "name": "countrySecondarySubdivision", + "in": "query", + "description": "The county for the structured address", + "required": false, + "type": "string" + }, + { + "name": "countrySubdivision", + "in": "query", + "description": "The country subdivision portion of an address", + "required": false, + "type": "string" + }, + { + "name": "postalCode", + "in": "query", + "description": "The postal code portion of an address", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/ExtendedPostalCodesFor" + }, + { + "$ref": "#/parameters/View" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchAddressStructuredResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/search/geometry/{format}": { + "post": { + "x-publish": true, + "description": "**Applies to**: S0 and S1 pricing tiers.\n\nThe Search Geometry endpoint allows you to perform a free form search inside a single geometry or many of them. The search results that fall inside the geometry/geometries will be returned.

To send the geometry you will use a `POST` request where the request body will contain the `geometry` object represented as a `GeoJSON` type and the `Content-Type` header will be set to `application/json`. The geographical features to be searched can be modeled as Polygon and/or Circle geometries represented using any one of the following `GeoJSON` types:
  • **GeoJSON FeatureCollection**
    The `geometry` can be represented as a `GeoJSON FeatureCollection` object. This is the recommended option if the geometry contains both Polygons and Circles. The `FeatureCollection` can contain a max of 50 `GeoJSON Feature` objects. Each `Feature` object should represent either a Polygon or a Circle with the following conditions:
    • A `Feature` object for the Polygon geometry can have a max of 50 coordinates and it's properties must be empty.
    • A `Feature` object for the Circle geometry is composed of a _center_ represented using a `GeoJSON Point` type and a _radius_ value (in meters) which must be specified in the object's properties along with the _subType_ property whose value should be 'Circle'.

    Please see the Examples section below for a sample `FeatureCollection` representation.

  • **GeoJSON GeometryCollection**
    The `geometry` can be represented as a `GeoJSON GeometryCollection` object. This is the recommended option if the geometry contains a list of Polygons only. The `GeometryCollection` can contain a max of 50 `GeoJSON Polygon` objects. Each `Polygon` object can have a max of 50 coordinates. Please see the Examples section below for a sample `GeometryCollection` representation.

  • **GeoJSON Polygon**
    The `geometry` can be represented as a `GeoJSON Polygon` object. This is the recommended option if the geometry contains a single Polygon. The `Polygon` object can have a max of 50 coordinates. Please see the Examples section below for a sample `Polygon` representation.

.

", + "operationId": "Search_PostSearchInsideGeometry", + "x-ms-examples": { + "Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type": { + "$ref": "./examples/PostSearchInsideFeatureCollection.json" + }, + "Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type": { + "$ref": "./examples/PostSearchInsideGeometryCollection.json" + }, + "Search for subs joints inside a geometry represented as a GeoJSON Polygon type": { + "$ref": "./examples/PostSearchInsideGeometry.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/PoiQuery" + }, + { + "$ref": "#/parameters/TextFormat" + }, + { + "$ref": "#/parameters/LimitSearch" + }, + { + "$ref": "#/parameters/Language" + }, + { + "$ref": "#/parameters/CategorySet" + }, + { + "$ref": "#/parameters/ExtendedPostalCodesFor" + }, + { + "$ref": "#/parameters/SearchIndexSet" + }, + { + "name": "searchInsideGeometryRequestBody", + "in": "body", + "description": "This represents the geometry for one or more geographical features (parks, state boundary etc.) to search in and should be a GeoJSON compliant type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946) for details.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchInsideGeometryRequestBody" + } + }, + { + "$ref": "#/parameters/View" + }, + { + "$ref": "#/parameters/OpeningHours" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchGeometryResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/search/alongRoute/{format}": { + "post": { + "x-publish": true, + "description": "**Applies to**: S0 and S1 pricing tiers.\n\n\nThe Search Along Route endpoint allows you to perform a fuzzy search for POIs along a specified route. This search is constrained by specifying the `maxDetourTime` limiting measure.

To send the route-points you will use a `POST` request where the request body will contain the `route` object represented as a `GeoJSON LineString` type and the `Content-Type` header will be set to `application/json`. Each route-point in `route` is represented as a `GeoJSON Position` type i.e. an array where the _longitude_ value is followed by the _latitude_ value and the _altitude_ value is ignored. The `route` should contain at least 2 route-points.

It is possible that original route will be altered, some of it's points may be skipped. If the route that passes through the found point is faster than the original one, the `detourTime` value in the response is negative.", + "operationId": "Search_PostSearchAlongRoute", + "x-ms-examples": { + "Search for burger joints along a route": { + "$ref": "./examples/PostSearchAlongRoute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/CategorySet" + }, + { + "$ref": "#/parameters/PoiQuery" + }, + { + "$ref": "#/parameters/TextFormat" + }, + { + "name": "maxDetourTime", + "description": "Maximum detour time of the point of interest in seconds. Max value is 3600 seconds", + "required": true, + "type": "integer", + "in": "query", + "maximum": 3600 + }, + { + "name": "limit", + "description": "Maximum number of responses that will be returned. Default value is 10. Max value is 20", + "required": false, + "type": "integer", + "in": "query", + "default": 10, + "maximum": 20 + }, + { + "$ref": "#/parameters/BrandSet" + }, + { + "$ref": "#/parameters/ConnectorSet" + }, + { + "$ref": "#/parameters/View" + }, + { + "$ref": "#/parameters/OpeningHours" + }, + { + "name": "searchAlongRouteRequestBody", + "in": "body", + "description": "This represents the route to search along and should be a valid `GeoJSON LineString` type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.4) for details.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchAlongRouteRequestBody" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchAlongRouteResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/search/fuzzy/batch/{format}": { + "post": { + "x-publish": true, + "description": "**Search Fuzzy Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Search Address Batch API sends batches of queries to [Search Fuzzy API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy) using just a single API call. You can call Search Address Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search fuzzy_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search fuzzy_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5\"},\n {\"query\": \"?query=Statue Of Liberty&limit=2\"},\n {\"query\": \"?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000\"},\n {\"query\": \"?query=Space Needle\"},\n {\"query\": \"?query=pizza&limit=10\"}\n ]\n}\n```\n\nA _search fuzzy_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search fuzzy_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy#uri-parameters). The string values in the _search fuzzy_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchFuzzyResponse`](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy#searchfuzzyresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"atm\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"ATM at Wells Fargo\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"3240 157th Ave NE, Redmond, WA 98052\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"statue of liberty\"\n },\n \"results\": [\n {\n \"type\": \"POI\",\n \"poi\": {\n \"name\": \"Statue of Liberty\"\n },\n \"address\": {\n \"country\": \"United States Of America\",\n \"freeformAddress\": \"New York, NY 10004\"\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "operationId": "Search_PostSearchFuzzyBatch", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "A Search Fuzzy Batch API call containing 5 Search Fuzzy API queries": { + "$ref": "./examples/PostSearchFuzzyBatch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "searchFuzzyBatchRequestBody", + "in": "body", + "description": "The list of search fuzzy queries/requests to process. The list can contain a max of 10,000 queries and must contain at least 1 query.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchRequestBody" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BatchResponse" + } + }, + "202": { + "$ref": "#/responses/202Async" + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "produces": [ + "application/json" + ] + } + }, + "/search/address/batch/{format}": { + "post": { + "x-publish": true, + "description": "**Search Address Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Search Address Batch API sends batches of queries to [Search Address API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress) using just a single API call. You can call Search Address Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=400 Broad St, Seattle, WA 98109&limit=3\"},\n {\"query\": \"?query=One, Microsoft Way, Redmond, WA 98052&limit=3\"},\n {\"query\": \"?query=350 5th Ave, New York, NY 10118&limit=1\"},\n {\"query\": \"?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000\"},\n {\"query\": \"?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1\"}\n ]\n}\n```\n\nA _search address_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress#uri-parameters). The string values in the _search address_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressResponse`](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress#searchaddressresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"one microsoft way redmond wa 98052\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.63989,\n \"lon\": -122.12509\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"query\": \"pike pl seattle wa 98101\"\n },\n \"results\": [\n {\n \"position\": {\n \"lat\": 47.60963,\n \"lon\": -122.34215\n }\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "operationId": "Search_PostSearchAddressBatch", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "An Address Geocoding Batch API call containing 5 Address Geocoding API queries": { + "$ref": "./examples/PostSearchAddressBatch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "searchAddressBatchRequestBody", + "in": "body", + "description": "The list of address geocoding queries/requests to process. The list can contain a max of 10,000 queries and must contain at least 1 query.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchRequestBody" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BatchResponse" + } + }, + "202": { + "$ref": "#/responses/202Async" + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "produces": [ + "application/json" + ] + } + }, + "/search/address/reverse/batch/{format}": { + "post": { + "x-publish": true, + "description": "**Search Address Reverse Batch API**\n\n\n**Applies to**: S1 pricing tier.\n\n\n\nThe Search Address Batch API sends batches of queries to [Search Address Reverse API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse) using just a single API call. You can call Search Address Reverse Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries.\n### Submit Synchronous Batch Request\nThe Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API.\n```\nPOST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex search requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **10,000** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:\n1. Client sends a Search Address Batch `POST` request to Azure Maps\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n\n```\n GET https://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _search address reverse_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address reverse_ queries:\n\n\n```json\n{\n \"batchItems\": [\n {\"query\": \"?query=48.858561,2.294911\"},\n {\"query\": \"?query=47.639765,-122.127896&radius=5000&limit=2\"},\n {\"query\": \"?query=47.621028,-122.348170\"},\n {\"query\": \"?query=43.722990,10.396695\"},\n {\"query\": \"?query=40.750958,-73.982336\"}\n ]\n}\n```\n\nA _search address reverse_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address reverse_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse#uri-parameters). The string values in the _search address reverse_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`SearchAddressReverseResponse`](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse#searchaddressreverseresponse) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 2 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 2,\n \"totalRequests\": 3\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 11\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"France\",\n \"freeformAddress\": \"Avenue Anatole France, 75007 Paris\"\n },\n \"position\": \"48.858490,2.294820\"\n }\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"response\":\n {\n \"summary\": {\n \"queryTime\": 1\n },\n \"addresses\": [\n {\n \"address\": {\n \"country\": \"United States of America\",\n \"freeformAddress\": \"157th Pl NE, Redmond WA 98052\"\n },\n \"position\": \"47.640470,-122.129430\"\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "operationId": "Search_PostSearchAddressReverseBatch", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "A Reverse Geocoding Batch API call containing 5 Reverse Geocoding API queries": { + "$ref": "./examples/PostSearchAddressReverseBatch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "searchAddressReverseBatchRequestBody", + "in": "body", + "description": "The list of reverse geocoding queries/requests to process. The list can contain a max of 10,000 queries and must contain at least 1 query.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchRequestBody" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BatchResponse" + } + }, + "202": { + "$ref": "#/responses/202Async" + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "produces": [ + "application/json" + ] + } + } + }, + "definitions": { + "ODataErrorResponse": { + "type": "object", + "description": "This response object is returned when an error occurs in the Maps API.", + "properties": { + "error": { + "$ref": "#/definitions/ODataError" + } + } + }, + "ODataError": { + "type": "object", + "description": "This object is returned when an error occurs in the Maps API.", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The ODataError code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + } + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the target causing the error." + } + } + }, + "BatchResponse": { + "description": "This object is returned from a successful Batch service call", + "type": "object", + "properties": { + "summary": { + "description": "Summary for the batch request", + "type": "object", + "readOnly": true, + "properties": { + "successfulRequests": { + "description": "Number of successful requests in the batch", + "type": "integer", + "readOnly": true + }, + "totalRequests": { + "description": "Total number of requests in the batch", + "type": "integer", + "readOnly": true + } + } + }, + "batchItems": { + "description": "Array containing the batch results", + "type": "array", + "readOnly": true, + "items": { + "type": "object" + } + } + } + }, + "Geometry": { + "description": "This represents the geometry for one or more geographical features (parks, state boundary etc.) and should be a `GeoJSON` compliant type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946) for details.", + "type": "object" + }, + "BatchRequestBody": { + "description": "This type represents the request body for the Batch service.", + "type": "object", + "properties": { + "batchItems": { + "description": "The list of queries/requests to process", + "type": "array", + "items": { + "description": "Batch Query object", + "type": "object", + "properties": { + "query": { + "description": "Partial query string", + "type": "string" + } + } + } + } + } + }, + "CoordinateAbbreviated": { + "description": "A location represented as a latitude and longitude.", + "type": "object", + "properties": { + "lat": { + "description": "Latitude property", + "type": "number", + "format": "double", + "readOnly": true + }, + "lon": { + "description": "Longitude property", + "type": "number", + "format": "double", + "readOnly": true + } + } + }, + "GeoJSONGeometry": { + "description": "A valid `GeoJSON` geometry object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1) for details.", + "type": "object", + "discriminator": "type", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "Specifies the `GeoJSON` geometry type. Must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection.", + "type": "string", + "enum": [ + "Point", + "MultiPoint", + "LineString", + "MultiLineString", + "Polygon", + "MultiPolygon", + "GeometryCollection" + ], + "x-ms-enum": { + "name": "GeoJSONGeometryType", + "modelAsString": false, + "values": [ + { + "value": "Point", + "description": "`GeoJSON Point` geometry." + }, + { + "value": "MultiPoint", + "description": "`GeoJSON MultiPoint` geometry." + }, + { + "value": "LineString", + "description": "`GeoJSON LineString` geometry." + }, + { + "value": "MultiLineString", + "description": "`GeoJSON MultiLineString` geometry." + }, + { + "value": "Polygon", + "description": "`GeoJSON Polygon` geometry." + }, + { + "value": "MultiPolygon", + "description": "`GeoJSON MultiPolygon` geometry." + }, + { + "value": "GeometryCollection", + "description": "`GeoJSON GeometryCollection` geometry." + } + ] + } + } + } + }, + "LineString": { + "description": "A valid `GeoJSON LineString` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.4) for details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJSONGeometry" + }, + { + "properties": { + "type": { + "description": "Specifies the `type` for the geometry. Value should always be equal to \"LineString\".", + "type": "string" + }, + "coordinates": { + "description": "Coordinates for the `LineString` geometry.", + "type": "array", + "items": { + "$ref": "#/definitions/GeoJSONPosition" + } + } + }, + "required": [ + "coordinates" + ] + } + ] + }, + "GeoJSONPosition": { + "description": "A valid `GeoJSON Position` geometry type. A `Position` is an array of numbers with two or more elements. The first two elements are _longitude_ and _latitude_, precisely in that order. _Altitude/Elevation_ is an optional third element. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.1) for details.", + "type": "array", + "items": { + "type": "number", + "format": "double" + } + }, + "PoiCategoryResponse": { + "description": "This object is returned from a successful POI Category Tree call", + "type": "object", + "properties": { + "poiCategories": { + "description": "Categories array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PoiCategoryResult" + } + } + } + }, + "PoiCategoryResult": { + "description": "POI category result", + "type": "object", + "properties": { + "id": { + "description": "Unique ID for the category. ID can be used to restrict search results to specific categories through other Search Service APIs, like [Get Search POI](https://docs.microsoft.com/rest/api/maps/search/getsearchpoi).", + "type": "integer", + "readOnly": true + }, + "name": { + "description": "Name of the category", + "type": "string", + "readOnly": true + }, + "childCategoryIds": { + "description": "Array of child category ids", + "type": "array", + "items": { + "type": "integer", + "readOnly": true + }, + "readOnly": true + }, + "synonyms": { + "description": "Array of alternative names of the category", + "type": "array", + "items": { + "type": "string", + "readOnly": true + }, + "readOnly": true + } + } + }, + "SearchPolygonResponse": { + "description": "This object is returned from a successful Search Polygon call", + "type": "object", + "properties": { + "additionalData": { + "description": "Results array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchPolygonResult" + } + } + } + }, + "SearchPolygonResult": { + "type": "object", + "properties": { + "providerID": { + "description": "ID of the returned entity", + "type": "string", + "readOnly": true + }, + "error": { + "description": "Reason for the failure to obtain data for this provider.", + "type": "string", + "readOnly": true + }, + "geometryData": { + "description": "Geometry data in GeoJSON format. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946) for details. Present only if \"error\" is not present.", + "$ref": "#/definitions/Geometry" + } + } + }, + "SearchFuzzyResponse": { + "description": "This object is returned from a successful Search Fuzzy call", + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/SearchFuzzySummary" + }, + "results": { + "description": "Results array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchFuzzyResult" + } + } + } + }, + "SearchFuzzySummary": { + "description": "Summary object for a Search Fuzzy response", + "type": "object", + "readOnly": true, + "properties": { + "query": { + "description": "Query property", + "type": "string", + "readOnly": true + }, + "queryType": { + "description": "QueryType property", + "type": "string", + "readOnly": true + }, + "queryTime": { + "description": "QueryTime property", + "type": "integer", + "readOnly": true + }, + "numResults": { + "description": "NumResults property", + "type": "integer", + "readOnly": true + }, + "offset": { + "description": "Offset property", + "type": "integer", + "readOnly": true + }, + "totalResults": { + "description": "TotalResults property", + "type": "integer", + "readOnly": true + }, + "fuzzyLevel": { + "description": "FuzzyLevel property", + "type": "integer", + "readOnly": true + } + } + }, + "SearchFuzzyResult": { + "type": "object", + "properties": { + "type": { + "description": "One of:\n* POI\n* Street\n* Geography\n* Point Address\n* Address Range\n* Cross Street", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id property", + "type": "string", + "readOnly": true + }, + "score": { + "$ref": "#/definitions/SearchResultScore" + }, + "info": { + "description": "Info property", + "type": "string", + "readOnly": true + }, + "entityType": { + "$ref": "#/definitions/EntityType" + }, + "poi": { + "$ref": "#/definitions/SearchResultPoi" + }, + "address": { + "$ref": "#/definitions/SearchResultAddress" + }, + "position": { + "$ref": "#/definitions/CoordinateAbbreviated" + }, + "viewport": { + "$ref": "#/definitions/SearchResultViewport" + }, + "entryPoints": { + "description": "Entry Points array", + "type": "array", + "items": { + "$ref": "#/definitions/SearchResultEntryPoint" + } + }, + "addressRanges": { + "$ref": "#/definitions/SearchResultAddressRanges" + }, + "dataSources": { + "$ref": "#/definitions/DataSources" + } + } + }, + "SearchPoiResponse": { + "description": "This object is returned from a successful Search POI call", + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/SearchPoiSummary" + }, + "results": { + "description": "Results array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchPoiResult" + } + } + } + }, + "SearchPoiSummary": { + "description": "Summary object for a Search POI response", + "type": "object", + "readOnly": true, + "properties": { + "query": { + "description": "Query property", + "type": "string", + "readOnly": true + }, + "queryType": { + "description": "QueryType property", + "type": "string", + "readOnly": true + }, + "queryTime": { + "description": "QueryTime property", + "type": "integer", + "readOnly": true + }, + "numResults": { + "description": "NumResults property", + "type": "integer", + "readOnly": true + }, + "offset": { + "description": "Offset property", + "type": "integer", + "readOnly": true + }, + "totalResults": { + "description": "TotalResults property", + "type": "integer", + "readOnly": true + }, + "fuzzyLevel": { + "description": "FuzzyLevel property", + "type": "integer", + "readOnly": true + }, + "geoBias": { + "$ref": "#/definitions/SearchSummaryGeoBias" + } + } + }, + "SearchPoiResult": { + "type": "object", + "properties": { + "type": { + "description": "Type property", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id property", + "type": "string", + "readOnly": true + }, + "score": { + "$ref": "#/definitions/SearchResultScore" + }, + "dist": { + "$ref": "#/definitions/SearchResultDistance" + }, + "info": { + "description": "Info property", + "type": "string", + "readOnly": true + }, + "entityType": { + "$ref": "#/definitions/EntityType" + }, + "poi": { + "$ref": "#/definitions/SearchResultPoi" + }, + "address": { + "$ref": "#/definitions/SearchResultAddress" + }, + "position": { + "$ref": "#/definitions/CoordinateAbbreviated" + }, + "viewport": { + "$ref": "#/definitions/SearchResultViewport" + }, + "entryPoints": { + "description": "Entry Points array", + "type": "array", + "items": { + "$ref": "#/definitions/SearchResultEntryPoint" + } + } + } + }, + "SearchNearbyResponse": { + "description": "This object is returned from a successful Search Nearby call", + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/SearchNearbySummary" + }, + "results": { + "description": "Results array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchNearbyResult" + } + } + } + }, + "SearchNearbySummary": { + "description": "Summary object for a Search Nearby response", + "type": "object", + "readOnly": true, + "properties": { + "queryType": { + "description": "QueryType property", + "type": "string", + "readOnly": true + }, + "queryTime": { + "description": "QueryTime property", + "type": "integer", + "readOnly": true + }, + "numResults": { + "description": "NumResults property", + "type": "integer", + "readOnly": true + }, + "offset": { + "description": "Offset property", + "type": "integer", + "readOnly": true + }, + "totalResults": { + "description": "TotalResults property", + "type": "integer", + "readOnly": true + }, + "fuzzyLevel": { + "description": "FuzzyLevel property", + "type": "integer", + "readOnly": true + }, + "geoBias": { + "$ref": "#/definitions/SearchSummaryGeoBias" + } + } + }, + "SearchNearbyResult": { + "type": "object", + "properties": { + "type": { + "description": "Type property", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id property", + "type": "string", + "readOnly": true + }, + "score": { + "$ref": "#/definitions/SearchResultScore" + }, + "dist": { + "$ref": "#/definitions/SearchResultDistance" + }, + "info": { + "description": "Info property", + "type": "string", + "readOnly": true + }, + "poi": { + "$ref": "#/definitions/SearchResultPoi" + }, + "address": { + "$ref": "#/definitions/SearchResultAddress" + }, + "position": { + "$ref": "#/definitions/CoordinateAbbreviated" + }, + "viewport": { + "$ref": "#/definitions/SearchResultViewport" + }, + "entryPoints": { + "description": "Entry Points array", + "type": "array", + "items": { + "$ref": "#/definitions/SearchResultEntryPoint" + } + } + } + }, + "SearchPoiCategoryResponse": { + "description": "This object is returned from a successful Search POI Category call", + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/SearchPoiCategorySummary" + }, + "results": { + "description": "Results array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchPoiCategoryResult" + } + } + } + }, + "SearchPoiCategorySummary": { + "description": "Summary object for a Search POI Category response", + "type": "object", + "readOnly": true, + "properties": { + "query": { + "description": "Query property", + "type": "string", + "readOnly": true + }, + "queryType": { + "description": "QueryType property", + "type": "string", + "readOnly": true + }, + "queryTime": { + "description": "QueryTime property", + "type": "integer", + "readOnly": true + }, + "numResults": { + "description": "NumResults property", + "type": "integer", + "readOnly": true + }, + "offset": { + "description": "Offset property", + "type": "integer", + "readOnly": true + }, + "totalResults": { + "description": "TotalResults property", + "type": "integer", + "readOnly": true + }, + "fuzzyLevel": { + "description": "FuzzyLevel property", + "type": "integer", + "readOnly": true + }, + "geoBias": { + "$ref": "#/definitions/SearchSummaryGeoBias" + } + } + }, + "SearchPoiCategoryResult": { + "type": "object", + "properties": { + "type": { + "description": "Type property", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id property", + "type": "string", + "readOnly": true + }, + "score": { + "$ref": "#/definitions/SearchResultScore" + }, + "dist": { + "$ref": "#/definitions/SearchResultDistance" + }, + "info": { + "description": "Info property", + "type": "string", + "readOnly": true + }, + "entityType": { + "$ref": "#/definitions/EntityType" + }, + "poi": { + "$ref": "#/definitions/SearchResultPoi" + }, + "address": { + "$ref": "#/definitions/SearchResultAddress" + }, + "position": { + "$ref": "#/definitions/CoordinateAbbreviated" + }, + "viewport": { + "$ref": "#/definitions/SearchResultViewport" + }, + "entryPoints": { + "description": "Entry Points array", + "type": "array", + "items": { + "$ref": "#/definitions/SearchResultEntryPoint" + } + } + } + }, + "SearchAddressResponse": { + "description": "This object is returned from a successful Search Address call", + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/SearchAddressSummary" + }, + "results": { + "description": "Results array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchAddressResult" + } + } + } + }, + "SearchAddressSummary": { + "description": "Summary object for a Search Address response", + "type": "object", + "readOnly": true, + "properties": { + "query": { + "description": "Query property", + "type": "string", + "readOnly": true + }, + "queryType": { + "description": "QueryType property", + "type": "string", + "readOnly": true + }, + "queryTime": { + "description": "QueryTime property", + "type": "integer", + "readOnly": true + }, + "numResults": { + "description": "NumResults property", + "type": "integer", + "readOnly": true + }, + "offset": { + "description": "Offset property", + "type": "integer", + "readOnly": true + }, + "totalResults": { + "description": "TotalResults property", + "type": "integer", + "readOnly": true + }, + "fuzzyLevel": { + "description": "FuzzyLevel property", + "type": "integer", + "readOnly": true + } + } + }, + "SearchAddressResult": { + "type": "object", + "properties": { + "type": { + "description": "One of:\n* POI\n* Street\n* Geography\n* Point Address\n* Address Range\n* Cross Street", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id property", + "type": "string", + "readOnly": true + }, + "score": { + "$ref": "#/definitions/SearchResultScore" + }, + "address": { + "$ref": "#/definitions/SearchResultAddress" + }, + "position": { + "$ref": "#/definitions/CoordinateAbbreviated" + }, + "viewport": { + "$ref": "#/definitions/SearchResultViewport" + }, + "entryPoints": { + "description": "Entry Points array", + "type": "array", + "items": { + "$ref": "#/definitions/SearchResultEntryPoint" + } + }, + "dataSources": { + "$ref": "#/definitions/DataSources" + } + } + }, + "SearchAddressReverseResponse": { + "description": "This object is returned from a successful Search Address Reverse call", + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/SearchAddressReverseSummary" + }, + "addresses": { + "description": "Addresses array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchAddressReverseResult" + } + } + } + }, + "SearchAddressReverseSummary": { + "description": "Summary object for a Search Address Reverse response", + "type": "object", + "readOnly": true, + "properties": { + "queryTime": { + "description": "QueryTime property", + "type": "integer", + "readOnly": true + }, + "numResults": { + "description": "NumResults property", + "type": "integer", + "readOnly": true + } + } + }, + "SearchAddressReverseResult": { + "type": "object", + "properties": { + "address": { + "$ref": "#/definitions/SearchResultAddress" + }, + "position": { + "type": "string", + "readOnly": true, + "description": "Position property in the form of \"{latitude},{longitude}\"" + }, + "matchType": { + "type": "string", + "readOnly": true, + "description": "Information on the type of match.\n\nOne of:\n * AddressPoint\n * HouseNumberRange\n * Street" + } + } + }, + "SearchAddressReverseCrossStreetResponse": { + "description": "This object is returned from a successful Search Address Reverse CrossStreet call", + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/SearchAddressReverseCrossStreetSummary" + }, + "addresses": { + "description": "Addresses array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchAddressReverseCrossStreetResult" + } + } + } + }, + "SearchAddressReverseCrossStreetSummary": { + "description": "Summary object for a Search Address Reverse Cross Street response", + "type": "object", + "readOnly": true, + "properties": { + "queryTime": { + "description": "QueryTime property", + "type": "integer", + "readOnly": true + }, + "numResults": { + "description": "NumResults property", + "type": "integer", + "readOnly": true + } + } + }, + "SearchAddressReverseCrossStreetResult": { + "type": "object", + "properties": { + "address": { + "$ref": "#/definitions/SearchResultAddress" + }, + "position": { + "type": "string", + "readOnly": true, + "description": "Position property in the form of \"{latitude},{longitude}\"" + } + } + }, + "SearchAddressStructuredResponse": { + "description": "This object is returned from a successful Search Address Structured call", + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/SearchAddressStructuredSummary" + }, + "results": { + "description": "Results array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchAddressStructuredResult" + } + } + } + }, + "SearchAddressStructuredSummary": { + "description": "Summary object for a Search Address Structured response", + "type": "object", + "readOnly": true, + "properties": { + "query": { + "description": "Query property", + "type": "string", + "readOnly": true + }, + "queryType": { + "description": "QueryType property", + "type": "string", + "readOnly": true + }, + "queryTime": { + "description": "QueryTime property", + "type": "integer", + "readOnly": true + }, + "numResults": { + "description": "NumResults property", + "type": "integer", + "readOnly": true + }, + "limit": { + "description": "Maximum number of responses that will be returned", + "readOnly": true, + "type": "integer" + }, + "offset": { + "description": "Offset property", + "type": "integer", + "readOnly": true + }, + "totalResults": { + "description": "TotalResults property", + "type": "integer", + "readOnly": true + }, + "fuzzyLevel": { + "description": "FuzzyLevel property", + "type": "integer", + "readOnly": true + }, + "geoBias": { + "$ref": "#/definitions/SearchSummaryGeoBias" + } + } + }, + "SearchAddressStructuredResult": { + "type": "object", + "properties": { + "type": { + "description": "Type property", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id property", + "type": "string", + "readOnly": true + }, + "score": { + "$ref": "#/definitions/SearchResultScore" + }, + "dist": { + "$ref": "#/definitions/SearchResultDistance" + }, + "address": { + "$ref": "#/definitions/SearchResultAddress" + }, + "position": { + "$ref": "#/definitions/CoordinateAbbreviated" + }, + "viewport": { + "$ref": "#/definitions/SearchResultViewport" + }, + "entryPoints": { + "description": "Entry Points array", + "type": "array", + "items": { + "$ref": "#/definitions/SearchResultEntryPoint" + } + }, + "addressRanges": { + "$ref": "#/definitions/SearchResultAddressRanges" + } + } + }, + "SearchGeometryResponse": { + "description": "This object is returned from a successful Search By Geometry call", + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/SearchGeometrySummary" + }, + "results": { + "description": "A list of Search Inside Geometry results.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchGeometryResult" + } + } + } + }, + "SearchGeometrySummary": { + "description": "Summary object for a Search Geometry response", + "type": "object", + "readOnly": true, + "properties": { + "query": { + "description": "Query property", + "type": "string", + "readOnly": true + }, + "queryType": { + "description": "QueryType property", + "type": "string", + "readOnly": true + }, + "queryTime": { + "description": "QueryTime property", + "type": "integer", + "readOnly": true + }, + "numResults": { + "description": "NumResults property", + "type": "integer", + "readOnly": true + }, + "offset": { + "description": "Offset property", + "type": "integer", + "readOnly": true + }, + "totalResults": { + "description": "TotalResults property", + "type": "integer", + "readOnly": true + }, + "fuzzyLevel": { + "description": "FuzzyLevel property", + "type": "integer", + "readOnly": true + } + } + }, + "SearchGeometryResult": { + "description": "This type represents the Search Inside Geometry result object.", + "type": "object", + "properties": { + "type": { + "description": "Type property", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id property", + "type": "string", + "readOnly": true + }, + "score": { + "$ref": "#/definitions/SearchResultScore" + }, + "info": { + "description": "Info property", + "type": "string", + "readOnly": true + }, + "entityType": { + "$ref": "#/definitions/EntityType" + }, + "poi": { + "$ref": "#/definitions/SearchResultPoi" + }, + "address": { + "$ref": "#/definitions/SearchResultAddress" + }, + "position": { + "$ref": "#/definitions/CoordinateAbbreviated" + }, + "viewport": { + "$ref": "#/definitions/SearchResultViewport" + }, + "entryPoints": { + "description": "Entry Points array", + "type": "array", + "items": { + "$ref": "#/definitions/SearchResultEntryPoint" + } + } + } + }, + "SearchAlongRouteResponse": { + "description": "This object is returned from a successful Search Along Route call.", + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/SearchAlongRouteSummary" + }, + "results": { + "description": "A list of Search Along Route results.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchAlongRouteResult" + } + } + } + }, + "SearchAlongRouteSummary": { + "description": "Summary object for a Search Along Route response", + "type": "object", + "readOnly": true, + "properties": { + "query": { + "description": "Query property", + "type": "string", + "readOnly": true + }, + "queryType": { + "description": "QueryType property", + "type": "string", + "readOnly": true + }, + "queryTime": { + "description": "QueryTime property", + "type": "integer", + "readOnly": true + }, + "numResults": { + "description": "NumResults property", + "type": "integer", + "readOnly": true + }, + "offset": { + "description": "Offset property", + "type": "integer", + "readOnly": true + }, + "totalResults": { + "description": "TotalResults property", + "type": "integer", + "readOnly": true + }, + "fuzzyLevel": { + "description": "FuzzyLevel property", + "type": "integer", + "readOnly": true + } + } + }, + "SearchAlongRouteResult": { + "description": "This type represents the Search Along Route result object.", + "type": "object", + "properties": { + "type": { + "description": "Type property", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id property", + "type": "string", + "readOnly": true + }, + "score": { + "$ref": "#/definitions/SearchResultScore" + }, + "info": { + "description": "Info property", + "type": "string", + "readOnly": true + }, + "entityType": { + "$ref": "#/definitions/EntityType" + }, + "poi": { + "$ref": "#/definitions/SearchResultPoi" + }, + "address": { + "$ref": "#/definitions/SearchResultAddress" + }, + "position": { + "$ref": "#/definitions/CoordinateAbbreviated" + }, + "viewport": { + "$ref": "#/definitions/SearchResultViewport" + }, + "entryPoints": { + "description": "Entry Points array", + "type": "array", + "items": { + "$ref": "#/definitions/SearchResultEntryPoint" + } + }, + "dist": { + "$ref": "#/definitions/SearchResultDistance" + }, + "detourTime": { + "description": "Detour time in seconds", + "type": "number", + "readOnly": true + } + } + }, + "SearchInsideGeometryRequestBody": { + "description": "This type represents the request body for the Search Inside Geometry service.", + "type": "object", + "properties": { + "geometry": { + "$ref": "#/definitions/Geometry" + } + } + }, + "SearchAlongRouteRequestBody": { + "description": "This type represents the request body for the Search Along Route service.", + "type": "object", + "properties": { + "route": { + "$ref": "#/definitions/LineString" + } + } + }, + "SearchResultPoi": { + "description": "Details of the returned POI including information such as the name, phone, url address, and classifications.", + "type": "object", + "properties": { + "name": { + "description": "Name of the POI property", + "type": "string", + "readOnly": true + }, + "phone": { + "description": "Telephone number property", + "type": "string", + "readOnly": true + }, + "url": { + "description": "Website URL property", + "type": "string", + "readOnly": true + }, + "categorySet": { + "description": "The list of the most specific POI categories", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchResultPoiCategorySet" + } + }, + "categories": { + "description": "__[Deprecated]__ Use classifications instead. Categories array", + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "readOnly": true + } + }, + "classifications": { + "description": "Classification array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchResultPoiClassification" + } + }, + "brands": { + "description": "Brands array. The name of the brand for the POI being returned.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchResultPoiBrand" + } + }, + "openingHours": { + "$ref": "#/definitions/SearchResultPoiOpeningHours" + } + } + }, + "SearchResultPoiCategorySet": { + "description": "POI category", + "type": "object", + "properties": { + "id": { + "description": "Category ID", + "type": "integer", + "readOnly": true + } + } + }, + "SearchResultPoiClassification": { + "description": "The classification for the POI being returned", + "type": "object", + "properties": { + "code": { + "description": "Code property", + "type": "string", + "readOnly": true + }, + "names": { + "description": "Names array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchResultPoiClassificationName" + } + } + } + }, + "SearchResultPoiClassificationName": { + "description": "Name for the classification", + "type": "object", + "properties": { + "nameLocale": { + "description": "Name Locale property", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name property", + "type": "string", + "readOnly": true + } + } + }, + "SearchResultPoiOpeningHours": { + "description": "Opening hours for a POI (Points of Interest).", + "type": "object", + "properties": { + "mode": { + "description": "Value used in the Request", + "type": "string", + "readOnly": true + }, + "timeRanges": { + "description": "List of time ranges for the next 7 days", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchResultPoiOpeningHoursTimeRange" + } + } + } + }, + "SearchResultPoiOpeningHoursTimeRange": { + "description": "Open time range for a day", + "type": "object", + "properties": { + "startTime": { + "description": "The point in the next 7 days range when a given POI is being opened, or the beginning of the range if it was opened before the range.", + "$ref": "#/definitions/SearchResultPoiOpeningHoursTimeRangeTime" + }, + "endTime": { + "description": "The point in the next 7 days range when a given POI is being closed, or the beginning of the range if it was closed before the range.", + "$ref": "#/definitions/SearchResultPoiOpeningHoursTimeRangeTime" + } + } + }, + "SearchResultPoiOpeningHoursTimeRangeTime": { + "description": "Represents a date and time", + "type": "object", + "properties": { + "date": { + "description": "Represents current day in calendar year in POI time zone.", + "type": "string", + "readOnly": true + }, + "hour": { + "description": "Hours are in the 24 hour format in the local time of a POI; possible values are 0 - 23.", + "type": "integer", + "readOnly": true + }, + "minute": { + "description": "Minutes are in the local time of a POI; possible values are 0 - 59.", + "type": "integer", + "readOnly": true + } + } + }, + "SearchResultPoiBrand": { + "description": "The name of the brand for the POI being returned", + "type": "object", + "properties": { + "name": { + "description": "Name of the brand", + "type": "string", + "readOnly": true + } + } + }, + "SearchResultAddress": { + "description": "The address of the result", + "type": "object", + "properties": { + "buildingNumber": { + "description": "Building Number property", + "type": "string", + "readOnly": true + }, + "street": { + "description": "Street property", + "type": "string", + "readOnly": true + }, + "crossStreet": { + "description": "Cross Street property", + "type": "string", + "readOnly": true + }, + "streetNumber": { + "description": "Street Number property", + "type": "string", + "readOnly": true + }, + "routeNumbers": { + "description": "number of routes", + "type": "array", + "items": { + "type": "integer", + "readOnly": true + }, + "readOnly": true + }, + "streetName": { + "description": "Street Name property", + "type": "string", + "readOnly": true + }, + "streetNameAndNumber": { + "description": "Street Name and Number property", + "type": "string", + "readOnly": true + }, + "municipality": { + "description": "Municipality property", + "type": "string", + "readOnly": true + }, + "municipalitySubdivision": { + "description": "Municipality Subdivision property", + "type": "string", + "readOnly": true + }, + "countryTertiarySubdivision": { + "description": "Country Tertiary Subdivision property", + "type": "string", + "readOnly": true + }, + "countrySecondarySubdivision": { + "description": "Country Secondary Subdivision property", + "type": "string", + "readOnly": true + }, + "countrySubdivision": { + "description": "Country Subdivision property", + "type": "string", + "readOnly": true + }, + "postalCode": { + "description": "Postal Code property", + "type": "string", + "readOnly": true + }, + "extendedPostalCode": { + "description": "Extended Postal Code property", + "type": "string", + "readOnly": true + }, + "countryCode": { + "description": "Country Code property", + "type": "string", + "readOnly": true + }, + "country": { + "description": "Country property", + "type": "string", + "readOnly": true + }, + "countryCodeISO3": { + "description": "Country Code ISO3 property", + "type": "string", + "readOnly": true + }, + "freeformAddress": { + "description": "Free form Address property", + "type": "string", + "readOnly": true + }, + "countrySubdivisionName": { + "description": "Country Subdivision Name property", + "type": "string", + "readOnly": true + }, + "localName": { + "description": "An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit. This field is used to build the `freeformAddress` property.", + "type": "string", + "readOnly": true + } + } + }, + "SearchResultViewport": { + "description": "The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport.", + "type": "object", + "properties": { + "topLeftPoint": { + "$ref": "#/definitions/CoordinateAbbreviated" + }, + "btmRightPoint": { + "$ref": "#/definitions/CoordinateAbbreviated" + } + } + }, + "SearchResultEntryPoint": { + "description": "The entry point for the POI being returned.", + "type": "object", + "properties": { + "type": { + "description": "The type of entry point. Value can be either _main_ or _minor_.", + "type": "string", + "readOnly": true, + "enum": [ + "main", + "minor" + ] + }, + "position": { + "$ref": "#/definitions/CoordinateAbbreviated" + } + } + }, + "SearchResultAddressRanges": { + "description": "Describes the address range on both sides of the street for a search result. Coordinates for the start and end locations of the address range are included.", + "type": "object", + "properties": { + "rangeLeft": { + "type": "string" + }, + "rangeRight": { + "type": "string" + }, + "from": { + "$ref": "#/definitions/CoordinateAbbreviated" + }, + "to": { + "$ref": "#/definitions/CoordinateAbbreviated" + } + } + }, + "SearchResultScore": { + "description": "The value within a result set to indicate the relative matching score between results. You can use this to determine that result x is twice as likely to be as relevant as result y if the value of x is 2x the value of y. The values vary between queries and is only meant as a relative value for one result set.", + "type": "number", + "readOnly": true + }, + "SearchResultDistance": { + "description": "Straight line distance between the result and geobias location in meters.", + "type": "number", + "readOnly": true + }, + "SearchSummaryGeoBias": { + "description": "Indication when the internal search engine has applied a geospatial bias to improve the ranking of results. In some methods, this can be affected by setting the lat and lon parameters where available. In other cases it is purely internal.", + "type": "object", + "readOnly": true, + "properties": { + "lat": { + "description": "Latitude property", + "type": "number", + "readOnly": true + }, + "lon": { + "description": "Longitude property", + "type": "number", + "readOnly": true + } + } + }, + "DataSources": { + "description": "Optional section. Reference ids for use with the [Get Search Polygon](https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon) API.", + "type": "object", + "properties": { + "geometry": { + "$ref": "#/definitions/DataSourcesGeometry" + } + } + }, + "DataSourcesGeometry": { + "description": "Information about the geometric shape of the result. Only present if type == Geography.", + "type": "object", + "properties": { + "id": { + "description": "Pass this as geometryId to the [Get Search Polygon](https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon) API to fetch geometry information for this result.", + "type": "string", + "readOnly": true + } + } + }, + "EntityType": { + "description": "Geography entity type. Present only when entityType was requested and is available.", + "type": "string", + "enum": [ + "Country", + "CountrySubdivision", + "CountrySecondarySubdivision", + "CountryTertiarySubdivision", + "Municipality", + "MunicipalitySubdivision", + "Neighbourhood", + "PostalCodeArea" + ], + "x-ms-enum": { + "name": "EntityType", + "modelAsString": false, + "values": [ + { + "value": "Country", + "description": "Country name" + }, + { + "value": "CountrySubdivision", + "description": "State or Province" + }, + { + "value": "CountrySecondarySubdivision", + "description": "County" + }, + { + "value": "CountryTertiarySubdivision", + "description": "Named Area" + }, + { + "value": "Municipality", + "description": "City / Town" + }, + { + "value": "MunicipalitySubdivision", + "description": "Sub / Super City" + }, + { + "value": "Neighbourhood", + "description": "Neighbourhood" + }, + { + "value": "PostalCodeArea", + "description": "Postal Code / Zip Code" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/GetBuffer.json b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/GetBuffer.json new file mode 100644 index 000000000000..43e7e0727837 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/GetBuffer.json @@ -0,0 +1,219 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "udid": "[udid]", + "distances": "176.3" + }, + "responses": { + "200": { + "body": { + "summary": { + "udid": "[udid from request]", + "information": "1 feature processed in user data" + }, + "result": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "properties": { + "geometryId": "ExampleId", + "bufferDist": 176.3 + }, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + -111.92483859605078, + 33.5362475 + ], + [ + -111.92487510409389, + 33.53587682761772 + ], + [ + -111.92498322523961, + 33.535520399967204 + ], + [ + -111.92515880445296, + 33.535191914363196 + ], + [ + -111.92539509432322, + 33.53490399432323 + ], + [ + -111.92568301436319, + 33.534667704452971 + ], + [ + -111.9260114999672, + 33.53449212523963 + ], + [ + -111.9263679276177, + 33.5343840040939 + ], + [ + -111.9267386, + 33.534347496050785 + ], + [ + -111.92710927238228, + 33.5343840040939 + ], + [ + -111.92746570003278, + 33.53449212523963 + ], + [ + -111.9277941856368, + 33.534667704452971 + ], + [ + -111.92808210567676, + 33.53490399432323 + ], + [ + -111.92831839554702, + 33.535191914363196 + ], + [ + -111.92849397476037, + 33.535520399967204 + ], + [ + -111.9286020959061, + 33.53587682761772 + ], + [ + -111.92863860394921, + 33.5362475 + ], + [ + -111.9286020959061, + 33.536618172382283 + ], + [ + -111.92849397476037, + 33.5369746000328 + ], + [ + -111.92831839554702, + 33.537303085636808 + ], + [ + -111.92808210567676, + 33.537591005676774 + ], + [ + -111.9277941856368, + 33.537827295547032 + ], + [ + -111.92746570003278, + 33.538002874760373 + ], + [ + -111.92710927238228, + 33.5381109959061 + ], + [ + -111.9267386, + 33.538147503949219 + ], + [ + -111.9263679276177, + 33.5381109959061 + ], + [ + -111.9260114999672, + 33.538002874760373 + ], + [ + -111.92568301436319, + 33.537827295547032 + ], + [ + -111.92539509432322, + 33.537591005676774 + ], + [ + -111.92515880445296, + 33.537303085636808 + ], + [ + -111.92498322523961, + 33.5369746000328 + ], + [ + -111.92487510409389, + 33.536618172382283 + ], + [ + -111.92483859605078, + 33.5362475 + ] + ] + ] + } + } + ] + } + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "ClientParams", + "message": "One or more parameters are missing.", + "innererror": { + "code": "MissingQueryParameter", + "message": "Input parameter udid is missing." + } + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/GetClosestPoint.json b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/GetClosestPoint.json new file mode 100644 index 000000000000..556e7a33ae6e --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/GetClosestPoint.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "udid": "[udid]", + "lat": 47.622942, + "lon": -122.316456 + }, + "responses": { + "200": { + "body": { + "summary": { + "sourcePoint": { + "lat": 47.622942, + "lon": -122.316456 + }, + "udid": "[udid from request]", + "information": "10 points processed in user data" + }, + "result": [ + { + "distanceInMeters": 1587492.66, + "position": { + "lat": 40.516153406773952, + "lon": -105.02860293715861 + }, + "geometryId": "1001" + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "ClientParams", + "message": "One or more parameters are missing.", + "innererror": { + "code": "MissingQueryParameter", + "message": "Input parameter lon is missing." + } + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/GetGeofence.json b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/GetGeofence.json new file mode 100644 index 000000000000..6d01b0c8a0ca --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/GetGeofence.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "deviceId": "unique_device_name_under_account", + "udId": "[udId]", + "lat": 48.36, + "lon": -124.63, + "searchBuffer": 50, + "userTime": "2018-09-10T10:00:00", + "isAsync": true, + "mode": "EnterAndExit", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "geometries": [ + { + "deviceId": "unique_device_name_under_account", + "udId": "[udId]", + "geometryId": "2", + "distance": 999, + "nearestLat": 47.621954, + "nearestLon": -122.131841 + }, + { + "deviceId": "unique_device_name_under_account", + "udId": "[udId]", + "geometryId": "1", + "distance": -999, + "nearestLat": 47.609833, + "nearestLon": -122.148274 + } + ], + "expiredGeofenceGeometryId": [ + "5" + ], + "invalidPeriodGeofenceGeometryId": [ + "3", + "4" + ], + "isEventPublished": true + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "BadRequest", + "message": "Can't find user geofencing data with provided udid.", + "innererror": { + "code": "NoUserDataWithUdid" + } + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/GetGreatCircleDistance.json b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/GetGreatCircleDistance.json new file mode 100644 index 000000000000..e309dad87a26 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/GetGreatCircleDistance.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "query": "47.622942,-122.316456:47.610378,-122.200676" + }, + "responses": { + "200": { + "body": { + "summary": { + "sourcePoint": { + "lat": 47.622942, + "lon": -122.316456 + }, + "targetPoint": { + "lat": 47.610378, + "lon": -122.200676 + } + }, + "result": { + "distanceInMeters": 8797.62 + } + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "ClientParams", + "message": "Lat and/or lon parameters are invalid.", + "innererror": { + "code": "InvalidLatLon", + "message": "The provided coordinates '-122.316456,47.622942:47.610378,-122.200676' in query paramter are invalid, out of range, or not in the expected format" + } + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/GetPointInPolygon.json b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/GetPointInPolygon.json new file mode 100644 index 000000000000..88c4357c221c --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/GetPointInPolygon.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "udid": "[udid]", + "lat": 47.622942, + "lon": -122.316456 + }, + "responses": { + "200": { + "body": { + "summary": { + "sourcePoint": { + "lat": 33.5362475, + "lon": -111.9267386 + }, + "udid": "[udid from request]", + "information": "4 polygons processed in user data" + }, + "result": { + "pointInPolygons": true, + "intersectingGeometries": [ + "1001", + "1003" + ] + } + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "ClientParams", + "message": "Udid should be acquired from user data ingestion API.", + "innererror": { + "code": "UdidWrongFormat" + } + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/PostBuffer.json b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/PostBuffer.json new file mode 100644 index 000000000000..00d7798d1c99 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/PostBuffer.json @@ -0,0 +1,240 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "bufferRequestBody": { + "geometries": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "properties": { + "geometryId": "ExampleId" + }, + "geometry": { + "type": "Point", + "coordinates": [ + -111.9267386, + 33.5362475 + ] + } + } + ] + }, + "distances": [ + 176.3 + ] + } + }, + "responses": { + "200": { + "body": { + "summary": { + "udid": null, + "information": "1 feature processed in user data" + }, + "result": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "properties": { + "geometryId": "ExampleId", + "bufferDist": 176.3 + }, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + -111.92483859605078, + 33.5362475 + ], + [ + -111.92487510409389, + 33.53587682761772 + ], + [ + -111.92498322523961, + 33.535520399967204 + ], + [ + -111.92515880445296, + 33.535191914363196 + ], + [ + -111.92539509432322, + 33.53490399432323 + ], + [ + -111.92568301436319, + 33.534667704452971 + ], + [ + -111.9260114999672, + 33.53449212523963 + ], + [ + -111.9263679276177, + 33.5343840040939 + ], + [ + -111.9267386, + 33.534347496050785 + ], + [ + -111.92710927238228, + 33.5343840040939 + ], + [ + -111.92746570003278, + 33.53449212523963 + ], + [ + -111.9277941856368, + 33.534667704452971 + ], + [ + -111.92808210567676, + 33.53490399432323 + ], + [ + -111.92831839554702, + 33.535191914363196 + ], + [ + -111.92849397476037, + 33.535520399967204 + ], + [ + -111.9286020959061, + 33.53587682761772 + ], + [ + -111.92863860394921, + 33.5362475 + ], + [ + -111.9286020959061, + 33.536618172382283 + ], + [ + -111.92849397476037, + 33.5369746000328 + ], + [ + -111.92831839554702, + 33.537303085636808 + ], + [ + -111.92808210567676, + 33.537591005676774 + ], + [ + -111.9277941856368, + 33.537827295547032 + ], + [ + -111.92746570003278, + 33.538002874760373 + ], + [ + -111.92710927238228, + 33.5381109959061 + ], + [ + -111.9267386, + 33.538147503949219 + ], + [ + -111.9263679276177, + 33.5381109959061 + ], + [ + -111.9260114999672, + 33.538002874760373 + ], + [ + -111.92568301436319, + 33.537827295547032 + ], + [ + -111.92539509432322, + 33.537591005676774 + ], + [ + -111.92515880445296, + 33.537303085636808 + ], + [ + -111.92498322523961, + 33.5369746000328 + ], + [ + -111.92487510409389, + 33.536618172382283 + ], + [ + -111.92483859605078, + 33.5362475 + ] + ] + ] + } + } + ] + } + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "ClientParams", + "message": "Request body is not a valid json.", + "innererror": { + "code": "InvalidJson", + "message": "Only 2 Json Objects accepted; Received: 1 JSON Objects" + } + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/PostClosestPoint.json b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/PostClosestPoint.json new file mode 100644 index 000000000000..2d9b965497f2 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/PostClosestPoint.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "lat": 47.622942, + "lon": -122.316456, + "closestPointRequestBody": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "properties": { + "geometryId": 1001 + }, + "geometry": { + "type": "Point", + "coordinates": [ + -105.02860293715861, + 40.516153406773952 + ] + } + }, + { + "type": "Feature", + "properties": { + "geometryId": 1002 + }, + "geometry": { + "type": "Point", + "coordinates": [ + -105.02860381672178, + 40.515990990037309 + ] + } + }, + { + "type": "Feature", + "properties": { + "geometryId": 1003 + }, + "geometry": { + "type": "Point", + "coordinates": [ + -105.02812292879467, + 40.516058678088562 + ] + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "summary": { + "sourcePoint": { + "lat": 47.622942, + "lon": -122.316456 + }, + "udid": null, + "information": "3 points processed in user data" + }, + "result": [ + { + "distanceInMeters": 1587492.66, + "position": { + "lat": 40.516153406773952, + "lon": -105.02860293715861 + }, + "geometryId": "1001" + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "ClientParams", + "message": "One or more parameters are missing.", + "innererror": { + "code": "MissingQueryParameter", + "message": "Input parameter lon is missing." + } + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/PostGeofence.json b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/PostGeofence.json new file mode 100644 index 000000000000..d638ff7b7c6f --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/PostGeofence.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "deviceId": "unique_device_name_under_account", + "lat": 48.36, + "lon": -124.63, + "searchBuffer": 50, + "usertime": "2018-09-10T10:00:00", + "isAsync": true, + "mode": "EnterAndExit", + "subscription-key": "[subscription-key]", + "searchGeofenceRequestBody": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + -122.13241226662022, + 47.61701140091722 + ], + [ + -122.12810106940353, + 47.6169969269402 + ], + [ + -122.12824948956276, + 47.61907683751349 + ], + [ + -122.12833297981392, + 47.621929787055336 + ], + [ + -122.12971398040168, + 47.62184100705295 + ], + [ + -122.1318413862121, + 47.62195364373008 + ], + [ + -122.13231034769727, + 47.61716332618121 + ], + [ + -122.13241226662022, + 47.61701140091722 + ] + ] + ] + }, + "properties": { + "geometryId": "2", + "name": "Crossroad Mall" + } + }, + { + "type": "Feature", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + -122.1534220563239, + 47.60981818546625 + ], + [ + -122.153451623509, + 47.60628733146004 + ], + [ + -122.14971782206638, + 47.606250040787046 + ], + [ + -122.14817354810637, + 47.606391046012305 + ], + [ + -122.1482735128807, + 47.60983316796356 + ], + [ + -122.15225500989803, + 47.60982613678752 + ], + [ + -122.1534220563239, + 47.60981818546625 + ] + ] + ] + }, + "properties": { + "geometryId": "1", + "name": "Sammamish High school" + } + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "geometries": [ + { + "deviceId": "unique_device_name_under_account", + "geometryId": "2", + "distance": -999, + "nearestLat": 47.621954, + "nearestLon": -122.131841 + }, + { + "deviceId": "unique_device_name_under_account", + "geometryId": "1", + "distance": 999, + "nearestLat": 47.609833, + "nearestLon": -122.148274 + } + ], + "expiredGeofenceGeometryId": [], + "invalidPeriodGeofenceGeometryId": [], + "isEventPublished": true + } + }, + "400": { + "headers": { + "X-Correlation-ID": "80575fa1-2c1e-4738-834a-fcf45b58dd7c" + }, + "body": { + "error": { + "code": "BadRequest", + "message": "Lat and/or lon parameters are invalid.", + "innererror": { + "code": "InvalidLatLon" + } + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/PostPointInPolygon.json b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/PostPointInPolygon.json new file mode 100644 index 000000000000..5677897e923c --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/examples/PostPointInPolygon.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "lat": 33.5362475, + "lon": -111.9267386, + "pointInPolygonRequestBody": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "properties": { + "geometryId": 1001 + }, + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + -111.9267386, + 33.5362475 + ], + [ + -111.9627875, + 33.5104882 + ], + [ + -111.9027061, + 33.5004686 + ], + [ + -111.9267386, + 33.5362475 + ] + ] + ] + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "summary": { + "sourcePoint": { + "lat": 33.5362475, + "lon": -111.9267386 + }, + "udid": null, + "information": "1 polygons processed in user data" + }, + "result": { + "pointInPolygons": true, + "intersectingGeometries": [ + "1001" + ] + } + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "ClientParams", + "message": "Lat and/or lon parameters are invalid.", + "innererror": { + "code": "InvalidLatLon", + "message": "lon parameter value should between -180 and 180 inclusive" + } + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/spatial.json b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/spatial.json new file mode 100644 index 000000000000..06acf54d01db --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Spatial/preview/1.0/spatial.json @@ -0,0 +1,1604 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Spatial Service", + "version": "1.0", + "description": "Azure Maps Spatial REST APIs" + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json", + "application/xml" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "user_impersonation": "Impersonates a user's Azure Active Directory account." + } + }, + "apiKeyQuery": { + "type": "apiKey", + "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + } + }, + "security": [ + { + "azure_auth": [] + }, + { + "apiKeyQuery": [] + } + ], + "responses": { + "202": { + "description": "Request Accepted: The request has been accepted for processing. Please use the URL in the Location Header to retry or access the results.", + "headers": { + "Location": { + "type": "string", + "description": "New URL to check for the results of the long running process." + } + } + }, + "400": { + "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "401": { + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + }, + "headers": { + "WWW-Authenticate": { + "type": "string", + "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" + } + } + }, + "403": { + "description": "Permission, capacity, or authentication issues.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "404": { + "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "500": { + "description": "An error occurred while processing the request. Please try again later.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + } + }, + "parameters": { + "ClientId": { + "name": "x-ms-client-id", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "client" + }, + "SubscriptionKey": { + "name": "subscription-key", + "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API. Current version is 1.0", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "JsonFormat": { + "name": "format", + "description": "Desired format of the response. Only `json` format is supported.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "json" + ], + "x-ms-enum": { + "name": "JsonFormat", + "modelAsString": false, + "values": [ + { + "value": "json", + "description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "TextFormat": { + "name": "format", + "description": "Desired format of the response. Value can be either _json_ or _xml_.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "json", + "xml" + ], + "x-ms-enum": { + "name": "TextFormat", + "modelAsString": false, + "values": [ + { + "value": "json", + "description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)" + }, + { + "value": "xml", + "description": "[The Extensible Markup Language](https://www.w3.org/TR/xml/)" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "Mode": { + "name": "mode", + "in": "query", + "description": "Mode of the geofencing async event mechanism.", + "required": false, + "type": "string", + "enum": [ + "All", + "EnterAndExit" + ], + "x-ms-enum": { + "name": "GeofenceMode", + "modelAsString": false, + "values": [ + { + "value": "All", + "description": "Publish all the query results to Azure Maps account event subscription." + }, + { + "value": "EnterAndExit", + "description": "Only publish result when user location is considered as crossing geofencing boarder." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "UdidSpatial": { + "name": "udid", + "in": "query", + "description": "The unique id returned from [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SpatialDataUploadFormat": { + "name": "dataFormat", + "description": "Data format of the content being uploaded. Currently, only `geojson` format is supported.", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "geojson" + ], + "x-ms-enum": { + "name": "SpatialDataUploadFormat", + "modelAsString": false, + "values": [ + { + "value": "geojson", + "description": "[GeoJSON](https://tools.ietf.org/html/rfc7946) is a JSON based geospatial data interchange format." + } + ] + }, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/spatial/geofence/{format}": { + "get": { + "x-publish": true, + "description": "**Search Geofence Get API**\n\n**Applies to:** S1 Pricing tier.\n\nThe Geofence Get API allows you to retrieve the proximity of a coordinate to a \ngeofence that has been uploaded to the Data service. You can use the \n[Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) to upload \na geofence or set of fences. See [Geofencing GeoJSON data](https://docs.microsoft.com/en-us/azure/azure-maps/geofence-geojson) \nfor more details on the geofence data format. To query the proximity of a coordinate, you supply the location of the object you are tracking as well\nas the ID for the fence or set of fences, and the response will contain information about\nthe distance from the outer edge of the geofence. A negative value signifies that the \ncoordinate is inside of the fence while a positive value means that it is outside of the\nfence.

This API can be used for a variety of scenarios that include things like asset \ntracking, fleet management, or setting up alerts for moving objects.\n\nThe API supports [integration with Event Grid](https://docs.microsoft.com/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default).\nTo test this API, you can upload the sample data from Post Geofence API examples(Request Body) via Data Upload API and replace the [udid] from the sample request below with the udid returned by Data Upload API.\n\n\n### Geofencing InnerError code\n\nIn geofencing response error contract, `innererror` is an object containing service specific information about the error. `code` is a property in `innererror` which can map to a specific geofencing error type. The table belows shows the code mapping between all the known client error type to the corresponding geofencing error `message`.\n\ninnererror.code | error.message\n---------------------------- | -------------------------------------- \nNullDeviceId | Device Id should not be null.\nNullUdid\t | Udid should not be null.\nUdidWrongFormat| Udid should be acquired from user data ingestion API.\nInvalidUserTime| Usertime is invalid.\nInvalidSearchBuffer| Searchbuffer is invalid.\nInvalidSearchRange| The value range of searchbuffer should be from 0 to 500 meters.\nInvalidLatLon| Lat and/or lon parameters are invalid.\nInvalidIsAsyncValue| The IsAsync parameter is invalid.\nInvalidModeValue| The mode parameter invalid.\nInvalidJson| Geofencing data is not a valid json file.\nNotSupportedGeoJson| Geofencing data can't be read as a Feature or FeatureCollections.\nInvalidGeoJson| Geofencing data is invalid.\nNoUserDataWithAccountOrSubscription| Can't find user geofencing data with provided account-id and/or subscription-id.\nNoUserDataWithUdid|\tCan't find user geofencing data with provided udId.", + "operationId": "Spatial_GetGeofence", + "x-ms-examples": { + "Geofence": { + "$ref": "./examples/GetGeofence.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "deviceId", + "in": "query", + "description": "ID of the device", + "required": true, + "type": "string" + }, + { + "name": "udId", + "in": "query", + "description": "The unique id returned from [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.", + "required": true, + "type": "string" + }, + { + "name": "lat", + "in": "query", + "description": "The latitude of the location being passed. Example: 48.36.", + "required": true, + "type": "number" + }, + { + "name": "lon", + "in": "query", + "description": "The longitude of the location being passed. Example: -124.63.", + "required": true, + "type": "number" + }, + { + "name": "z", + "in": "query", + "description": "The sea level in meter of the location being passed. If this parameter is presented, 2D extrusion is used. Example: 200.", + "required": false, + "type": "number" + }, + { + "name": "userTime", + "in": "query", + "description": "The user request time. If not presented in the request, the default value is DateTime.Now.", + "required": false, + "type": "string" + }, + { + "name": "searchBuffer", + "in": "query", + "description": "The radius of the buffer around the geofence in meters that defines how far to search inside and outside the border of the fence against the coordinate that was provided when calculating the result. The minimum value is 0, and the maximum is 500. The default value is 50.", + "required": false, + "type": "number", + "minimum": 0, + "maximum": 500, + "default": 50 + }, + { + "name": "isAsync", + "in": "query", + "description": "If true, the request will use async event mechanism; if false, the request will be synchronized and do not trigger any event. The default value is false.", + "required": false, + "type": "boolean", + "default": false + }, + { + "$ref": "#/parameters/Mode" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK The X-Correlation-id header value is present in an async call's response and the Event Grid event data. It helps correlate the async call’s response with the corresponding Event Grid event.", + "headers": { + "X-Correlation-id": { + "description": "Value present in an async call's response and the Event Grid event data. It helps correlate the async call’s response with the corresponding Event Grid event.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/GeofenceResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + }, + "post": { + "x-publish": true, + "description": "**Search Geofence Post API**\n**Applies to:** S1 Pricing tier.\nThe Geofence Post API allows you to retrieve the proximity of a coordinate to a provided geofence or set of fences. With POST call, you do not have to upload the fence data in advance, instead you supply the location of the object you are tracking in query parameters as well as the fence or set of fences data in post request body. See [Geofencing GeoJSON data](https://docs.microsoft.com/en-us/azure/azure-maps/geofence-geojson) for more details on the geofence data format. The response will contain information about the distance from the outer edge of the geofence. A negative value signifies that the coordinate is inside of the fence while a positive value means that it is outside of the fence.

This API can be used for a variety of scenarios that include things like asset tracking, fleet management, or setting up alerts for moving objects.\n\nThe API supports [integration with Event Grid](https://docs.microsoft.com/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default).", + "operationId": "Spatial_PostGeofence", + "x-ms-examples": { + "Geofence": { + "$ref": "./examples/PostGeofence.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "deviceId", + "in": "query", + "description": "ID of the device", + "required": true, + "type": "string" + }, + { + "name": "lat", + "in": "query", + "description": "The latitude of the location being passed. Example: 48.36.", + "required": true, + "type": "number" + }, + { + "name": "lon", + "in": "query", + "description": "The longitude of the location being passed. Example: -124.63.", + "required": true, + "type": "number" + }, + { + "name": "z", + "in": "query", + "description": "The sea level in meter of the location being passed. If this parameter is presented, 2D extrusion geofencing is applied. Example: 200.", + "required": false, + "type": "number" + }, + { + "name": "userTime", + "in": "query", + "description": "The user request time. If not presented in the request, the default value is DateTime.UtcNow.", + "required": false, + "type": "string" + }, + { + "name": "searchBuffer", + "in": "query", + "description": "The radius of the buffer around the geofence in meters that defines how far to search inside and outside the border of the fence against the coordinate that was provided when calculating the result. The minimum value is 0, and the maximum is 500. The default value is 50.", + "required": false, + "type": "number", + "minimum": 0, + "maximum": 500, + "default": 50 + }, + { + "name": "isAsync", + "in": "query", + "description": "If true, the request will use async event mechanism; if false, the request will be synchronized and do not trigger any event. The default value is false.", + "required": false, + "type": "boolean", + "default": false + }, + { + "$ref": "#/parameters/Mode" + }, + { + "name": "searchGeofenceRequestBody", + "in": "body", + "description": "The geofencing GeoJSON data.", + "required": true, + "schema": { + "$ref": "#/definitions/GeoJSONFeatureCollection" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK The X-Correlation-id header value is present in an async call's response and the Event Grid event data. It helps correlate the async call’s response with the corresponding Event Grid event.", + "headers": { + "X-Correlation-id": { + "description": "Value present in an async call's response and the Event Grid event data. It helps correlate the async call’s response with the corresponding Event Grid event.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/GeofenceResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/spatial/buffer/{format}": { + "post": { + "x-publish": true, + "description": "**Applies to**: S1 pricing tier.\n\nThis API returns a FeatureCollection where each Feature is a buffer around the corresponding indexed Feature of the input. The buffer could be either on the outside or the inside of the provided Feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the FeatureCollection input, or if only one distance is provided, then that distance is applied to every Feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided.", + "operationId": "Spatial_PostBuffer", + "x-ms-examples": { + "PostBuffer": { + "$ref": "./examples/PostBuffer.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "bufferRequestBody", + "in": "body", + "description": "The FeatureCollection and the list of distances (one per feature or one for all features).", + "required": true, + "schema": { + "$ref": "#/definitions/BufferRequestBody" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BufferResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + }, + "get": { + "x-publish": true, + "description": "**Applies to**: S1 pricing tier.\n\nThis API returns a FeatureCollection where each Feature is a buffer around the corresponding indexed Feature of the input. The buffer could be either on the outside or the inside of the provided Feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the FeatureCollection input, or if only one distance is provided, then that distance is applied to every Feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input features are provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided. \n\nTo test this API, you can upload the sample data from [Post Buffer API](https://docs.microsoft.com/en-us/rest/api/maps/spatial/postbuffer#examples) examples(Request Body without distances array) via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and replace the [udid] from the [sample request below](https://docs.microsoft.com/en-us/rest/api/maps/spatial/getbuffer#examples) with the udid returned by Data Upload API.", + "operationId": "Spatial_GetBuffer", + "x-ms-examples": { + "GetBuffer": { + "$ref": "./examples/GetBuffer.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "$ref": "#/parameters/UdidSpatial" + }, + { + "name": "distances", + "in": "query", + "description": "The list of distances (one per feature or one for all features), delimited by semicolons. For example, 12.34;-56.78. Positive distance will generate a buffer outside of the feature, whereas negative distance will generate a buffer inside of the feature. If the negative distance larger than the geometry itself, an empty polygon will be returned.", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BufferResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/spatial/closestPoint/{format}": { + "post": { + "x-publish": true, + "description": "**Applies to**: S1 pricing tier.\n\nThis API returns the closest point between a base point and a given set of target points. The set of target points is provided by user data in post request body. The user data may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The algorithm does not take into account routing or traffic. The maximum number of points accepted is 100,000. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.", + "operationId": "Spatial_PostClosestPoint", + "x-ms-examples": { + "PostClosestPoint": { + "$ref": "./examples/PostClosestPoint.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "lat", + "in": "query", + "description": "The base point latitude of the location being passed. Example: 47.622942.", + "required": true, + "type": "number" + }, + { + "name": "lon", + "in": "query", + "description": "The base point longitude of the location being passed. Example: -122.316456.", + "required": true, + "type": "number" + }, + { + "name": "numberOfClosestPoints", + "in": "query", + "description": "The number of closest points expected from response. Default: 1, minimum: 1 and maximum: 50", + "required": false, + "type": "integer" + }, + { + "name": "closestPointRequestBody", + "in": "body", + "description": "The FeatureCollection of Point geometries from which closest point to source point should be determined. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.", + "required": true, + "schema": { + "$ref": "#/definitions/GeoJSONFeatureCollection" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PostClosestPointResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + }, + "get": { + "x-publish": true, + "description": "**Applies to**: S1 pricing tier.\n\nThis API returns the closest point between a base point and a given set of points in the user uploaded data set identified by udid. The set of target points is provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The maximum number of points accepted is 100,000. The algorithm does not take into account routing or traffic. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.\n\nTo test this API, you can upload the sample data from [Post Closest Point API](https://docs.microsoft.com/en-us/rest/api/maps/spatial/postclosestpoint#examples) examples(Request Body) via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and replace the [udid] from the [sample request below](https://docs.microsoft.com/en-us/rest/api/maps/spatial/getclosestpoint#examples) with the udid returned by Data Upload API.", + "operationId": "Spatial_GetClosestPoint", + "x-ms-examples": { + "GetClosestPoint": { + "$ref": "./examples/GetClosestPoint.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "$ref": "#/parameters/UdidSpatial" + }, + { + "name": "lat", + "in": "query", + "description": "The base point latitude of the location being passed. Example: 47.622942.", + "required": true, + "type": "number" + }, + { + "name": "lon", + "in": "query", + "description": "The base point longitude of the location being passed. Example: -122.316456.", + "required": true, + "type": "number" + }, + { + "name": "numberOfClosestPoints", + "in": "query", + "description": "The number of closest points expected from response. Default: 1, minimum: 1 and maximum: 50", + "required": false, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GetClosestPointResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/spatial/pointInPolygon/{format}": { + "post": { + "x-publish": true, + "description": "**Applies to**: S1 pricing tier.\n\nThis API returns a boolean value indicating whether a point is inside a set of polygons. The user data may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries (referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.", + "operationId": "Spatial_PostPointInPolygon", + "x-ms-examples": { + "PostPointInPolygon": { + "$ref": "./examples/PostPointInPolygon.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "lat", + "in": "query", + "description": "The base point latitude of the location being passed. Example: 47.622942.", + "required": true, + "type": "number" + }, + { + "name": "lon", + "in": "query", + "description": "The base point longitude of the location being passed. Example: -122.316456.", + "required": true, + "type": "number" + }, + { + "name": "pointInPolygonRequestBody", + "in": "body", + "description": "A FeatureCollection with a set of Polygon/MultiPolygon geometries. The maximum number of vertices accepted to form a Polygon is 10,000. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.", + "required": true, + "schema": { + "$ref": "#/definitions/GeoJSONFeatureCollection" + } + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PostPointInPolygonResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + }, + "get": { + "x-publish": true, + "description": "**Applies to**: S1 pricing tier.\n\nThis API returns a boolean value indicating whether a point is inside a set of polygons. The set of polygons is provided by a GeoJSON file which is uploaded via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and referenced by a unique udid. The GeoJSON file may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries(referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.\n\n \nTo test this API, you can upload the sample data from [Post Point In Polygon API](https://docs.microsoft.com/en-us/rest/api/maps/spatial/postpointinpolygon#examples) examples(Request Body) via [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) and replace the [udid] from the [sample request below](https://docs.microsoft.com/en-us/rest/api/maps/spatial/getpointinpolygon#examples) with the udid returned by Data Upload API.", + "operationId": "Spatial_GetPointInPolygon", + "x-ms-examples": { + "GetPointInPolygon": { + "$ref": "./examples/GetPointInPolygon.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "$ref": "#/parameters/UdidSpatial" + }, + { + "name": "lat", + "in": "query", + "description": "The base point latitude of the location being passed. Example: 47.622942.", + "required": true, + "type": "number" + }, + { + "name": "lon", + "in": "query", + "description": "The base point longitude of the location being passed. Example: -122.316456.", + "required": true, + "type": "number" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GetPointInPolygonResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/spatial/greatCircleDistance/{format}": { + "get": { + "x-publish": true, + "description": "**Applies to**: S1 pricing tier.\n\nThis API will return the great-circle or shortest distance between two points on the surface of a sphere, measured along the surface of the sphere. This differs from calculating a straight line through the sphere's interior. This method is helpful for estimating travel distances for airplanes by calculating the shortest distance between airports.", + "operationId": "Spatial_GetGreatCircleDistance", + "x-ms-examples": { + "GetGreatCircleDistance": { + "$ref": "./examples/GetGreatCircleDistance.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "query", + "in": "query", + "description": "The Coordinates through which the distance is calculated, delimited by a colon. Two coordinates are required. The first one is the source point coordinate and the last is the target point coordinate. For example, 47.622942,122.316456:57.673988,127.121513", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GreatCircleDistanceResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + } + }, + "definitions": { + "ODataErrorResponse": { + "type": "object", + "description": "This response object is returned when an error occurs in the Maps API.", + "properties": { + "error": { + "$ref": "#/definitions/ODataError" + } + } + }, + "ODataError": { + "type": "object", + "description": "This object is returned when an error occurs in the Maps API.", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The ODataError code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + } + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the target causing the error." + } + } + }, + "SpatialCoordinate": { + "description": "A location represented as a latitude and longitude", + "type": "object", + "properties": { + "lat": { + "description": "Latitude property", + "type": "number", + "format": "double", + "readOnly": true + }, + "lon": { + "description": "Longitude property", + "type": "number", + "format": "double", + "readOnly": true + } + } + }, + "GeoJSONFeatureCollection": { + "description": "A valid `GeoJSON FeatureCollection` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details.", + "type": "object", + "properties": { + "type": { + "description": "Specifies the `type` for the object. Value should always be equal to \"FeatureCollection\".", + "type": "string" + }, + "features": { + "description": "Contains a list of valid `GeoJSON Feature` objects.", + "type": "array", + "items": { + "description": "A valid `GeoJSON Feature` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.2) for details.", + "type": "object", + "properties": { + "type": { + "description": "Specifies the `type` for the object. Value should always be equal to \"Feature\".", + "type": "string" + }, + "geometry": { + "$ref": "#/definitions/GeoJSONGeometry" + }, + "properties": { + "description": "Properties can contain any additional metadata about the `Feature`. Value can be any JSON object or a JSON null value", + "type": "object" + } + } + } + } + }, + "required": [ + "features", + "type" + ] + }, + "GeoJSONGeometry": { + "description": "A valid `GeoJSON` geometry object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1) for details.", + "type": "object", + "discriminator": "type", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "Specifies the `GeoJSON` geometry type. Must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection.", + "type": "string", + "enum": [ + "Point", + "MultiPoint", + "LineString", + "MultiLineString", + "Polygon", + "MultiPolygon", + "GeometryCollection" + ], + "x-ms-enum": { + "name": "GeoJSONGeometryType", + "modelAsString": false, + "values": [ + { + "value": "Point", + "description": "`GeoJSON Point` geometry." + }, + { + "value": "MultiPoint", + "description": "`GeoJSON MultiPoint` geometry." + }, + { + "value": "LineString", + "description": "`GeoJSON LineString` geometry." + }, + { + "value": "MultiLineString", + "description": "`GeoJSON MultiLineString` geometry." + }, + { + "value": "Polygon", + "description": "`GeoJSON Polygon` geometry." + }, + { + "value": "MultiPolygon", + "description": "`GeoJSON MultiPolygon` geometry." + }, + { + "value": "GeometryCollection", + "description": "`GeoJSON GeometryCollection` geometry." + } + ] + } + } + } + }, + "Point": { + "description": "A valid `GeoJSON Point` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.2) for details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJSONGeometry" + }, + { + "properties": { + "type": { + "description": "Specifies the `type` for the geometry. Value should always be equal to \"Point\".", + "type": "string" + }, + "coordinates": { + "$ref": "#/definitions/GeoJSONPosition" + } + }, + "required": [ + "coordinates" + ] + } + ] + }, + "MultiLineString": { + "description": "A valid `GeoJSON MultiLineString` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.5) for details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJSONGeometry" + }, + { + "properties": { + "type": { + "description": "Specifies the `type` for the geometry. Value should always be equal to \"MultiLineString\".", + "type": "string" + }, + "coordinates": { + "description": "Coordinates for the `MultiLineString` geometry.", + "type": "array", + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/GeoJSONPosition" + } + } + } + }, + "required": [ + "coordinates" + ] + } + ] + }, + "Polygon": { + "description": "A valid `GeoJSON Polygon` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.6) for details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJSONGeometry" + }, + { + "properties": { + "type": { + "description": "Specifies the `type` for the object. Value should always be equal to \"Polygon\".", + "type": "string" + }, + "coordinates": { + "description": "Coordinates for the `Polygon` geometry type.", + "type": "array", + "items": { + "$ref": "#/definitions/GeoJSONLinearRing" + } + } + }, + "required": [ + "coordinates" + ] + } + ] + }, + "MultiPolygon": { + "description": "A valid `GeoJSON MultiPolygon` object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.7) for details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/GeoJSONGeometry" + }, + { + "properties": { + "type": { + "description": "Specifies the `type` for the object. Value should always be equal to \"MultiPolygon\".", + "type": "string" + }, + "coordinates": { + "description": "Contains a list of valid `GeoJSON` Polygon objects. **Note** that coordinates in GeoJSON are in x, y order (longitude, latitude).", + "type": "array", + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/GeoJSONLinearRing" + } + } + } + }, + "required": [ + "coordinates" + ] + } + ] + }, + "GeoJSONLinearRing": { + "description": "Though a linear ring is not explicitly represented as a GeoJSON geometry type, it helps in defining the polygon as an array of linear rings. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.6) for details.", + "type": "array", + "items": { + "$ref": "#/definitions/GeoJSONPosition" + } + }, + "GeoJSONPosition": { + "description": "A valid `GeoJSON Position` geometry type. A `Position` is an array of numbers with two or more elements. The first two elements are _longitude_ and _latitude_, precisely in that order. _Altitude/Elevation_ is an optional third element. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.1) for details.", + "type": "array", + "items": { + "type": "number", + "format": "double" + } + }, + "GeofenceGeometry": { + "description": "The geofencing geometry.", + "type": "object", + "readOnly": true, + "properties": { + "deviceId": { + "description": "ID of the device.", + "type": "string", + "readOnly": true + }, + "udId": { + "description": "The unique id returned from [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data/uploadPreview) after uploading a valid GeoJSON FeatureCollection object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.", + "type": "string", + "readOnly": true + }, + "geometryId": { + "description": "The unique id identifies a geometry.", + "type": "string", + "readOnly": true + }, + "distance": { + "description": "Distance from the coordinate to the closest border of the geofence. Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border, then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence.", + "type": "number", + "readOnly": true + }, + "nearestLat": { + "description": "Latitude of the nearest point of the geometry.", + "type": "number", + "readOnly": true + }, + "nearestLon": { + "description": "Longitude of the nearest point of the geometry.", + "type": "number", + "readOnly": true + }, + "nearestZ": { + "description": "Sea level in meter of the nearest point on the 2D extrusion geometry. This will only be presented in response when value is provided for 'zInMeter' in the request.", + "type": "number", + "readOnly": true + } + } + }, + "GeofenceResponse": { + "description": "This object is returned from a geofence proximity call.", + "type": "object", + "properties": { + "geometries": { + "description": "Lists the fence geometries that contain the coordinate position or overlap the searchBuffer around the position.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/GeofenceGeometry" + } + }, + "expiredGeofenceGeometryId": { + "description": "Lists of the geometry ID of the geofence which is expired relative to the user time in the request.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "invalidPeriodGeofenceGeometryId": { + "description": "Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "isEventPublished": { + "description": "True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber. This will only be presented in response when 'isAsync' query parameter is set to true.", + "type": "boolean", + "readOnly": true + } + } + }, + "BufferRequestBody": { + "description": "An object with a FeatureCollection and a list of distances. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive.", + "type": "object", + "properties": { + "geometries": { + "$ref": "#/definitions/GeoJSONFeatureCollection" + }, + "distances": { + "description": "List of the distances to compute the buffer for, one-to-one per Feature in the collection, or one for all Features in the collection.", + "type": "array", + "items": { + "type": "number" + } + } + } + }, + "BufferResponse": { + "description": "This object is returned from a successful Spatial Buffer call.", + "type": "object", + "properties": { + "summary": { + "description": "Summary of the call.", + "type": "object", + "readOnly": true, + "properties": { + "udid": { + "description": "The udid for the user data if one exists", + "type": "string", + "readOnly": true + }, + "information": { + "description": "The information about what happened during the call.", + "type": "string", + "readOnly": true + } + } + }, + "result": { + "description": "The FeatureCollection of buffers for the input.", + "$ref": "#/definitions/GeoJSONFeatureCollection" + } + } + }, + "BoundingBoxResponse": { + "description": "This object is returned from a successful Spatial BoundingBox call.", + "type": "object", + "properties": { + "summary": { + "description": "Summary of the call.", + "type": "object", + "readOnly": true, + "properties": { + "udid": { + "description": "The udid for the user data if one exists", + "type": "string", + "readOnly": true + }, + "information": { + "description": "The information about what happened during the call.", + "type": "string", + "readOnly": true + } + } + }, + "result": { + "description": "The bounding box of the input feature collection.", + "type": "object", + "readOnly": true, + "properties": { + "feature": { + "description": "The resulting feature with bounding box geometry", + "type": "object", + "readOnly": true + } + } + } + } + }, + "GetClosestPointResponse": { + "description": "This object is returned from a successful Get Spatial Closest Point call", + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/GetClosestPointSummary" + }, + "result": { + "$ref": "#/definitions/ClosestPointResult" + } + } + }, + "PostClosestPointResponse": { + "description": "This object is returned from a successful Post Spatial Closest Point call", + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/PostClosestPointSummary" + }, + "result": { + "$ref": "#/definitions/ClosestPointResult" + } + } + }, + "GetClosestPointSummary": { + "description": "Get Closest Point Summary object", + "type": "object", + "readOnly": true, + "properties": { + "sourcePoint": { + "$ref": "#/definitions/SpatialCoordinate" + }, + "udid": { + "description": "A unique data id (udid) for the uploaded content", + "type": "string", + "readOnly": true + }, + "information": { + "description": "Processing information", + "type": "string", + "readOnly": true + } + } + }, + "PostClosestPointSummary": { + "description": "Post Closest Point Summary object", + "type": "object", + "readOnly": true, + "properties": { + "sourcePoint": { + "$ref": "#/definitions/SpatialCoordinate" + }, + "udid": { + "description": "A unique data id (udid) for the uploaded content. Udid is not applicable for POST spatial operations(set to null)", + "type": "string", + "readOnly": true + }, + "information": { + "description": "Processing information", + "type": "string", + "readOnly": true + } + } + }, + "ClosestPointResult": { + "description": "Closest Point Result Array", + "type": "array", + "items": { + "$ref": "#/definitions/ClosestPointResultEntry" + } + }, + "ClosestPointResultEntry": { + "description": "Closest Point Result Entry Object", + "type": "object", + "readOnly": true, + "properties": { + "distanceInMeters": { + "description": "The distance in meters from the source point to the closest point", + "type": "number", + "readOnly": true + }, + "position": { + "$ref": "#/definitions/SpatialCoordinate" + }, + "geometryId": { + "description": "The unique id identifies a geometry", + "type": "string", + "readOnly": true + } + } + }, + "GetPointInPolygonResponse": { + "description": "Returns true if point is within the polygon, false otherwise", + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/GetPointInPolygonSummary" + }, + "result": { + "$ref": "#/definitions/PointInPolygonResult" + } + } + }, + "PostPointInPolygonResponse": { + "description": "Returns true if point is within the polygon, false otherwise", + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/PostPointInPolygonSummary" + }, + "result": { + "$ref": "#/definitions/PointInPolygonResult" + } + } + }, + "GetPointInPolygonSummary": { + "description": "Point In Polygon Summary object", + "type": "object", + "readOnly": true, + "properties": { + "sourcePoint": { + "$ref": "#/definitions/SpatialCoordinate" + }, + "udid": { + "description": "A unique data id (udid) for the uploaded content", + "type": "string", + "readOnly": true + }, + "information": { + "description": "Processing information", + "type": "string", + "readOnly": true + } + } + }, + "PostPointInPolygonSummary": { + "description": "Point In Polygon Summary object", + "type": "object", + "readOnly": true, + "properties": { + "sourcePoint": { + "$ref": "#/definitions/SpatialCoordinate" + }, + "udid": { + "description": "A unique data id (udid) for the uploaded content. Udid is not applicable for POST spatial operations(set to null)", + "type": "string", + "readOnly": true + }, + "information": { + "description": "Processing information", + "type": "string", + "readOnly": true + } + } + }, + "PointInPolygonResult": { + "description": "Point In Polygon Result Object", + "type": "object", + "properties": { + "pointInPolygons": { + "description": "Point In Polygons Property", + "type": "boolean", + "readOnly": true + }, + "intersectingGeometries": { + "description": "Geometries array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/GeometryId" + } + } + } + }, + "GeometryId": { + "description": "The Spatial geometry", + "type": "string", + "readOnly": true + }, + "GreatCircleDistanceResponse": { + "description": "This object is returned from a successful Great Circle Distance call", + "type": "object", + "properties": { + "summary": { + "description": "Summary object", + "type": "object", + "readOnly": true, + "properties": { + "sourcePoint": { + "$ref": "#/definitions/SpatialCoordinate" + }, + "targetPoint": { + "$ref": "#/definitions/SpatialCoordinate" + } + } + }, + "result": { + "description": "Result Object", + "type": "object", + "readOnly": true, + "properties": { + "distanceInMeters": { + "description": "The great circle distance in meters from the source point to the target point", + "type": "number", + "readOnly": true + } + } + } + } + }, + "UploadDataRequestBody": { + "description": "This type represents the request body for Spatial Data Upload.", + "type": "object" + }, + "UploadDataResponse": { + "description": "The response model for the spatial data upload API. Returns a unique data id (udid) for the uploaded content.", + "type": "object", + "properties": { + "udid": { + "description": "A unique data id (udid) for the uploaded content.", + "type": "string", + "readOnly": true + } + } + }, + "UploadDataAcceptedResponse": { + "description": "The response model for the spatial data upload API. Returns the current status and a status URI.", + "type": "object", + "properties": { + "status": { + "description": "Current status of the long running upload operation.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/examples/Create.json b/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/examples/Create.json new file mode 100644 index 000000000000..8767d242b699 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/examples/Create.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "datasetId": "[dataset-Id]" + }, + "responses": { + "201": { + "headers": { + "Location": "https://atlas.microsoft.com/tileset/{tilesetId}?api-version=1.0", + "Access-Control-Expose-Headers": "Location" + }, + "body": { + "operationId": "{operationId}", + "status": "Succeeded", + "created": "2020-01-02 1:02:03 AM +00:00", + "resourceLocation": "https://atlas.microsoft.com/tileset/{tilesetId}?api-version=1.0" + } + }, + "202": { + "headers": { + "Location": "https://atlas.microsoft.com/tileset/operations/{operationId}?api-version=1.0", + "Access-Control-Expose-Headers": "Location" + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/examples/Delete.json b/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/examples/Delete.json new file mode 100644 index 000000000000..8f36f5a7d813 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/examples/Delete.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]", + "tilesetId": "25084fb7-307a-4720-8f91-7952a0b91012" + }, + "responses": { + "204": { + "body": {} + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/examples/List.json b/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/examples/List.json new file mode 100644 index 000000000000..382cb4025edf --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/examples/List.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "1.0", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "tilesets": [ + { + "tilesetId": "d8fa86de-bb0f-4a02-a6ff-62ae7545dd84", + "datasetId": "63b18a6b-ac35-4b23-a1d9-ffa1003ad50b", + "description": "My first tileset", + "minZoom": 16, + "maxZoom": 18, + "bbox": [ + -122.13595, + 47.636524, + -122.1329, + 47.637525 + ] + }, + { + "tilesetId": "b8dca8b3-8aad-4afe-abd6-0efe37b5a2e3", + "datasetId": "c0a01139-662e-4d5a-bf5f-92ea4a292aad", + "description": "My second tileset", + "minZoom": 19, + "maxZoom": 19, + "bbox": [ + -122.13595, + 47.636524, + -122.1329, + 47.637525 + ] + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/tileset.json b/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/tileset.json new file mode 100644 index 000000000000..fa4aaaf6ef44 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Tileset/preview/1.0/tileset.json @@ -0,0 +1,479 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Tileset Service", + "version": "1.0", + "description": "APIs for managing Tilesets." + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "user_impersonation": "Impersonates a user's Azure Active Directory account." + } + }, + "apiKeyQuery": { + "type": "apiKey", + "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + } + }, + "security": [ + { + "azure_auth": [] + }, + { + "apiKeyQuery": [] + } + ], + "responses": { + "400": { + "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "401": { + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + }, + "headers": { + "WWW-Authenticate": { + "type": "string", + "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" + } + } + }, + "403": { + "description": "Permission, capacity, or authentication issues.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "404": { + "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "500": { + "description": "An error occurred while processing the request. Please try again later.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "201Async": { + "description": "The resource has been created successfully.", + "schema": { + "$ref": "#/definitions/LongRunningOperationResult" + }, + "headers": { + "Location": { + "type": "string", + "description": "A URI where details on the newly created resource can be found." + } + } + }, + "202Async": { + "description": "**Supported only for async request.**\nRequest Accepted: The request has been accepted for processing. Please use the URL in the Location Header to retry or access the results.", + "headers": { + "Location": { + "type": "string", + "description": "New URL to check for the results of the long running process." + } + } + } + }, + "parameters": { + "ClientId": { + "name": "x-ms-client-id", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "client" + }, + "SubscriptionKey": { + "name": "subscription-key", + "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API. Current version is 1.0", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "JsonFormat": { + "name": "format", + "description": "Desired format of the response. Only `json` format is supported.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "json" + ], + "x-ms-enum": { + "name": "JsonFormat", + "modelAsString": false, + "values": [ + { + "value": "json", + "description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "DatasetIdQuery": { + "name": "datasetId", + "description": "The unique `datasetId` that the tileset create API uses to retrieve features to generate tiles. The `datasetId` must have been obtained from a successful [Dataset Create API](/en-us/rest/api/maps/dataset/createpreview) call.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "client" + }, + "TilesetId": { + "name": "tilesetId", + "description": "The Tileset Id", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "DescriptionTileset": { + "name": "description", + "description": "User provided description of the tileset.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/tileset/create/vector": { + "post": { + "x-publish": true, + "description": "**Tileset Create API**\n\n**Applies to**: S1 pricing tier.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API \nand SDK. The Tileset API is part of Creator.\n\nThe Tileset Create API allows the caller to create a tileset from a dataset. A tileset contains a set of tiles that can be consumed \nfrom the [Get Map Tile](/rest/api/maps/render/getmaptile) to retrieve custom tiles. To make a dataset, use the \n[DataSet Create API](/rest/api/maps/dataset/createpreview).\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an empty body. The `datasetId` query parameter will be \nused as the source of the tileset data.\n\nThe Create Tileset API is a \n[long-running request](https://aka.ms/am-creator-lrt).", + "operationId": "Tileset_CreatePreview", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Create Tileset by providing a Dataset Id": { + "$ref": "./examples/Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/DatasetIdQuery" + }, + { + "$ref": "#/parameters/DescriptionTileset" + } + ], + "responses": { + "201": { + "$ref": "#/responses/201Async" + }, + "202": { + "$ref": "#/responses/202Async" + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/tileset": { + "get": { + "x-publish": true, + "description": "**Tileset List API**\n\n**Applies to:** S1 pricing tier.\n
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Tileset API is part of Creator.\nThis API allows the caller to fetch a list of all tilesets created. \n
", + "operationId": "Tileset_ListPreview", + "x-ms-examples": { + "Get a list of all tilesets": { + "$ref": "./examples/List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "List tileset request completed successfully. The response body contains a list of all tilesets.", + "schema": { + "$ref": "#/definitions/TilesetListResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/tileset/{tilesetId}": { + "delete": { + "x-publish": true, + "description": "**Tileset Delete API**\n\n**Applies to:** S1 pricing tier.\n
\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Tileset API is part of Creator.\nThis API allows the caller to delete a created tileset.
\nYou can use this API if a tileset is no longer needed. \n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `tilesetId` of the tileset to delete.
\n\n#### Delete request \"Successful\"\n\nThe Tileset Delete API returns a HTTP `204 No Content` response with an empty body, if the tileset was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the tileset with the passed-in `tilesetId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Tileset Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", + "operationId": "Tileset_DeletePreview", + "x-ms-examples": { + "Delete a created tileset": { + "$ref": "./examples/Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TilesetId" + } + ], + "responses": { + "204": { + "description": "Tileset delete request completed successfully.", + "schema": { + "$ref": "#/definitions/TilesetDeleteResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + } + }, + "definitions": { + "ODataErrorResponse": { + "type": "object", + "description": "This response object is returned when an error occurs in the Maps API.", + "properties": { + "error": { + "$ref": "#/definitions/ODataError" + } + } + }, + "ODataError": { + "type": "object", + "description": "This object is returned when an error occurs in the Maps API.", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The ODataError code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + } + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the target causing the error." + } + } + }, + "LongRunningOperationResult": { + "description": "The response model for a Long-Running Operations API.", + "type": "object", + "properties": { + "operationId": { + "description": "The Id for this long-running operation.", + "type": "string" + }, + "status": { + "description": "The status state of the request.", + "type": "string", + "enum": [ + "NotStarted", + "Running", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": false, + "values": [ + { + "value": "NotStarted", + "description": "The request has not started processing yet." + }, + { + "value": "Running", + "description": "The request has started processing." + }, + { + "value": "Failed", + "description": "The request has one or more failures." + }, + { + "value": "Succeeded", + "description": "The request has successfully completed." + } + ] + }, + "readOnly": true + }, + "created": { + "description": "The created timestamp.", + "type": "string", + "readOnly": true + }, + "resourceLocation": { + "description": "The location URI for details about the created resource. This is only provided when the request was successfully completed.", + "type": "string", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/ODataError" + }, + "warning": { + "$ref": "#/definitions/ODataError" + } + } + }, + "TilesetListResponse": { + "description": "The response model for the Tileset List API. Returns a list of all tilesets.", + "type": "object", + "properties": { + "tilesets": { + "description": "A list of all tilesets.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TilesetDetailInfo" + } + } + } + }, + "TilesetDetailInfo": { + "description": "Detail information for the data.", + "type": "object", + "properties": { + "tilesetId": { + "description": "The unique tileset id for the tileset.", + "type": "string", + "readOnly": true + }, + "datasetId": { + "description": "The unique dataset Id used to create the tileset.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description the caller provided when creating the tileset. Maximum length 1024 characters.", + "type": "string", + "readOnly": true + }, + "minZoom": { + "description": "The lowest tile zoom level tile generated for the tileset.", + "type": "integer", + "readOnly": true + }, + "maxZoom": { + "description": "The highest tile zoom level tile generated for the tileset.", + "type": "integer", + "readOnly": true + }, + "bbox": { + "description": "Bounding box which all features of the tileset lay within. Projection used - EPSG:3857. Format : 'minLon, minLat, maxLon, maxLat'.", + "type": "array", + "readOnly": true, + "items": { + "type": "number" + } + } + } + }, + "TilesetDeleteResponse": { + "description": "The response model for the Delete API. The response body will be empty signifying there's no content available for the `tilesetId` anymore.", + "type": "object" + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneByCoordinates.json b/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneByCoordinates.json new file mode 100644 index 000000000000..da8cab2ca4b5 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneByCoordinates.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "query": "47.0,-122", + "options": "all", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "Version": "2019a", + "ReferenceUtcTimestamp": "2019-06-17T22:16:59.0765556Z", + "TimeZones": [ + { + "Id": "America/Los_Angeles", + "Aliases": [ + "US/Pacific", + "US/Pacific-New" + ], + "Countries": [ + { + "Name": "United States", + "Code": "US" + } + ], + "Names": { + "ISO6391LanguageCode": "en", + "Generic": "Pacific Time", + "Standard": "Pacific Standard Time", + "Daylight": "Pacific Daylight Time" + }, + "ReferenceTime": { + "Tag": "PDT", + "StandardOffset": "-08:00:00", + "DaylightSavings": "01:00:00", + "WallTime": "2019-06-17T15:16:59.0765556-07:00", + "PosixTzValidYear": 2019, + "PosixTz": "PST+8PDT,M3.2.0,M11.1.0", + "Sunrise": "2019-06-17T05:12:21.267-07:00", + "Sunset": "2019-06-17T21:05:18.017-07:00" + }, + "RepresentativePoint": { + "Latitude": 34.05222222222222, + "Longitude": -118.24277777777777 + }, + "TimeTransitions": [ + { + "Tag": "PDT", + "StandardOffset": "-08:00:00", + "DaylightSavings": "01:00:00", + "UtcStart": "2019-03-10T10:00:00Z", + "UtcEnd": "2019-11-03T09:00:00Z" + }, + { + "Tag": "PST", + "StandardOffset": "-08:00:00", + "DaylightSavings": "00:00:00", + "UtcStart": "2019-11-03T09:00:00Z", + "UtcEnd": "2020-03-08T10:00:00Z" + }, + { + "Tag": "PDT", + "StandardOffset": "-08:00:00", + "DaylightSavings": "01:00:00", + "UtcStart": "2020-03-08T10:00:00Z", + "UtcEnd": "2020-11-01T09:00:00Z" + } + ] + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneByID.json b/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneByID.json new file mode 100644 index 000000000000..e3b6480a99cb --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneByID.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "query": "Asia/Bahrain", + "options": "all", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "Version": "2018c", + "ReferenceUtcTimestamp": "2018-01-31T00:03:15.1349348Z", + "TimeZones": [ + { + "Id": "Asia/Qatar", + "Aliases": [ + "Asia/Bahrain" + ], + "Countries": [ + { + "Name": "Qatar", + "Code": "QA" + }, + { + "Name": "Bahrain", + "Code": "BH" + } + ], + "Names": { + "ISO6391LanguageCode": "en", + "Generic": "Arabian Time", + "Standard": "Arabian Standard Time", + "Daylight": "Arabian Daylight Time" + }, + "ReferenceTime": { + "Tag": "+03", + "StandardOffset": "03:00:00", + "DaylightSavings": "00:00:00", + "WallTime": "2018-01-31T03:03:15.1349348+03:00", + "PosixTzValidYear": 2018, + "PosixTz": "<+03>-3" + }, + "RepresentativePoint": { + "Latitude": 25.283333333333335, + "Longitude": 51.533333333333331 + }, + "TimeTransitions": [ + { + "Tag": "+03", + "StandardOffset": "03:00:00", + "DaylightSavings": "00:00:00", + "UtcStart": "1972-05-31T20:00:00Z", + "UtcEnd": "9999-12-31T23:59:59.9999999Z" + } + ] + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneEnumIANA.json b/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneEnumIANA.json new file mode 100644 index 000000000000..ff08c465adf7 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneEnumIANA.json @@ -0,0 +1,3231 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": [ + { + "id": "Africa/Bamako", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "Africa/Banjul", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "Africa/Conakry", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "Africa/Dakar", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "Africa/Freetown", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "Africa/Lome", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "Africa/Nouakchott", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "Africa/Ouagadougou", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "Africa/Sao_Tome", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "Atlantic/St_Helena", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "Africa/Addis_Ababa", + "isAlias": true, + "aliasOf": "Africa/Nairobi", + "hasZone1970Location": true + }, + { + "id": "Africa/Asmara", + "isAlias": true, + "aliasOf": "Africa/Nairobi", + "hasZone1970Location": true + }, + { + "id": "Africa/Dar_es_Salaam", + "isAlias": true, + "aliasOf": "Africa/Nairobi", + "hasZone1970Location": true + }, + { + "id": "Africa/Djibouti", + "isAlias": true, + "aliasOf": "Africa/Nairobi", + "hasZone1970Location": true + }, + { + "id": "Africa/Kampala", + "isAlias": true, + "aliasOf": "Africa/Nairobi", + "hasZone1970Location": true + }, + { + "id": "Africa/Mogadishu", + "isAlias": true, + "aliasOf": "Africa/Nairobi", + "hasZone1970Location": true + }, + { + "id": "Indian/Antananarivo", + "isAlias": true, + "aliasOf": "Africa/Nairobi", + "hasZone1970Location": true + }, + { + "id": "Indian/Comoro", + "isAlias": true, + "aliasOf": "Africa/Nairobi", + "hasZone1970Location": true + }, + { + "id": "Indian/Mayotte", + "isAlias": true, + "aliasOf": "Africa/Nairobi", + "hasZone1970Location": true + }, + { + "id": "Africa/Blantyre", + "isAlias": true, + "aliasOf": "Africa/Maputo", + "hasZone1970Location": true + }, + { + "id": "Africa/Bujumbura", + "isAlias": true, + "aliasOf": "Africa/Maputo", + "hasZone1970Location": true + }, + { + "id": "Africa/Gaborone", + "isAlias": true, + "aliasOf": "Africa/Maputo", + "hasZone1970Location": true + }, + { + "id": "Africa/Harare", + "isAlias": true, + "aliasOf": "Africa/Maputo", + "hasZone1970Location": true + }, + { + "id": "Africa/Kigali", + "isAlias": true, + "aliasOf": "Africa/Maputo", + "hasZone1970Location": true + }, + { + "id": "Africa/Lubumbashi", + "isAlias": true, + "aliasOf": "Africa/Maputo", + "hasZone1970Location": true + }, + { + "id": "Africa/Lusaka", + "isAlias": true, + "aliasOf": "Africa/Maputo", + "hasZone1970Location": true + }, + { + "id": "Africa/Bangui", + "isAlias": true, + "aliasOf": "Africa/Lagos", + "hasZone1970Location": true + }, + { + "id": "Africa/Brazzaville", + "isAlias": true, + "aliasOf": "Africa/Lagos", + "hasZone1970Location": true + }, + { + "id": "Africa/Douala", + "isAlias": true, + "aliasOf": "Africa/Lagos", + "hasZone1970Location": true + }, + { + "id": "Africa/Kinshasa", + "isAlias": true, + "aliasOf": "Africa/Lagos", + "hasZone1970Location": true + }, + { + "id": "Africa/Libreville", + "isAlias": true, + "aliasOf": "Africa/Lagos", + "hasZone1970Location": true + }, + { + "id": "Africa/Luanda", + "isAlias": true, + "aliasOf": "Africa/Lagos", + "hasZone1970Location": true + }, + { + "id": "Africa/Malabo", + "isAlias": true, + "aliasOf": "Africa/Lagos", + "hasZone1970Location": true + }, + { + "id": "Africa/Niamey", + "isAlias": true, + "aliasOf": "Africa/Lagos", + "hasZone1970Location": true + }, + { + "id": "Africa/Porto-Novo", + "isAlias": true, + "aliasOf": "Africa/Lagos", + "hasZone1970Location": true + }, + { + "id": "Africa/Maseru", + "isAlias": true, + "aliasOf": "Africa/Johannesburg", + "hasZone1970Location": true + }, + { + "id": "Africa/Mbabane", + "isAlias": true, + "aliasOf": "Africa/Johannesburg", + "hasZone1970Location": true + }, + { + "id": "Africa/Juba", + "isAlias": true, + "aliasOf": "Africa/Khartoum", + "hasZone1970Location": true + }, + { + "id": "Europe/Nicosia", + "isAlias": true, + "aliasOf": "Asia/Nicosia", + "hasZone1970Location": true + }, + { + "id": "Asia/Bahrain", + "isAlias": true, + "aliasOf": "Asia/Qatar", + "hasZone1970Location": true + }, + { + "id": "Asia/Aden", + "isAlias": true, + "aliasOf": "Asia/Riyadh", + "hasZone1970Location": true + }, + { + "id": "Asia/Kuwait", + "isAlias": true, + "aliasOf": "Asia/Riyadh", + "hasZone1970Location": true + }, + { + "id": "Asia/Phnom_Penh", + "isAlias": true, + "aliasOf": "Asia/Bangkok", + "hasZone1970Location": true + }, + { + "id": "Asia/Vientiane", + "isAlias": true, + "aliasOf": "Asia/Bangkok", + "hasZone1970Location": true + }, + { + "id": "Asia/Muscat", + "isAlias": true, + "aliasOf": "Asia/Dubai", + "hasZone1970Location": true + }, + { + "id": "Pacific/Saipan", + "isAlias": true, + "aliasOf": "Pacific/Guam", + "hasZone1970Location": true + }, + { + "id": "Antarctica/McMurdo", + "isAlias": true, + "aliasOf": "Pacific/Auckland", + "hasZone1970Location": true + }, + { + "id": "Pacific/Midway", + "isAlias": true, + "aliasOf": "Pacific/Pago_Pago", + "hasZone1970Location": true + }, + { + "id": "Europe/Jersey", + "isAlias": true, + "aliasOf": "Europe/London", + "hasZone1970Location": true + }, + { + "id": "Europe/Guernsey", + "isAlias": true, + "aliasOf": "Europe/London", + "hasZone1970Location": true + }, + { + "id": "Europe/Isle_of_Man", + "isAlias": true, + "aliasOf": "Europe/London", + "hasZone1970Location": true + }, + { + "id": "Europe/Mariehamn", + "isAlias": true, + "aliasOf": "Europe/Helsinki", + "hasZone1970Location": true + }, + { + "id": "Europe/Busingen", + "isAlias": true, + "aliasOf": "Europe/Zurich", + "hasZone1970Location": true + }, + { + "id": "Europe/Vatican", + "isAlias": true, + "aliasOf": "Europe/Rome", + "hasZone1970Location": true + }, + { + "id": "Europe/San_Marino", + "isAlias": true, + "aliasOf": "Europe/Rome", + "hasZone1970Location": true + }, + { + "id": "Europe/Vaduz", + "isAlias": true, + "aliasOf": "Europe/Zurich", + "hasZone1970Location": true + }, + { + "id": "Arctic/Longyearbyen", + "isAlias": true, + "aliasOf": "Europe/Oslo", + "hasZone1970Location": true + }, + { + "id": "Europe/Ljubljana", + "isAlias": true, + "aliasOf": "Europe/Belgrade", + "hasZone1970Location": true + }, + { + "id": "Europe/Podgorica", + "isAlias": true, + "aliasOf": "Europe/Belgrade", + "hasZone1970Location": true + }, + { + "id": "Europe/Sarajevo", + "isAlias": true, + "aliasOf": "Europe/Belgrade", + "hasZone1970Location": true + }, + { + "id": "Europe/Skopje", + "isAlias": true, + "aliasOf": "Europe/Belgrade", + "hasZone1970Location": true + }, + { + "id": "Europe/Zagreb", + "isAlias": true, + "aliasOf": "Europe/Belgrade", + "hasZone1970Location": true + }, + { + "id": "Europe/Bratislava", + "isAlias": true, + "aliasOf": "Europe/Prague", + "hasZone1970Location": true + }, + { + "id": "Asia/Istanbul", + "isAlias": true, + "aliasOf": "Europe/Istanbul", + "hasZone1970Location": true + }, + { + "id": "America/Cayman", + "isAlias": true, + "aliasOf": "America/Panama", + "hasZone1970Location": true + }, + { + "id": "America/Aruba", + "isAlias": true, + "aliasOf": "America/Curacao", + "hasZone1970Location": true + }, + { + "id": "America/Lower_Princes", + "isAlias": true, + "aliasOf": "America/Curacao", + "hasZone1970Location": true + }, + { + "id": "America/Kralendijk", + "isAlias": true, + "aliasOf": "America/Curacao", + "hasZone1970Location": true + }, + { + "id": "America/Anguilla", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/Antigua", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/Dominica", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/Grenada", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/Guadeloupe", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/Marigot", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/Montserrat", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/St_Barthelemy", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/St_Kitts", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/St_Lucia", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/St_Thomas", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/St_Vincent", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "America/Tortola", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "US/Pacific-New", + "isAlias": true, + "aliasOf": "America/Los_Angeles", + "hasZone1970Location": true + }, + { + "id": "GMT", + "isAlias": true, + "aliasOf": "Etc/GMT", + "hasZone1970Location": false + }, + { + "id": "Etc/Universal", + "isAlias": true, + "aliasOf": "Etc/UTC", + "hasZone1970Location": false + }, + { + "id": "Etc/Zulu", + "isAlias": true, + "aliasOf": "Etc/UTC", + "hasZone1970Location": false + }, + { + "id": "Etc/Greenwich", + "isAlias": true, + "aliasOf": "Etc/GMT", + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-0", + "isAlias": true, + "aliasOf": "Etc/GMT", + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+0", + "isAlias": true, + "aliasOf": "Etc/GMT", + "hasZone1970Location": false + }, + { + "id": "Etc/GMT0", + "isAlias": true, + "aliasOf": "Etc/GMT", + "hasZone1970Location": false + }, + { + "id": "Africa/Asmera", + "isAlias": true, + "aliasOf": "Africa/Nairobi", + "hasZone1970Location": true + }, + { + "id": "Africa/Timbuktu", + "isAlias": true, + "aliasOf": "Africa/Abidjan", + "hasZone1970Location": true + }, + { + "id": "America/Argentina/ComodRivadavia", + "isAlias": true, + "aliasOf": "America/Argentina/Catamarca", + "hasZone1970Location": true + }, + { + "id": "America/Atka", + "isAlias": true, + "aliasOf": "America/Adak", + "hasZone1970Location": true + }, + { + "id": "America/Buenos_Aires", + "isAlias": true, + "aliasOf": "America/Argentina/Buenos_Aires", + "hasZone1970Location": true + }, + { + "id": "America/Catamarca", + "isAlias": true, + "aliasOf": "America/Argentina/Catamarca", + "hasZone1970Location": true + }, + { + "id": "America/Coral_Harbour", + "isAlias": true, + "aliasOf": "America/Atikokan", + "hasZone1970Location": true + }, + { + "id": "America/Cordoba", + "isAlias": true, + "aliasOf": "America/Argentina/Cordoba", + "hasZone1970Location": true + }, + { + "id": "America/Ensenada", + "isAlias": true, + "aliasOf": "America/Tijuana", + "hasZone1970Location": true + }, + { + "id": "America/Fort_Wayne", + "isAlias": true, + "aliasOf": "America/Indiana/Indianapolis", + "hasZone1970Location": true + }, + { + "id": "America/Indianapolis", + "isAlias": true, + "aliasOf": "America/Indiana/Indianapolis", + "hasZone1970Location": true + }, + { + "id": "America/Jujuy", + "isAlias": true, + "aliasOf": "America/Argentina/Jujuy", + "hasZone1970Location": true + }, + { + "id": "America/Knox_IN", + "isAlias": true, + "aliasOf": "America/Indiana/Knox", + "hasZone1970Location": true + }, + { + "id": "America/Louisville", + "isAlias": true, + "aliasOf": "America/Kentucky/Louisville", + "hasZone1970Location": true + }, + { + "id": "America/Mendoza", + "isAlias": true, + "aliasOf": "America/Argentina/Mendoza", + "hasZone1970Location": true + }, + { + "id": "America/Montreal", + "isAlias": true, + "aliasOf": "America/Toronto", + "hasZone1970Location": true + }, + { + "id": "America/Porto_Acre", + "isAlias": true, + "aliasOf": "America/Rio_Branco", + "hasZone1970Location": true + }, + { + "id": "America/Rosario", + "isAlias": true, + "aliasOf": "America/Argentina/Cordoba", + "hasZone1970Location": true + }, + { + "id": "America/Santa_Isabel", + "isAlias": true, + "aliasOf": "America/Tijuana", + "hasZone1970Location": true + }, + { + "id": "America/Shiprock", + "isAlias": true, + "aliasOf": "America/Denver", + "hasZone1970Location": true + }, + { + "id": "America/Virgin", + "isAlias": true, + "aliasOf": "America/Port_of_Spain", + "hasZone1970Location": true + }, + { + "id": "Antarctica/South_Pole", + "isAlias": true, + "aliasOf": "Pacific/Auckland", + "hasZone1970Location": true + }, + { + "id": "Asia/Ashkhabad", + "isAlias": true, + "aliasOf": "Asia/Ashgabat", + "hasZone1970Location": true + }, + { + "id": "Asia/Calcutta", + "isAlias": true, + "aliasOf": "Asia/Kolkata", + "hasZone1970Location": true + }, + { + "id": "Asia/Chongqing", + "isAlias": true, + "aliasOf": "Asia/Shanghai", + "hasZone1970Location": true + }, + { + "id": "Asia/Chungking", + "isAlias": true, + "aliasOf": "Asia/Shanghai", + "hasZone1970Location": true + }, + { + "id": "Asia/Dacca", + "isAlias": true, + "aliasOf": "Asia/Dhaka", + "hasZone1970Location": true + }, + { + "id": "Asia/Harbin", + "isAlias": true, + "aliasOf": "Asia/Shanghai", + "hasZone1970Location": true + }, + { + "id": "Asia/Kashgar", + "isAlias": true, + "aliasOf": "Asia/Urumqi", + "hasZone1970Location": true + }, + { + "id": "Asia/Katmandu", + "isAlias": true, + "aliasOf": "Asia/Kathmandu", + "hasZone1970Location": true + }, + { + "id": "Asia/Macao", + "isAlias": true, + "aliasOf": "Asia/Macau", + "hasZone1970Location": true + }, + { + "id": "Asia/Rangoon", + "isAlias": true, + "aliasOf": "Asia/Yangon", + "hasZone1970Location": true + }, + { + "id": "Asia/Saigon", + "isAlias": true, + "aliasOf": "Asia/Ho_Chi_Minh", + "hasZone1970Location": true + }, + { + "id": "Asia/Tel_Aviv", + "isAlias": true, + "aliasOf": "Asia/Jerusalem", + "hasZone1970Location": true + }, + { + "id": "Asia/Thimbu", + "isAlias": true, + "aliasOf": "Asia/Thimphu", + "hasZone1970Location": true + }, + { + "id": "Asia/Ujung_Pandang", + "isAlias": true, + "aliasOf": "Asia/Makassar", + "hasZone1970Location": true + }, + { + "id": "Asia/Ulan_Bator", + "isAlias": true, + "aliasOf": "Asia/Ulaanbaatar", + "hasZone1970Location": true + }, + { + "id": "Atlantic/Faeroe", + "isAlias": true, + "aliasOf": "Atlantic/Faroe", + "hasZone1970Location": true + }, + { + "id": "Atlantic/Jan_Mayen", + "isAlias": true, + "aliasOf": "Europe/Oslo", + "hasZone1970Location": true + }, + { + "id": "Australia/ACT", + "isAlias": true, + "aliasOf": "Australia/Sydney", + "hasZone1970Location": true + }, + { + "id": "Australia/Canberra", + "isAlias": true, + "aliasOf": "Australia/Sydney", + "hasZone1970Location": true + }, + { + "id": "Australia/LHI", + "isAlias": true, + "aliasOf": "Australia/Lord_Howe", + "hasZone1970Location": true + }, + { + "id": "Australia/NSW", + "isAlias": true, + "aliasOf": "Australia/Sydney", + "hasZone1970Location": true + }, + { + "id": "Australia/North", + "isAlias": true, + "aliasOf": "Australia/Darwin", + "hasZone1970Location": true + }, + { + "id": "Australia/Queensland", + "isAlias": true, + "aliasOf": "Australia/Brisbane", + "hasZone1970Location": true + }, + { + "id": "Australia/South", + "isAlias": true, + "aliasOf": "Australia/Adelaide", + "hasZone1970Location": true + }, + { + "id": "Australia/Tasmania", + "isAlias": true, + "aliasOf": "Australia/Hobart", + "hasZone1970Location": true + }, + { + "id": "Australia/Victoria", + "isAlias": true, + "aliasOf": "Australia/Melbourne", + "hasZone1970Location": true + }, + { + "id": "Australia/West", + "isAlias": true, + "aliasOf": "Australia/Perth", + "hasZone1970Location": true + }, + { + "id": "Australia/Yancowinna", + "isAlias": true, + "aliasOf": "Australia/Broken_Hill", + "hasZone1970Location": true + }, + { + "id": "Brazil/Acre", + "isAlias": true, + "aliasOf": "America/Rio_Branco", + "hasZone1970Location": true + }, + { + "id": "Brazil/DeNoronha", + "isAlias": true, + "aliasOf": "America/Noronha", + "hasZone1970Location": true + }, + { + "id": "Brazil/East", + "isAlias": true, + "aliasOf": "America/Sao_Paulo", + "hasZone1970Location": true + }, + { + "id": "Brazil/West", + "isAlias": true, + "aliasOf": "America/Manaus", + "hasZone1970Location": true + }, + { + "id": "Canada/Atlantic", + "isAlias": true, + "aliasOf": "America/Halifax", + "hasZone1970Location": true + }, + { + "id": "Canada/Central", + "isAlias": true, + "aliasOf": "America/Winnipeg", + "hasZone1970Location": true + }, + { + "id": "Canada/East-Saskatchewan", + "isAlias": true, + "aliasOf": "America/Regina", + "hasZone1970Location": true + }, + { + "id": "Canada/Eastern", + "isAlias": true, + "aliasOf": "America/Toronto", + "hasZone1970Location": true + }, + { + "id": "Canada/Mountain", + "isAlias": true, + "aliasOf": "America/Edmonton", + "hasZone1970Location": true + }, + { + "id": "Canada/Newfoundland", + "isAlias": true, + "aliasOf": "America/St_Johns", + "hasZone1970Location": true + }, + { + "id": "Canada/Pacific", + "isAlias": true, + "aliasOf": "America/Vancouver", + "hasZone1970Location": true + }, + { + "id": "Canada/Saskatchewan", + "isAlias": true, + "aliasOf": "America/Regina", + "hasZone1970Location": true + }, + { + "id": "Canada/Yukon", + "isAlias": true, + "aliasOf": "America/Whitehorse", + "hasZone1970Location": true + }, + { + "id": "Chile/Continental", + "isAlias": true, + "aliasOf": "America/Santiago", + "hasZone1970Location": true + }, + { + "id": "Chile/EasterIsland", + "isAlias": true, + "aliasOf": "Pacific/Easter", + "hasZone1970Location": true + }, + { + "id": "Cuba", + "isAlias": true, + "aliasOf": "America/Havana", + "hasZone1970Location": true + }, + { + "id": "Egypt", + "isAlias": true, + "aliasOf": "Africa/Cairo", + "hasZone1970Location": true + }, + { + "id": "Eire", + "isAlias": true, + "aliasOf": "Europe/Dublin", + "hasZone1970Location": true + }, + { + "id": "Europe/Belfast", + "isAlias": true, + "aliasOf": "Europe/London", + "hasZone1970Location": true + }, + { + "id": "Europe/Tiraspol", + "isAlias": true, + "aliasOf": "Europe/Chisinau", + "hasZone1970Location": true + }, + { + "id": "GB", + "isAlias": true, + "aliasOf": "Europe/London", + "hasZone1970Location": true + }, + { + "id": "GB-Eire", + "isAlias": true, + "aliasOf": "Europe/London", + "hasZone1970Location": true + }, + { + "id": "GMT+0", + "isAlias": true, + "aliasOf": "Etc/GMT", + "hasZone1970Location": false + }, + { + "id": "GMT-0", + "isAlias": true, + "aliasOf": "Etc/GMT", + "hasZone1970Location": false + }, + { + "id": "GMT0", + "isAlias": true, + "aliasOf": "Etc/GMT", + "hasZone1970Location": false + }, + { + "id": "Greenwich", + "isAlias": true, + "aliasOf": "Etc/GMT", + "hasZone1970Location": false + }, + { + "id": "Hongkong", + "isAlias": true, + "aliasOf": "Asia/Hong_Kong", + "hasZone1970Location": true + }, + { + "id": "Iceland", + "isAlias": true, + "aliasOf": "Atlantic/Reykjavik", + "hasZone1970Location": true + }, + { + "id": "Iran", + "isAlias": true, + "aliasOf": "Asia/Tehran", + "hasZone1970Location": true + }, + { + "id": "Israel", + "isAlias": true, + "aliasOf": "Asia/Jerusalem", + "hasZone1970Location": true + }, + { + "id": "Jamaica", + "isAlias": true, + "aliasOf": "America/Jamaica", + "hasZone1970Location": true + }, + { + "id": "Japan", + "isAlias": true, + "aliasOf": "Asia/Tokyo", + "hasZone1970Location": true + }, + { + "id": "Kwajalein", + "isAlias": true, + "aliasOf": "Pacific/Kwajalein", + "hasZone1970Location": true + }, + { + "id": "Libya", + "isAlias": true, + "aliasOf": "Africa/Tripoli", + "hasZone1970Location": true + }, + { + "id": "Mexico/BajaNorte", + "isAlias": true, + "aliasOf": "America/Tijuana", + "hasZone1970Location": true + }, + { + "id": "Mexico/BajaSur", + "isAlias": true, + "aliasOf": "America/Mazatlan", + "hasZone1970Location": true + }, + { + "id": "Mexico/General", + "isAlias": true, + "aliasOf": "America/Mexico_City", + "hasZone1970Location": true + }, + { + "id": "NZ", + "isAlias": true, + "aliasOf": "Pacific/Auckland", + "hasZone1970Location": true + }, + { + "id": "NZ-CHAT", + "isAlias": true, + "aliasOf": "Pacific/Chatham", + "hasZone1970Location": true + }, + { + "id": "Navajo", + "isAlias": true, + "aliasOf": "America/Denver", + "hasZone1970Location": true + }, + { + "id": "PRC", + "isAlias": true, + "aliasOf": "Asia/Shanghai", + "hasZone1970Location": true + }, + { + "id": "Pacific/Johnston", + "isAlias": true, + "aliasOf": "Pacific/Honolulu", + "hasZone1970Location": true + }, + { + "id": "Pacific/Ponape", + "isAlias": true, + "aliasOf": "Pacific/Pohnpei", + "hasZone1970Location": true + }, + { + "id": "Pacific/Samoa", + "isAlias": true, + "aliasOf": "Pacific/Pago_Pago", + "hasZone1970Location": true + }, + { + "id": "Pacific/Truk", + "isAlias": true, + "aliasOf": "Pacific/Chuuk", + "hasZone1970Location": true + }, + { + "id": "Pacific/Yap", + "isAlias": true, + "aliasOf": "Pacific/Chuuk", + "hasZone1970Location": true + }, + { + "id": "Poland", + "isAlias": true, + "aliasOf": "Europe/Warsaw", + "hasZone1970Location": true + }, + { + "id": "Portugal", + "isAlias": true, + "aliasOf": "Europe/Lisbon", + "hasZone1970Location": true + }, + { + "id": "ROC", + "isAlias": true, + "aliasOf": "Asia/Taipei", + "hasZone1970Location": true + }, + { + "id": "ROK", + "isAlias": true, + "aliasOf": "Asia/Seoul", + "hasZone1970Location": true + }, + { + "id": "Singapore", + "isAlias": true, + "aliasOf": "Asia/Singapore", + "hasZone1970Location": true + }, + { + "id": "Turkey", + "isAlias": true, + "aliasOf": "Europe/Istanbul", + "hasZone1970Location": true + }, + { + "id": "UCT", + "isAlias": true, + "aliasOf": "Etc/UCT", + "hasZone1970Location": false + }, + { + "id": "US/Alaska", + "isAlias": true, + "aliasOf": "America/Anchorage", + "hasZone1970Location": true + }, + { + "id": "US/Aleutian", + "isAlias": true, + "aliasOf": "America/Adak", + "hasZone1970Location": true + }, + { + "id": "US/Arizona", + "isAlias": true, + "aliasOf": "America/Phoenix", + "hasZone1970Location": true + }, + { + "id": "US/Central", + "isAlias": true, + "aliasOf": "America/Chicago", + "hasZone1970Location": true + }, + { + "id": "US/East-Indiana", + "isAlias": true, + "aliasOf": "America/Indiana/Indianapolis", + "hasZone1970Location": true + }, + { + "id": "US/Eastern", + "isAlias": true, + "aliasOf": "America/New_York", + "hasZone1970Location": true + }, + { + "id": "US/Hawaii", + "isAlias": true, + "aliasOf": "Pacific/Honolulu", + "hasZone1970Location": true + }, + { + "id": "US/Indiana-Starke", + "isAlias": true, + "aliasOf": "America/Indiana/Knox", + "hasZone1970Location": true + }, + { + "id": "US/Michigan", + "isAlias": true, + "aliasOf": "America/Detroit", + "hasZone1970Location": true + }, + { + "id": "US/Mountain", + "isAlias": true, + "aliasOf": "America/Denver", + "hasZone1970Location": true + }, + { + "id": "US/Pacific", + "isAlias": true, + "aliasOf": "America/Los_Angeles", + "hasZone1970Location": true + }, + { + "id": "US/Samoa", + "isAlias": true, + "aliasOf": "Pacific/Pago_Pago", + "hasZone1970Location": true + }, + { + "id": "UTC", + "isAlias": true, + "aliasOf": "Etc/UTC", + "hasZone1970Location": false + }, + { + "id": "Universal", + "isAlias": true, + "aliasOf": "Etc/UTC", + "hasZone1970Location": false + }, + { + "id": "W-SU", + "isAlias": true, + "aliasOf": "Europe/Moscow", + "hasZone1970Location": true + }, + { + "id": "Zulu", + "isAlias": true, + "aliasOf": "Etc/UTC", + "hasZone1970Location": false + }, + { + "id": "Africa/Abidjan", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Accra", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Algiers", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Bissau", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Cairo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Casablanca", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Ceuta", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/El_Aaiun", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Johannesburg", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Khartoum", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Lagos", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Maputo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Monrovia", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Nairobi", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Ndjamena", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Tripoli", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Tunis", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Africa/Windhoek", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Adak", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Anchorage", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Araguaina", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/Buenos_Aires", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/Catamarca", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/Cordoba", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/Jujuy", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/La_Rioja", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/Mendoza", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/Rio_Gallegos", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/Salta", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/San_Juan", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/San_Luis", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/Tucuman", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Argentina/Ushuaia", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Asuncion", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Atikokan", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Bahia", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Bahia_Banderas", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Barbados", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Belem", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Belize", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Blanc-Sablon", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Boa_Vista", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Bogota", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Boise", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Cambridge_Bay", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Campo_Grande", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Cancun", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Caracas", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Cayenne", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Chicago", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Chihuahua", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Costa_Rica", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Creston", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Cuiaba", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Curacao", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Danmarkshavn", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Dawson", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Dawson_Creek", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Denver", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Detroit", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Edmonton", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Eirunepe", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/El_Salvador", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Fort_Nelson", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Fortaleza", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Glace_Bay", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Godthab", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Goose_Bay", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Grand_Turk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Guatemala", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Guayaquil", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Guyana", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Halifax", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Havana", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Hermosillo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Indiana/Indianapolis", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Indiana/Knox", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Indiana/Marengo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Indiana/Petersburg", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Indiana/Tell_City", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Indiana/Vevay", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Indiana/Vincennes", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Indiana/Winamac", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Inuvik", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Iqaluit", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Jamaica", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Juneau", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Kentucky/Louisville", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Kentucky/Monticello", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/La_Paz", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Lima", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Los_Angeles", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Maceio", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Managua", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Manaus", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Martinique", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Matamoros", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Mazatlan", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Menominee", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Merida", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Metlakatla", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Mexico_City", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Miquelon", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Moncton", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Monterrey", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Montevideo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Nassau", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/New_York", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Nipigon", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Nome", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Noronha", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/North_Dakota/Beulah", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/North_Dakota/Center", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/North_Dakota/New_Salem", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Ojinaga", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Panama", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Pangnirtung", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Paramaribo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Phoenix", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Port-au-Prince", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Port_of_Spain", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Porto_Velho", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Puerto_Rico", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Punta_Arenas", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Rainy_River", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Rankin_Inlet", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Recife", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Regina", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Resolute", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Rio_Branco", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Santarem", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Santiago", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Santo_Domingo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Sao_Paulo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Scoresbysund", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Sitka", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/St_Johns", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Swift_Current", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Tegucigalpa", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Thule", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Thunder_Bay", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Tijuana", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Toronto", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Vancouver", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Whitehorse", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Winnipeg", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Yakutat", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "America/Yellowknife", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Antarctica/Casey", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Antarctica/Davis", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Antarctica/DumontDUrville", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Antarctica/Macquarie", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Antarctica/Mawson", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Antarctica/Palmer", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Antarctica/Rothera", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Antarctica/Syowa", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Antarctica/Troll", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Antarctica/Vostok", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Almaty", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Amman", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Anadyr", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Aqtau", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Aqtobe", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Ashgabat", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Atyrau", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Baghdad", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Baku", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Bangkok", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Barnaul", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Beirut", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Bishkek", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Brunei", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Chita", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Choibalsan", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Colombo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Damascus", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Dhaka", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Dili", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Dubai", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Dushanbe", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Famagusta", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Gaza", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Hebron", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Ho_Chi_Minh", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Hong_Kong", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Hovd", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Irkutsk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Jakarta", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Jayapura", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Jerusalem", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Kabul", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Kamchatka", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Karachi", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Kathmandu", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Khandyga", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Kolkata", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Krasnoyarsk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Kuala_Lumpur", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Kuching", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Macau", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Magadan", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Makassar", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Manila", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Nicosia", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Novokuznetsk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Novosibirsk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Omsk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Oral", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Pontianak", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Pyongyang", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Qatar", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Qyzylorda", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Riyadh", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Sakhalin", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Samarkand", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Seoul", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Shanghai", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Singapore", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Srednekolymsk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Taipei", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Tashkent", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Tbilisi", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Tehran", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Thimphu", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Tokyo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Tomsk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Ulaanbaatar", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Urumqi", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Ust-Nera", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Vladivostok", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Yakutsk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Yangon", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Yekaterinburg", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Asia/Yerevan", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Atlantic/Azores", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Atlantic/Bermuda", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Atlantic/Canary", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Atlantic/Cape_Verde", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Atlantic/Faroe", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Atlantic/Madeira", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Atlantic/Reykjavik", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Atlantic/South_Georgia", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Atlantic/Stanley", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Adelaide", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Brisbane", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Broken_Hill", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Currie", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Darwin", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Eucla", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Hobart", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Lindeman", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Lord_Howe", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Melbourne", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Perth", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Australia/Sydney", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "CET", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "CST6CDT", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "EET", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "EST", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "EST5EDT", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+1", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+10", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+11", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+12", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+2", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+3", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+4", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+5", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+6", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+7", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+8", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT+9", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-1", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-10", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-11", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-12", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-13", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-14", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-2", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-3", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-4", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-5", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-6", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-7", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-8", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/GMT-9", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/UCT", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Etc/UTC", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Europe/Amsterdam", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Andorra", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Astrakhan", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Athens", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Belgrade", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Berlin", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Brussels", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Bucharest", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Budapest", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Chisinau", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Copenhagen", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Dublin", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Gibraltar", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Helsinki", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Istanbul", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Kaliningrad", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Kiev", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Kirov", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Lisbon", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/London", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Luxembourg", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Madrid", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Malta", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Minsk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Monaco", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Moscow", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Oslo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Paris", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Prague", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Riga", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Rome", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Samara", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Saratov", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Simferopol", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Sofia", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Stockholm", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Tallinn", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Tirane", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Ulyanovsk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Uzhgorod", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Vienna", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Vilnius", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Volgograd", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Warsaw", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Zaporozhye", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Europe/Zurich", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "HST", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Indian/Chagos", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Indian/Christmas", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Indian/Cocos", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Indian/Kerguelen", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Indian/Mahe", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Indian/Maldives", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Indian/Mauritius", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Indian/Reunion", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "MET", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "MST", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "MST7MDT", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "PST8PDT", + "isAlias": false, + "hasZone1970Location": false + }, + { + "id": "Pacific/Apia", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Auckland", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Bougainville", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Chatham", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Chuuk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Easter", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Efate", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Enderbury", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Fakaofo", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Fiji", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Funafuti", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Galapagos", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Gambier", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Guadalcanal", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Guam", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Honolulu", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Kiritimati", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Kosrae", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Kwajalein", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Majuro", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Marquesas", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Nauru", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Niue", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Norfolk", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Noumea", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Pago_Pago", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Palau", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Pitcairn", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Pohnpei", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Port_Moresby", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Rarotonga", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Tahiti", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Tarawa", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Tongatapu", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Wake", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "Pacific/Wallis", + "isAlias": false, + "hasZone1970Location": true + }, + { + "id": "WET", + "isAlias": false, + "hasZone1970Location": false + } + ] + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneEnumWindows.json b/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneEnumWindows.json new file mode 100644 index 000000000000..e6d21bab33b3 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneEnumWindows.json @@ -0,0 +1,3649 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": [ + { + "WindowsId": "Dateline Standard Time", + "Territory": "001", + "IanaIds": [ + "Etc/GMT+12" + ] + }, + { + "WindowsId": "Dateline Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+12" + ] + }, + { + "WindowsId": "UTC-11", + "Territory": "001", + "IanaIds": [ + "Etc/GMT+11" + ] + }, + { + "WindowsId": "UTC-11", + "Territory": "AS", + "IanaIds": [ + "Pacific/Pago_Pago" + ] + }, + { + "WindowsId": "UTC-11", + "Territory": "NU", + "IanaIds": [ + "Pacific/Niue" + ] + }, + { + "WindowsId": "UTC-11", + "Territory": "UM", + "IanaIds": [ + "Pacific/Midway" + ] + }, + { + "WindowsId": "UTC-11", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+11" + ] + }, + { + "WindowsId": "Aleutian Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Adak" + ] + }, + { + "WindowsId": "Aleutian Standard Time", + "Territory": "US", + "IanaIds": [ + "America/Adak" + ] + }, + { + "WindowsId": "Hawaiian Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Honolulu" + ] + }, + { + "WindowsId": "Hawaiian Standard Time", + "Territory": "CK", + "IanaIds": [ + "Pacific/Rarotonga" + ] + }, + { + "WindowsId": "Hawaiian Standard Time", + "Territory": "PF", + "IanaIds": [ + "Pacific/Tahiti" + ] + }, + { + "WindowsId": "Hawaiian Standard Time", + "Territory": "UM", + "IanaIds": [ + "Pacific/Johnston" + ] + }, + { + "WindowsId": "Hawaiian Standard Time", + "Territory": "US", + "IanaIds": [ + "Pacific/Honolulu" + ] + }, + { + "WindowsId": "Hawaiian Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+10" + ] + }, + { + "WindowsId": "Marquesas Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Marquesas" + ] + }, + { + "WindowsId": "Marquesas Standard Time", + "Territory": "PF", + "IanaIds": [ + "Pacific/Marquesas" + ] + }, + { + "WindowsId": "Alaskan Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Anchorage" + ] + }, + { + "WindowsId": "Alaskan Standard Time", + "Territory": "US", + "IanaIds": [ + "America/Anchorage", + "America/Juneau", + "America/Metlakatla", + "America/Nome", + "America/Sitka", + "America/Yakutat" + ] + }, + { + "WindowsId": "UTC-09", + "Territory": "001", + "IanaIds": [ + "Etc/GMT+9" + ] + }, + { + "WindowsId": "UTC-09", + "Territory": "PF", + "IanaIds": [ + "Pacific/Gambier" + ] + }, + { + "WindowsId": "UTC-09", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+9" + ] + }, + { + "WindowsId": "Pacific Standard Time (Mexico)", + "Territory": "001", + "IanaIds": [ + "America/Tijuana" + ] + }, + { + "WindowsId": "Pacific Standard Time (Mexico)", + "Territory": "MX", + "IanaIds": [ + "America/Tijuana", + "America/Santa_Isabel" + ] + }, + { + "WindowsId": "UTC-08", + "Territory": "001", + "IanaIds": [ + "Etc/GMT+8" + ] + }, + { + "WindowsId": "UTC-08", + "Territory": "PN", + "IanaIds": [ + "Pacific/Pitcairn" + ] + }, + { + "WindowsId": "UTC-08", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+8" + ] + }, + { + "WindowsId": "Pacific Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Los_Angeles" + ] + }, + { + "WindowsId": "Pacific Standard Time", + "Territory": "CA", + "IanaIds": [ + "America/Vancouver", + "America/Dawson", + "America/Whitehorse" + ] + }, + { + "WindowsId": "Pacific Standard Time", + "Territory": "US", + "IanaIds": [ + "America/Los_Angeles" + ] + }, + { + "WindowsId": "Pacific Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "PST8PDT" + ] + }, + { + "WindowsId": "US Mountain Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Phoenix" + ] + }, + { + "WindowsId": "US Mountain Standard Time", + "Territory": "CA", + "IanaIds": [ + "America/Dawson_Creek", + "America/Creston", + "America/Fort_Nelson" + ] + }, + { + "WindowsId": "US Mountain Standard Time", + "Territory": "MX", + "IanaIds": [ + "America/Hermosillo" + ] + }, + { + "WindowsId": "US Mountain Standard Time", + "Territory": "US", + "IanaIds": [ + "America/Phoenix" + ] + }, + { + "WindowsId": "US Mountain Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+7" + ] + }, + { + "WindowsId": "Mountain Standard Time (Mexico)", + "Territory": "001", + "IanaIds": [ + "America/Chihuahua" + ] + }, + { + "WindowsId": "Mountain Standard Time (Mexico)", + "Territory": "MX", + "IanaIds": [ + "America/Chihuahua", + "America/Mazatlan" + ] + }, + { + "WindowsId": "Mountain Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Denver" + ] + }, + { + "WindowsId": "Mountain Standard Time", + "Territory": "CA", + "IanaIds": [ + "America/Edmonton", + "America/Cambridge_Bay", + "America/Inuvik", + "America/Yellowknife" + ] + }, + { + "WindowsId": "Mountain Standard Time", + "Territory": "MX", + "IanaIds": [ + "America/Ojinaga" + ] + }, + { + "WindowsId": "Mountain Standard Time", + "Territory": "US", + "IanaIds": [ + "America/Denver", + "America/Boise" + ] + }, + { + "WindowsId": "Mountain Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "MST7MDT" + ] + }, + { + "WindowsId": "Central America Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Guatemala" + ] + }, + { + "WindowsId": "Central America Standard Time", + "Territory": "BZ", + "IanaIds": [ + "America/Belize" + ] + }, + { + "WindowsId": "Central America Standard Time", + "Territory": "CR", + "IanaIds": [ + "America/Costa_Rica" + ] + }, + { + "WindowsId": "Central America Standard Time", + "Territory": "EC", + "IanaIds": [ + "Pacific/Galapagos" + ] + }, + { + "WindowsId": "Central America Standard Time", + "Territory": "GT", + "IanaIds": [ + "America/Guatemala" + ] + }, + { + "WindowsId": "Central America Standard Time", + "Territory": "HN", + "IanaIds": [ + "America/Tegucigalpa" + ] + }, + { + "WindowsId": "Central America Standard Time", + "Territory": "NI", + "IanaIds": [ + "America/Managua" + ] + }, + { + "WindowsId": "Central America Standard Time", + "Territory": "SV", + "IanaIds": [ + "America/El_Salvador" + ] + }, + { + "WindowsId": "Central America Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+6" + ] + }, + { + "WindowsId": "Central Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Chicago" + ] + }, + { + "WindowsId": "Central Standard Time", + "Territory": "CA", + "IanaIds": [ + "America/Winnipeg", + "America/Rainy_River", + "America/Rankin_Inlet", + "America/Resolute" + ] + }, + { + "WindowsId": "Central Standard Time", + "Territory": "MX", + "IanaIds": [ + "America/Matamoros" + ] + }, + { + "WindowsId": "Central Standard Time", + "Territory": "US", + "IanaIds": [ + "America/Chicago", + "America/Indiana/Knox", + "America/Indiana/Tell_City", + "America/Menominee", + "America/North_Dakota/Beulah", + "America/North_Dakota/Center", + "America/North_Dakota/New_Salem" + ] + }, + { + "WindowsId": "Central Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "CST6CDT" + ] + }, + { + "WindowsId": "Easter Island Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Easter" + ] + }, + { + "WindowsId": "Easter Island Standard Time", + "Territory": "CL", + "IanaIds": [ + "Pacific/Easter" + ] + }, + { + "WindowsId": "Central Standard Time (Mexico)", + "Territory": "001", + "IanaIds": [ + "America/Mexico_City" + ] + }, + { + "WindowsId": "Central Standard Time (Mexico)", + "Territory": "MX", + "IanaIds": [ + "America/Mexico_City", + "America/Bahia_Banderas", + "America/Merida", + "America/Monterrey" + ] + }, + { + "WindowsId": "Canada Central Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Regina" + ] + }, + { + "WindowsId": "Canada Central Standard Time", + "Territory": "CA", + "IanaIds": [ + "America/Regina", + "America/Swift_Current" + ] + }, + { + "WindowsId": "SA Pacific Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Bogota" + ] + }, + { + "WindowsId": "SA Pacific Standard Time", + "Territory": "BR", + "IanaIds": [ + "America/Rio_Branco", + "America/Eirunepe" + ] + }, + { + "WindowsId": "SA Pacific Standard Time", + "Territory": "CA", + "IanaIds": [ + "America/Coral_Harbour" + ] + }, + { + "WindowsId": "SA Pacific Standard Time", + "Territory": "CO", + "IanaIds": [ + "America/Bogota" + ] + }, + { + "WindowsId": "SA Pacific Standard Time", + "Territory": "EC", + "IanaIds": [ + "America/Guayaquil" + ] + }, + { + "WindowsId": "SA Pacific Standard Time", + "Territory": "JM", + "IanaIds": [ + "America/Jamaica" + ] + }, + { + "WindowsId": "SA Pacific Standard Time", + "Territory": "KY", + "IanaIds": [ + "America/Cayman" + ] + }, + { + "WindowsId": "SA Pacific Standard Time", + "Territory": "PA", + "IanaIds": [ + "America/Panama" + ] + }, + { + "WindowsId": "SA Pacific Standard Time", + "Territory": "PE", + "IanaIds": [ + "America/Lima" + ] + }, + { + "WindowsId": "SA Pacific Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+5" + ] + }, + { + "WindowsId": "Eastern Standard Time (Mexico)", + "Territory": "001", + "IanaIds": [ + "America/Cancun" + ] + }, + { + "WindowsId": "Eastern Standard Time (Mexico)", + "Territory": "MX", + "IanaIds": [ + "America/Cancun" + ] + }, + { + "WindowsId": "Eastern Standard Time", + "Territory": "001", + "IanaIds": [ + "America/New_York" + ] + }, + { + "WindowsId": "Eastern Standard Time", + "Territory": "BS", + "IanaIds": [ + "America/Nassau" + ] + }, + { + "WindowsId": "Eastern Standard Time", + "Territory": "CA", + "IanaIds": [ + "America/Toronto", + "America/Iqaluit", + "America/Montreal", + "America/Nipigon", + "America/Pangnirtung", + "America/Thunder_Bay" + ] + }, + { + "WindowsId": "Eastern Standard Time", + "Territory": "US", + "IanaIds": [ + "America/New_York", + "America/Detroit", + "America/Indiana/Petersburg", + "America/Indiana/Vincennes", + "America/Indiana/Winamac", + "America/Kentucky/Monticello", + "America/Louisville" + ] + }, + { + "WindowsId": "Eastern Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "EST5EDT" + ] + }, + { + "WindowsId": "Haiti Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Port-au-Prince" + ] + }, + { + "WindowsId": "Haiti Standard Time", + "Territory": "HT", + "IanaIds": [ + "America/Port-au-Prince" + ] + }, + { + "WindowsId": "Cuba Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Havana" + ] + }, + { + "WindowsId": "Cuba Standard Time", + "Territory": "CU", + "IanaIds": [ + "America/Havana" + ] + }, + { + "WindowsId": "US Eastern Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Indianapolis" + ] + }, + { + "WindowsId": "US Eastern Standard Time", + "Territory": "US", + "IanaIds": [ + "America/Indianapolis", + "America/Indiana/Marengo", + "America/Indiana/Vevay" + ] + }, + { + "WindowsId": "Paraguay Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Asuncion" + ] + }, + { + "WindowsId": "Paraguay Standard Time", + "Territory": "PY", + "IanaIds": [ + "America/Asuncion" + ] + }, + { + "WindowsId": "Atlantic Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Halifax" + ] + }, + { + "WindowsId": "Atlantic Standard Time", + "Territory": "BM", + "IanaIds": [ + "Atlantic/Bermuda" + ] + }, + { + "WindowsId": "Atlantic Standard Time", + "Territory": "CA", + "IanaIds": [ + "America/Halifax", + "America/Glace_Bay", + "America/Goose_Bay", + "America/Moncton" + ] + }, + { + "WindowsId": "Atlantic Standard Time", + "Territory": "GL", + "IanaIds": [ + "America/Thule" + ] + }, + { + "WindowsId": "Venezuela Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Caracas" + ] + }, + { + "WindowsId": "Venezuela Standard Time", + "Territory": "VE", + "IanaIds": [ + "America/Caracas" + ] + }, + { + "WindowsId": "Central Brazilian Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Cuiaba" + ] + }, + { + "WindowsId": "Central Brazilian Standard Time", + "Territory": "BR", + "IanaIds": [ + "America/Cuiaba", + "America/Campo_Grande" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "001", + "IanaIds": [ + "America/La_Paz" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "AG", + "IanaIds": [ + "America/Antigua" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "AI", + "IanaIds": [ + "America/Anguilla" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "AW", + "IanaIds": [ + "America/Aruba" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "BB", + "IanaIds": [ + "America/Barbados" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "BL", + "IanaIds": [ + "America/St_Barthelemy" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "BO", + "IanaIds": [ + "America/La_Paz" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "BQ", + "IanaIds": [ + "America/Kralendijk" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "BR", + "IanaIds": [ + "America/Manaus", + "America/Boa_Vista", + "America/Porto_Velho" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "CA", + "IanaIds": [ + "America/Blanc-Sablon" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "CW", + "IanaIds": [ + "America/Curacao" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "DM", + "IanaIds": [ + "America/Dominica" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "DO", + "IanaIds": [ + "America/Santo_Domingo" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "GD", + "IanaIds": [ + "America/Grenada" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "GP", + "IanaIds": [ + "America/Guadeloupe" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "GY", + "IanaIds": [ + "America/Guyana" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "KN", + "IanaIds": [ + "America/St_Kitts" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "LC", + "IanaIds": [ + "America/St_Lucia" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "MF", + "IanaIds": [ + "America/Marigot" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "MQ", + "IanaIds": [ + "America/Martinique" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "MS", + "IanaIds": [ + "America/Montserrat" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "PR", + "IanaIds": [ + "America/Puerto_Rico" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "SX", + "IanaIds": [ + "America/Lower_Princes" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "TT", + "IanaIds": [ + "America/Port_of_Spain" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "VC", + "IanaIds": [ + "America/St_Vincent" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "VG", + "IanaIds": [ + "America/Tortola" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "VI", + "IanaIds": [ + "America/St_Thomas" + ] + }, + { + "WindowsId": "SA Western Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+4" + ] + }, + { + "WindowsId": "Pacific SA Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Santiago" + ] + }, + { + "WindowsId": "Pacific SA Standard Time", + "Territory": "CL", + "IanaIds": [ + "America/Santiago" + ] + }, + { + "WindowsId": "Turks And Caicos Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Grand_Turk" + ] + }, + { + "WindowsId": "Turks And Caicos Standard Time", + "Territory": "TC", + "IanaIds": [ + "America/Grand_Turk" + ] + }, + { + "WindowsId": "Newfoundland Standard Time", + "Territory": "001", + "IanaIds": [ + "America/St_Johns" + ] + }, + { + "WindowsId": "Newfoundland Standard Time", + "Territory": "CA", + "IanaIds": [ + "America/St_Johns" + ] + }, + { + "WindowsId": "Tocantins Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Araguaina" + ] + }, + { + "WindowsId": "Tocantins Standard Time", + "Territory": "BR", + "IanaIds": [ + "America/Araguaina" + ] + }, + { + "WindowsId": "E. South America Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Sao_Paulo" + ] + }, + { + "WindowsId": "E. South America Standard Time", + "Territory": "BR", + "IanaIds": [ + "America/Sao_Paulo" + ] + }, + { + "WindowsId": "SA Eastern Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Cayenne" + ] + }, + { + "WindowsId": "SA Eastern Standard Time", + "Territory": "AQ", + "IanaIds": [ + "Antarctica/Rothera" + ] + }, + { + "WindowsId": "SA Eastern Standard Time", + "Territory": "BR", + "IanaIds": [ + "America/Fortaleza", + "America/Belem", + "America/Maceio", + "America/Recife", + "America/Santarem" + ] + }, + { + "WindowsId": "SA Eastern Standard Time", + "Territory": "FK", + "IanaIds": [ + "Atlantic/Stanley" + ] + }, + { + "WindowsId": "SA Eastern Standard Time", + "Territory": "GF", + "IanaIds": [ + "America/Cayenne" + ] + }, + { + "WindowsId": "SA Eastern Standard Time", + "Territory": "SR", + "IanaIds": [ + "America/Paramaribo" + ] + }, + { + "WindowsId": "SA Eastern Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+3" + ] + }, + { + "WindowsId": "Argentina Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Buenos_Aires" + ] + }, + { + "WindowsId": "Argentina Standard Time", + "Territory": "AR", + "IanaIds": [ + "America/Buenos_Aires", + "America/Argentina/La_Rioja", + "America/Argentina/Rio_Gallegos", + "America/Argentina/Salta", + "America/Argentina/San_Juan", + "America/Argentina/San_Luis", + "America/Argentina/Tucuman", + "America/Argentina/Ushuaia", + "America/Catamarca", + "America/Cordoba", + "America/Jujuy", + "America/Mendoza" + ] + }, + { + "WindowsId": "Greenland Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Godthab" + ] + }, + { + "WindowsId": "Greenland Standard Time", + "Territory": "GL", + "IanaIds": [ + "America/Godthab" + ] + }, + { + "WindowsId": "Montevideo Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Montevideo" + ] + }, + { + "WindowsId": "Montevideo Standard Time", + "Territory": "UY", + "IanaIds": [ + "America/Montevideo" + ] + }, + { + "WindowsId": "Magallanes Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Punta_Arenas" + ] + }, + { + "WindowsId": "Magallanes Standard Time", + "Territory": "AQ", + "IanaIds": [ + "Antarctica/Palmer" + ] + }, + { + "WindowsId": "Magallanes Standard Time", + "Territory": "CL", + "IanaIds": [ + "America/Punta_Arenas" + ] + }, + { + "WindowsId": "Saint Pierre Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Miquelon" + ] + }, + { + "WindowsId": "Saint Pierre Standard Time", + "Territory": "PM", + "IanaIds": [ + "America/Miquelon" + ] + }, + { + "WindowsId": "Bahia Standard Time", + "Territory": "001", + "IanaIds": [ + "America/Bahia" + ] + }, + { + "WindowsId": "Bahia Standard Time", + "Territory": "BR", + "IanaIds": [ + "America/Bahia" + ] + }, + { + "WindowsId": "UTC-02", + "Territory": "001", + "IanaIds": [ + "Etc/GMT+2" + ] + }, + { + "WindowsId": "UTC-02", + "Territory": "BR", + "IanaIds": [ + "America/Noronha" + ] + }, + { + "WindowsId": "UTC-02", + "Territory": "GS", + "IanaIds": [ + "Atlantic/South_Georgia" + ] + }, + { + "WindowsId": "UTC-02", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+2" + ] + }, + { + "WindowsId": "Azores Standard Time", + "Territory": "001", + "IanaIds": [ + "Atlantic/Azores" + ] + }, + { + "WindowsId": "Azores Standard Time", + "Territory": "GL", + "IanaIds": [ + "America/Scoresbysund" + ] + }, + { + "WindowsId": "Azores Standard Time", + "Territory": "PT", + "IanaIds": [ + "Atlantic/Azores" + ] + }, + { + "WindowsId": "Cape Verde Standard Time", + "Territory": "001", + "IanaIds": [ + "Atlantic/Cape_Verde" + ] + }, + { + "WindowsId": "Cape Verde Standard Time", + "Territory": "CV", + "IanaIds": [ + "Atlantic/Cape_Verde" + ] + }, + { + "WindowsId": "Cape Verde Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT+1" + ] + }, + { + "WindowsId": "UTC", + "Territory": "001", + "IanaIds": [ + "Etc/GMT" + ] + }, + { + "WindowsId": "UTC", + "Territory": "GL", + "IanaIds": [ + "America/Danmarkshavn" + ] + }, + { + "WindowsId": "UTC", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT", + "Etc/UTC" + ] + }, + { + "WindowsId": "Morocco Standard Time", + "Territory": "001", + "IanaIds": [ + "Africa/Casablanca" + ] + }, + { + "WindowsId": "Morocco Standard Time", + "Territory": "EH", + "IanaIds": [ + "Africa/El_Aaiun" + ] + }, + { + "WindowsId": "Morocco Standard Time", + "Territory": "MA", + "IanaIds": [ + "Africa/Casablanca" + ] + }, + { + "WindowsId": "GMT Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/London" + ] + }, + { + "WindowsId": "GMT Standard Time", + "Territory": "ES", + "IanaIds": [ + "Atlantic/Canary" + ] + }, + { + "WindowsId": "GMT Standard Time", + "Territory": "FO", + "IanaIds": [ + "Atlantic/Faeroe" + ] + }, + { + "WindowsId": "GMT Standard Time", + "Territory": "GB", + "IanaIds": [ + "Europe/London" + ] + }, + { + "WindowsId": "GMT Standard Time", + "Territory": "GG", + "IanaIds": [ + "Europe/Guernsey" + ] + }, + { + "WindowsId": "GMT Standard Time", + "Territory": "IE", + "IanaIds": [ + "Europe/Dublin" + ] + }, + { + "WindowsId": "GMT Standard Time", + "Territory": "IM", + "IanaIds": [ + "Europe/Isle_of_Man" + ] + }, + { + "WindowsId": "GMT Standard Time", + "Territory": "JE", + "IanaIds": [ + "Europe/Jersey" + ] + }, + { + "WindowsId": "GMT Standard Time", + "Territory": "PT", + "IanaIds": [ + "Europe/Lisbon", + "Atlantic/Madeira" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "001", + "IanaIds": [ + "Atlantic/Reykjavik" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "BF", + "IanaIds": [ + "Africa/Ouagadougou" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "CI", + "IanaIds": [ + "Africa/Abidjan" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "GH", + "IanaIds": [ + "Africa/Accra" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "GM", + "IanaIds": [ + "Africa/Banjul" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "GN", + "IanaIds": [ + "Africa/Conakry" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "GW", + "IanaIds": [ + "Africa/Bissau" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "IS", + "IanaIds": [ + "Atlantic/Reykjavik" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "LR", + "IanaIds": [ + "Africa/Monrovia" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "ML", + "IanaIds": [ + "Africa/Bamako" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "MR", + "IanaIds": [ + "Africa/Nouakchott" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "SH", + "IanaIds": [ + "Atlantic/St_Helena" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "SL", + "IanaIds": [ + "Africa/Freetown" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "SN", + "IanaIds": [ + "Africa/Dakar" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "ST", + "IanaIds": [ + "Africa/Sao_Tome" + ] + }, + { + "WindowsId": "Greenwich Standard Time", + "Territory": "TG", + "IanaIds": [ + "Africa/Lome" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Berlin" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "AD", + "IanaIds": [ + "Europe/Andorra" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "AT", + "IanaIds": [ + "Europe/Vienna" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "CH", + "IanaIds": [ + "Europe/Zurich" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "DE", + "IanaIds": [ + "Europe/Berlin", + "Europe/Busingen" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "GI", + "IanaIds": [ + "Europe/Gibraltar" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "IT", + "IanaIds": [ + "Europe/Rome" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "LI", + "IanaIds": [ + "Europe/Vaduz" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "LU", + "IanaIds": [ + "Europe/Luxembourg" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "MC", + "IanaIds": [ + "Europe/Monaco" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "MT", + "IanaIds": [ + "Europe/Malta" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "NL", + "IanaIds": [ + "Europe/Amsterdam" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "NO", + "IanaIds": [ + "Europe/Oslo" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "SE", + "IanaIds": [ + "Europe/Stockholm" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "SJ", + "IanaIds": [ + "Arctic/Longyearbyen" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "SM", + "IanaIds": [ + "Europe/San_Marino" + ] + }, + { + "WindowsId": "W. Europe Standard Time", + "Territory": "VA", + "IanaIds": [ + "Europe/Vatican" + ] + }, + { + "WindowsId": "Central Europe Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Budapest" + ] + }, + { + "WindowsId": "Central Europe Standard Time", + "Territory": "AL", + "IanaIds": [ + "Europe/Tirane" + ] + }, + { + "WindowsId": "Central Europe Standard Time", + "Territory": "CZ", + "IanaIds": [ + "Europe/Prague" + ] + }, + { + "WindowsId": "Central Europe Standard Time", + "Territory": "HU", + "IanaIds": [ + "Europe/Budapest" + ] + }, + { + "WindowsId": "Central Europe Standard Time", + "Territory": "ME", + "IanaIds": [ + "Europe/Podgorica" + ] + }, + { + "WindowsId": "Central Europe Standard Time", + "Territory": "RS", + "IanaIds": [ + "Europe/Belgrade" + ] + }, + { + "WindowsId": "Central Europe Standard Time", + "Territory": "SI", + "IanaIds": [ + "Europe/Ljubljana" + ] + }, + { + "WindowsId": "Central Europe Standard Time", + "Territory": "SK", + "IanaIds": [ + "Europe/Bratislava" + ] + }, + { + "WindowsId": "Romance Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Paris" + ] + }, + { + "WindowsId": "Romance Standard Time", + "Territory": "BE", + "IanaIds": [ + "Europe/Brussels" + ] + }, + { + "WindowsId": "Romance Standard Time", + "Territory": "DK", + "IanaIds": [ + "Europe/Copenhagen" + ] + }, + { + "WindowsId": "Romance Standard Time", + "Territory": "ES", + "IanaIds": [ + "Europe/Madrid", + "Africa/Ceuta" + ] + }, + { + "WindowsId": "Romance Standard Time", + "Territory": "FR", + "IanaIds": [ + "Europe/Paris" + ] + }, + { + "WindowsId": "Central European Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Warsaw" + ] + }, + { + "WindowsId": "Central European Standard Time", + "Territory": "BA", + "IanaIds": [ + "Europe/Sarajevo" + ] + }, + { + "WindowsId": "Central European Standard Time", + "Territory": "HR", + "IanaIds": [ + "Europe/Zagreb" + ] + }, + { + "WindowsId": "Central European Standard Time", + "Territory": "MK", + "IanaIds": [ + "Europe/Skopje" + ] + }, + { + "WindowsId": "Central European Standard Time", + "Territory": "PL", + "IanaIds": [ + "Europe/Warsaw" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "001", + "IanaIds": [ + "Africa/Lagos" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "AO", + "IanaIds": [ + "Africa/Luanda" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "BJ", + "IanaIds": [ + "Africa/Porto-Novo" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "CD", + "IanaIds": [ + "Africa/Kinshasa" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "CF", + "IanaIds": [ + "Africa/Bangui" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "CG", + "IanaIds": [ + "Africa/Brazzaville" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "CM", + "IanaIds": [ + "Africa/Douala" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "DZ", + "IanaIds": [ + "Africa/Algiers" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "GA", + "IanaIds": [ + "Africa/Libreville" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "GQ", + "IanaIds": [ + "Africa/Malabo" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "NE", + "IanaIds": [ + "Africa/Niamey" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "NG", + "IanaIds": [ + "Africa/Lagos" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "TD", + "IanaIds": [ + "Africa/Ndjamena" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "TN", + "IanaIds": [ + "Africa/Tunis" + ] + }, + { + "WindowsId": "W. Central Africa Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-1" + ] + }, + { + "WindowsId": "Namibia Standard Time", + "Territory": "001", + "IanaIds": [ + "Africa/Windhoek" + ] + }, + { + "WindowsId": "Namibia Standard Time", + "Territory": "NA", + "IanaIds": [ + "Africa/Windhoek" + ] + }, + { + "WindowsId": "Jordan Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Amman" + ] + }, + { + "WindowsId": "Jordan Standard Time", + "Territory": "JO", + "IanaIds": [ + "Asia/Amman" + ] + }, + { + "WindowsId": "GTB Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Bucharest" + ] + }, + { + "WindowsId": "GTB Standard Time", + "Territory": "CY", + "IanaIds": [ + "Asia/Nicosia" + ] + }, + { + "WindowsId": "GTB Standard Time", + "Territory": "GR", + "IanaIds": [ + "Europe/Athens" + ] + }, + { + "WindowsId": "GTB Standard Time", + "Territory": "RO", + "IanaIds": [ + "Europe/Bucharest" + ] + }, + { + "WindowsId": "Middle East Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Beirut" + ] + }, + { + "WindowsId": "Middle East Standard Time", + "Territory": "LB", + "IanaIds": [ + "Asia/Beirut" + ] + }, + { + "WindowsId": "Egypt Standard Time", + "Territory": "001", + "IanaIds": [ + "Africa/Cairo" + ] + }, + { + "WindowsId": "Egypt Standard Time", + "Territory": "EG", + "IanaIds": [ + "Africa/Cairo" + ] + }, + { + "WindowsId": "E. Europe Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Chisinau" + ] + }, + { + "WindowsId": "E. Europe Standard Time", + "Territory": "MD", + "IanaIds": [ + "Europe/Chisinau" + ] + }, + { + "WindowsId": "Syria Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Damascus" + ] + }, + { + "WindowsId": "Syria Standard Time", + "Territory": "SY", + "IanaIds": [ + "Asia/Damascus" + ] + }, + { + "WindowsId": "West Bank Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Hebron" + ] + }, + { + "WindowsId": "West Bank Standard Time", + "Territory": "PS", + "IanaIds": [ + "Asia/Hebron", + "Asia/Gaza" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "001", + "IanaIds": [ + "Africa/Johannesburg" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "BI", + "IanaIds": [ + "Africa/Bujumbura" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "BW", + "IanaIds": [ + "Africa/Gaborone" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "CD", + "IanaIds": [ + "Africa/Lubumbashi" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "LS", + "IanaIds": [ + "Africa/Maseru" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "MW", + "IanaIds": [ + "Africa/Blantyre" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "MZ", + "IanaIds": [ + "Africa/Maputo" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "RW", + "IanaIds": [ + "Africa/Kigali" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "SZ", + "IanaIds": [ + "Africa/Mbabane" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "ZA", + "IanaIds": [ + "Africa/Johannesburg" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "ZM", + "IanaIds": [ + "Africa/Lusaka" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "ZW", + "IanaIds": [ + "Africa/Harare" + ] + }, + { + "WindowsId": "South Africa Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-2" + ] + }, + { + "WindowsId": "FLE Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Kiev" + ] + }, + { + "WindowsId": "FLE Standard Time", + "Territory": "AX", + "IanaIds": [ + "Europe/Mariehamn" + ] + }, + { + "WindowsId": "FLE Standard Time", + "Territory": "BG", + "IanaIds": [ + "Europe/Sofia" + ] + }, + { + "WindowsId": "FLE Standard Time", + "Territory": "EE", + "IanaIds": [ + "Europe/Tallinn" + ] + }, + { + "WindowsId": "FLE Standard Time", + "Territory": "FI", + "IanaIds": [ + "Europe/Helsinki" + ] + }, + { + "WindowsId": "FLE Standard Time", + "Territory": "LT", + "IanaIds": [ + "Europe/Vilnius" + ] + }, + { + "WindowsId": "FLE Standard Time", + "Territory": "LV", + "IanaIds": [ + "Europe/Riga" + ] + }, + { + "WindowsId": "FLE Standard Time", + "Territory": "UA", + "IanaIds": [ + "Europe/Kiev", + "Europe/Uzhgorod", + "Europe/Zaporozhye" + ] + }, + { + "WindowsId": "Israel Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Jerusalem" + ] + }, + { + "WindowsId": "Israel Standard Time", + "Territory": "IL", + "IanaIds": [ + "Asia/Jerusalem" + ] + }, + { + "WindowsId": "Kaliningrad Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Kaliningrad" + ] + }, + { + "WindowsId": "Kaliningrad Standard Time", + "Territory": "RU", + "IanaIds": [ + "Europe/Kaliningrad" + ] + }, + { + "WindowsId": "Libya Standard Time", + "Territory": "001", + "IanaIds": [ + "Africa/Tripoli" + ] + }, + { + "WindowsId": "Libya Standard Time", + "Territory": "LY", + "IanaIds": [ + "Africa/Tripoli" + ] + }, + { + "WindowsId": "Arabic Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Baghdad" + ] + }, + { + "WindowsId": "Arabic Standard Time", + "Territory": "IQ", + "IanaIds": [ + "Asia/Baghdad" + ] + }, + { + "WindowsId": "Turkey Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Istanbul" + ] + }, + { + "WindowsId": "Turkey Standard Time", + "Territory": "CY", + "IanaIds": [ + "Asia/Famagusta" + ] + }, + { + "WindowsId": "Turkey Standard Time", + "Territory": "TR", + "IanaIds": [ + "Europe/Istanbul" + ] + }, + { + "WindowsId": "Arab Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Riyadh" + ] + }, + { + "WindowsId": "Arab Standard Time", + "Territory": "BH", + "IanaIds": [ + "Asia/Bahrain" + ] + }, + { + "WindowsId": "Arab Standard Time", + "Territory": "KW", + "IanaIds": [ + "Asia/Kuwait" + ] + }, + { + "WindowsId": "Arab Standard Time", + "Territory": "QA", + "IanaIds": [ + "Asia/Qatar" + ] + }, + { + "WindowsId": "Arab Standard Time", + "Territory": "SA", + "IanaIds": [ + "Asia/Riyadh" + ] + }, + { + "WindowsId": "Arab Standard Time", + "Territory": "YE", + "IanaIds": [ + "Asia/Aden" + ] + }, + { + "WindowsId": "Belarus Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Minsk" + ] + }, + { + "WindowsId": "Belarus Standard Time", + "Territory": "BY", + "IanaIds": [ + "Europe/Minsk" + ] + }, + { + "WindowsId": "Russian Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Moscow" + ] + }, + { + "WindowsId": "Russian Standard Time", + "Territory": "RU", + "IanaIds": [ + "Europe/Moscow", + "Europe/Kirov", + "Europe/Volgograd" + ] + }, + { + "WindowsId": "Russian Standard Time", + "Territory": "UA", + "IanaIds": [ + "Europe/Simferopol" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "001", + "IanaIds": [ + "Africa/Nairobi" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "AQ", + "IanaIds": [ + "Antarctica/Syowa" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "DJ", + "IanaIds": [ + "Africa/Djibouti" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "ER", + "IanaIds": [ + "Africa/Asmera" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "ET", + "IanaIds": [ + "Africa/Addis_Ababa" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "KE", + "IanaIds": [ + "Africa/Nairobi" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "KM", + "IanaIds": [ + "Indian/Comoro" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "MG", + "IanaIds": [ + "Indian/Antananarivo" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "SD", + "IanaIds": [ + "Africa/Khartoum" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "SO", + "IanaIds": [ + "Africa/Mogadishu" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "SS", + "IanaIds": [ + "Africa/Juba" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "TZ", + "IanaIds": [ + "Africa/Dar_es_Salaam" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "UG", + "IanaIds": [ + "Africa/Kampala" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "YT", + "IanaIds": [ + "Indian/Mayotte" + ] + }, + { + "WindowsId": "E. Africa Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-3" + ] + }, + { + "WindowsId": "Iran Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Tehran" + ] + }, + { + "WindowsId": "Iran Standard Time", + "Territory": "IR", + "IanaIds": [ + "Asia/Tehran" + ] + }, + { + "WindowsId": "Arabian Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Dubai" + ] + }, + { + "WindowsId": "Arabian Standard Time", + "Territory": "AE", + "IanaIds": [ + "Asia/Dubai" + ] + }, + { + "WindowsId": "Arabian Standard Time", + "Territory": "OM", + "IanaIds": [ + "Asia/Muscat" + ] + }, + { + "WindowsId": "Arabian Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-4" + ] + }, + { + "WindowsId": "Astrakhan Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Astrakhan" + ] + }, + { + "WindowsId": "Astrakhan Standard Time", + "Territory": "RU", + "IanaIds": [ + "Europe/Astrakhan", + "Europe/Ulyanovsk" + ] + }, + { + "WindowsId": "Azerbaijan Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Baku" + ] + }, + { + "WindowsId": "Azerbaijan Standard Time", + "Territory": "AZ", + "IanaIds": [ + "Asia/Baku" + ] + }, + { + "WindowsId": "Russia Time Zone 3", + "Territory": "001", + "IanaIds": [ + "Europe/Samara" + ] + }, + { + "WindowsId": "Russia Time Zone 3", + "Territory": "RU", + "IanaIds": [ + "Europe/Samara" + ] + }, + { + "WindowsId": "Mauritius Standard Time", + "Territory": "001", + "IanaIds": [ + "Indian/Mauritius" + ] + }, + { + "WindowsId": "Mauritius Standard Time", + "Territory": "MU", + "IanaIds": [ + "Indian/Mauritius" + ] + }, + { + "WindowsId": "Mauritius Standard Time", + "Territory": "RE", + "IanaIds": [ + "Indian/Reunion" + ] + }, + { + "WindowsId": "Mauritius Standard Time", + "Territory": "SC", + "IanaIds": [ + "Indian/Mahe" + ] + }, + { + "WindowsId": "Saratov Standard Time", + "Territory": "001", + "IanaIds": [ + "Europe/Saratov" + ] + }, + { + "WindowsId": "Saratov Standard Time", + "Territory": "RU", + "IanaIds": [ + "Europe/Saratov" + ] + }, + { + "WindowsId": "Georgian Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Tbilisi" + ] + }, + { + "WindowsId": "Georgian Standard Time", + "Territory": "GE", + "IanaIds": [ + "Asia/Tbilisi" + ] + }, + { + "WindowsId": "Caucasus Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Yerevan" + ] + }, + { + "WindowsId": "Caucasus Standard Time", + "Territory": "AM", + "IanaIds": [ + "Asia/Yerevan" + ] + }, + { + "WindowsId": "Afghanistan Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Kabul" + ] + }, + { + "WindowsId": "Afghanistan Standard Time", + "Territory": "AF", + "IanaIds": [ + "Asia/Kabul" + ] + }, + { + "WindowsId": "West Asia Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Tashkent" + ] + }, + { + "WindowsId": "West Asia Standard Time", + "Territory": "AQ", + "IanaIds": [ + "Antarctica/Mawson" + ] + }, + { + "WindowsId": "West Asia Standard Time", + "Territory": "KZ", + "IanaIds": [ + "Asia/Oral", + "Asia/Aqtau", + "Asia/Aqtobe", + "Asia/Atyrau" + ] + }, + { + "WindowsId": "West Asia Standard Time", + "Territory": "MV", + "IanaIds": [ + "Indian/Maldives" + ] + }, + { + "WindowsId": "West Asia Standard Time", + "Territory": "TF", + "IanaIds": [ + "Indian/Kerguelen" + ] + }, + { + "WindowsId": "West Asia Standard Time", + "Territory": "TJ", + "IanaIds": [ + "Asia/Dushanbe" + ] + }, + { + "WindowsId": "West Asia Standard Time", + "Territory": "TM", + "IanaIds": [ + "Asia/Ashgabat" + ] + }, + { + "WindowsId": "West Asia Standard Time", + "Territory": "UZ", + "IanaIds": [ + "Asia/Tashkent", + "Asia/Samarkand" + ] + }, + { + "WindowsId": "West Asia Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-5" + ] + }, + { + "WindowsId": "Ekaterinburg Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Yekaterinburg" + ] + }, + { + "WindowsId": "Ekaterinburg Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Yekaterinburg" + ] + }, + { + "WindowsId": "Pakistan Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Karachi" + ] + }, + { + "WindowsId": "Pakistan Standard Time", + "Territory": "PK", + "IanaIds": [ + "Asia/Karachi" + ] + }, + { + "WindowsId": "India Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Calcutta" + ] + }, + { + "WindowsId": "India Standard Time", + "Territory": "IN", + "IanaIds": [ + "Asia/Calcutta" + ] + }, + { + "WindowsId": "Sri Lanka Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Colombo" + ] + }, + { + "WindowsId": "Sri Lanka Standard Time", + "Territory": "LK", + "IanaIds": [ + "Asia/Colombo" + ] + }, + { + "WindowsId": "Nepal Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Katmandu" + ] + }, + { + "WindowsId": "Nepal Standard Time", + "Territory": "NP", + "IanaIds": [ + "Asia/Katmandu" + ] + }, + { + "WindowsId": "Central Asia Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Almaty" + ] + }, + { + "WindowsId": "Central Asia Standard Time", + "Territory": "AQ", + "IanaIds": [ + "Antarctica/Vostok" + ] + }, + { + "WindowsId": "Central Asia Standard Time", + "Territory": "CN", + "IanaIds": [ + "Asia/Urumqi" + ] + }, + { + "WindowsId": "Central Asia Standard Time", + "Territory": "IO", + "IanaIds": [ + "Indian/Chagos" + ] + }, + { + "WindowsId": "Central Asia Standard Time", + "Territory": "KG", + "IanaIds": [ + "Asia/Bishkek" + ] + }, + { + "WindowsId": "Central Asia Standard Time", + "Territory": "KZ", + "IanaIds": [ + "Asia/Almaty", + "Asia/Qyzylorda" + ] + }, + { + "WindowsId": "Central Asia Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-6" + ] + }, + { + "WindowsId": "Bangladesh Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Dhaka" + ] + }, + { + "WindowsId": "Bangladesh Standard Time", + "Territory": "BD", + "IanaIds": [ + "Asia/Dhaka" + ] + }, + { + "WindowsId": "Bangladesh Standard Time", + "Territory": "BT", + "IanaIds": [ + "Asia/Thimphu" + ] + }, + { + "WindowsId": "Omsk Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Omsk" + ] + }, + { + "WindowsId": "Omsk Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Omsk" + ] + }, + { + "WindowsId": "Myanmar Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Rangoon" + ] + }, + { + "WindowsId": "Myanmar Standard Time", + "Territory": "CC", + "IanaIds": [ + "Indian/Cocos" + ] + }, + { + "WindowsId": "Myanmar Standard Time", + "Territory": "MM", + "IanaIds": [ + "Asia/Rangoon" + ] + }, + { + "WindowsId": "SE Asia Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Bangkok" + ] + }, + { + "WindowsId": "SE Asia Standard Time", + "Territory": "AQ", + "IanaIds": [ + "Antarctica/Davis" + ] + }, + { + "WindowsId": "SE Asia Standard Time", + "Territory": "CX", + "IanaIds": [ + "Indian/Christmas" + ] + }, + { + "WindowsId": "SE Asia Standard Time", + "Territory": "ID", + "IanaIds": [ + "Asia/Jakarta", + "Asia/Pontianak" + ] + }, + { + "WindowsId": "SE Asia Standard Time", + "Territory": "KH", + "IanaIds": [ + "Asia/Phnom_Penh" + ] + }, + { + "WindowsId": "SE Asia Standard Time", + "Territory": "LA", + "IanaIds": [ + "Asia/Vientiane" + ] + }, + { + "WindowsId": "SE Asia Standard Time", + "Territory": "TH", + "IanaIds": [ + "Asia/Bangkok" + ] + }, + { + "WindowsId": "SE Asia Standard Time", + "Territory": "VN", + "IanaIds": [ + "Asia/Saigon" + ] + }, + { + "WindowsId": "SE Asia Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-7" + ] + }, + { + "WindowsId": "Altai Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Barnaul" + ] + }, + { + "WindowsId": "Altai Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Barnaul" + ] + }, + { + "WindowsId": "W. Mongolia Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Hovd" + ] + }, + { + "WindowsId": "W. Mongolia Standard Time", + "Territory": "MN", + "IanaIds": [ + "Asia/Hovd" + ] + }, + { + "WindowsId": "North Asia Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Krasnoyarsk" + ] + }, + { + "WindowsId": "North Asia Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Krasnoyarsk", + "Asia/Novokuznetsk" + ] + }, + { + "WindowsId": "N. Central Asia Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Novosibirsk" + ] + }, + { + "WindowsId": "N. Central Asia Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Novosibirsk" + ] + }, + { + "WindowsId": "Tomsk Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Tomsk" + ] + }, + { + "WindowsId": "Tomsk Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Tomsk" + ] + }, + { + "WindowsId": "China Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Shanghai" + ] + }, + { + "WindowsId": "China Standard Time", + "Territory": "CN", + "IanaIds": [ + "Asia/Shanghai" + ] + }, + { + "WindowsId": "China Standard Time", + "Territory": "HK", + "IanaIds": [ + "Asia/Hong_Kong" + ] + }, + { + "WindowsId": "China Standard Time", + "Territory": "MO", + "IanaIds": [ + "Asia/Macau" + ] + }, + { + "WindowsId": "North Asia East Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Irkutsk" + ] + }, + { + "WindowsId": "North Asia East Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Irkutsk" + ] + }, + { + "WindowsId": "Singapore Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Singapore" + ] + }, + { + "WindowsId": "Singapore Standard Time", + "Territory": "BN", + "IanaIds": [ + "Asia/Brunei" + ] + }, + { + "WindowsId": "Singapore Standard Time", + "Territory": "ID", + "IanaIds": [ + "Asia/Makassar" + ] + }, + { + "WindowsId": "Singapore Standard Time", + "Territory": "MY", + "IanaIds": [ + "Asia/Kuala_Lumpur", + "Asia/Kuching" + ] + }, + { + "WindowsId": "Singapore Standard Time", + "Territory": "PH", + "IanaIds": [ + "Asia/Manila" + ] + }, + { + "WindowsId": "Singapore Standard Time", + "Territory": "SG", + "IanaIds": [ + "Asia/Singapore" + ] + }, + { + "WindowsId": "Singapore Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-8" + ] + }, + { + "WindowsId": "W. Australia Standard Time", + "Territory": "001", + "IanaIds": [ + "Australia/Perth" + ] + }, + { + "WindowsId": "W. Australia Standard Time", + "Territory": "AU", + "IanaIds": [ + "Australia/Perth" + ] + }, + { + "WindowsId": "Taipei Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Taipei" + ] + }, + { + "WindowsId": "Taipei Standard Time", + "Territory": "TW", + "IanaIds": [ + "Asia/Taipei" + ] + }, + { + "WindowsId": "Ulaanbaatar Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Ulaanbaatar" + ] + }, + { + "WindowsId": "Ulaanbaatar Standard Time", + "Territory": "MN", + "IanaIds": [ + "Asia/Ulaanbaatar", + "Asia/Choibalsan" + ] + }, + { + "WindowsId": "North Korea Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Pyongyang" + ] + }, + { + "WindowsId": "North Korea Standard Time", + "Territory": "KP", + "IanaIds": [ + "Asia/Pyongyang" + ] + }, + { + "WindowsId": "Aus Central W. Standard Time", + "Territory": "001", + "IanaIds": [ + "Australia/Eucla" + ] + }, + { + "WindowsId": "Aus Central W. Standard Time", + "Territory": "AU", + "IanaIds": [ + "Australia/Eucla" + ] + }, + { + "WindowsId": "Transbaikal Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Chita" + ] + }, + { + "WindowsId": "Transbaikal Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Chita" + ] + }, + { + "WindowsId": "Tokyo Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Tokyo" + ] + }, + { + "WindowsId": "Tokyo Standard Time", + "Territory": "ID", + "IanaIds": [ + "Asia/Jayapura" + ] + }, + { + "WindowsId": "Tokyo Standard Time", + "Territory": "JP", + "IanaIds": [ + "Asia/Tokyo" + ] + }, + { + "WindowsId": "Tokyo Standard Time", + "Territory": "PW", + "IanaIds": [ + "Pacific/Palau" + ] + }, + { + "WindowsId": "Tokyo Standard Time", + "Territory": "TL", + "IanaIds": [ + "Asia/Dili" + ] + }, + { + "WindowsId": "Tokyo Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-9" + ] + }, + { + "WindowsId": "Korea Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Seoul" + ] + }, + { + "WindowsId": "Korea Standard Time", + "Territory": "KR", + "IanaIds": [ + "Asia/Seoul" + ] + }, + { + "WindowsId": "Yakutsk Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Yakutsk" + ] + }, + { + "WindowsId": "Yakutsk Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Yakutsk", + "Asia/Khandyga" + ] + }, + { + "WindowsId": "Cen. Australia Standard Time", + "Territory": "001", + "IanaIds": [ + "Australia/Adelaide" + ] + }, + { + "WindowsId": "Cen. Australia Standard Time", + "Territory": "AU", + "IanaIds": [ + "Australia/Adelaide", + "Australia/Broken_Hill" + ] + }, + { + "WindowsId": "AUS Central Standard Time", + "Territory": "001", + "IanaIds": [ + "Australia/Darwin" + ] + }, + { + "WindowsId": "AUS Central Standard Time", + "Territory": "AU", + "IanaIds": [ + "Australia/Darwin" + ] + }, + { + "WindowsId": "E. Australia Standard Time", + "Territory": "001", + "IanaIds": [ + "Australia/Brisbane" + ] + }, + { + "WindowsId": "E. Australia Standard Time", + "Territory": "AU", + "IanaIds": [ + "Australia/Brisbane", + "Australia/Lindeman" + ] + }, + { + "WindowsId": "AUS Eastern Standard Time", + "Territory": "001", + "IanaIds": [ + "Australia/Sydney" + ] + }, + { + "WindowsId": "AUS Eastern Standard Time", + "Territory": "AU", + "IanaIds": [ + "Australia/Sydney", + "Australia/Melbourne" + ] + }, + { + "WindowsId": "West Pacific Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Port_Moresby" + ] + }, + { + "WindowsId": "West Pacific Standard Time", + "Territory": "AQ", + "IanaIds": [ + "Antarctica/DumontDUrville" + ] + }, + { + "WindowsId": "West Pacific Standard Time", + "Territory": "FM", + "IanaIds": [ + "Pacific/Truk" + ] + }, + { + "WindowsId": "West Pacific Standard Time", + "Territory": "GU", + "IanaIds": [ + "Pacific/Guam" + ] + }, + { + "WindowsId": "West Pacific Standard Time", + "Territory": "MP", + "IanaIds": [ + "Pacific/Saipan" + ] + }, + { + "WindowsId": "West Pacific Standard Time", + "Territory": "PG", + "IanaIds": [ + "Pacific/Port_Moresby" + ] + }, + { + "WindowsId": "West Pacific Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-10" + ] + }, + { + "WindowsId": "Tasmania Standard Time", + "Territory": "001", + "IanaIds": [ + "Australia/Hobart" + ] + }, + { + "WindowsId": "Tasmania Standard Time", + "Territory": "AU", + "IanaIds": [ + "Australia/Hobart", + "Australia/Currie" + ] + }, + { + "WindowsId": "Vladivostok Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Vladivostok" + ] + }, + { + "WindowsId": "Vladivostok Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Vladivostok", + "Asia/Ust-Nera" + ] + }, + { + "WindowsId": "Lord Howe Standard Time", + "Territory": "001", + "IanaIds": [ + "Australia/Lord_Howe" + ] + }, + { + "WindowsId": "Lord Howe Standard Time", + "Territory": "AU", + "IanaIds": [ + "Australia/Lord_Howe" + ] + }, + { + "WindowsId": "Bougainville Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Bougainville" + ] + }, + { + "WindowsId": "Bougainville Standard Time", + "Territory": "PG", + "IanaIds": [ + "Pacific/Bougainville" + ] + }, + { + "WindowsId": "Russia Time Zone 10", + "Territory": "001", + "IanaIds": [ + "Asia/Srednekolymsk" + ] + }, + { + "WindowsId": "Russia Time Zone 10", + "Territory": "RU", + "IanaIds": [ + "Asia/Srednekolymsk" + ] + }, + { + "WindowsId": "Magadan Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Magadan" + ] + }, + { + "WindowsId": "Magadan Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Magadan" + ] + }, + { + "WindowsId": "Norfolk Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Norfolk" + ] + }, + { + "WindowsId": "Norfolk Standard Time", + "Territory": "NF", + "IanaIds": [ + "Pacific/Norfolk" + ] + }, + { + "WindowsId": "Sakhalin Standard Time", + "Territory": "001", + "IanaIds": [ + "Asia/Sakhalin" + ] + }, + { + "WindowsId": "Sakhalin Standard Time", + "Territory": "RU", + "IanaIds": [ + "Asia/Sakhalin" + ] + }, + { + "WindowsId": "Central Pacific Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Guadalcanal" + ] + }, + { + "WindowsId": "Central Pacific Standard Time", + "Territory": "AQ", + "IanaIds": [ + "Antarctica/Casey" + ] + }, + { + "WindowsId": "Central Pacific Standard Time", + "Territory": "AU", + "IanaIds": [ + "Antarctica/Macquarie" + ] + }, + { + "WindowsId": "Central Pacific Standard Time", + "Territory": "FM", + "IanaIds": [ + "Pacific/Ponape", + "Pacific/Kosrae" + ] + }, + { + "WindowsId": "Central Pacific Standard Time", + "Territory": "NC", + "IanaIds": [ + "Pacific/Noumea" + ] + }, + { + "WindowsId": "Central Pacific Standard Time", + "Territory": "SB", + "IanaIds": [ + "Pacific/Guadalcanal" + ] + }, + { + "WindowsId": "Central Pacific Standard Time", + "Territory": "VU", + "IanaIds": [ + "Pacific/Efate" + ] + }, + { + "WindowsId": "Central Pacific Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-11" + ] + }, + { + "WindowsId": "Russia Time Zone 11", + "Territory": "001", + "IanaIds": [ + "Asia/Kamchatka" + ] + }, + { + "WindowsId": "Russia Time Zone 11", + "Territory": "RU", + "IanaIds": [ + "Asia/Kamchatka", + "Asia/Anadyr" + ] + }, + { + "WindowsId": "New Zealand Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Auckland" + ] + }, + { + "WindowsId": "New Zealand Standard Time", + "Territory": "AQ", + "IanaIds": [ + "Antarctica/McMurdo" + ] + }, + { + "WindowsId": "New Zealand Standard Time", + "Territory": "NZ", + "IanaIds": [ + "Pacific/Auckland" + ] + }, + { + "WindowsId": "UTC+12", + "Territory": "001", + "IanaIds": [ + "Etc/GMT-12" + ] + }, + { + "WindowsId": "UTC+12", + "Territory": "KI", + "IanaIds": [ + "Pacific/Tarawa" + ] + }, + { + "WindowsId": "UTC+12", + "Territory": "MH", + "IanaIds": [ + "Pacific/Majuro", + "Pacific/Kwajalein" + ] + }, + { + "WindowsId": "UTC+12", + "Territory": "NR", + "IanaIds": [ + "Pacific/Nauru" + ] + }, + { + "WindowsId": "UTC+12", + "Territory": "TV", + "IanaIds": [ + "Pacific/Funafuti" + ] + }, + { + "WindowsId": "UTC+12", + "Territory": "UM", + "IanaIds": [ + "Pacific/Wake" + ] + }, + { + "WindowsId": "UTC+12", + "Territory": "WF", + "IanaIds": [ + "Pacific/Wallis" + ] + }, + { + "WindowsId": "UTC+12", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-12" + ] + }, + { + "WindowsId": "Fiji Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Fiji" + ] + }, + { + "WindowsId": "Fiji Standard Time", + "Territory": "FJ", + "IanaIds": [ + "Pacific/Fiji" + ] + }, + { + "WindowsId": "Chatham Islands Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Chatham" + ] + }, + { + "WindowsId": "Chatham Islands Standard Time", + "Territory": "NZ", + "IanaIds": [ + "Pacific/Chatham" + ] + }, + { + "WindowsId": "UTC+13", + "Territory": "001", + "IanaIds": [ + "Etc/GMT-13" + ] + }, + { + "WindowsId": "UTC+13", + "Territory": "KI", + "IanaIds": [ + "Pacific/Enderbury" + ] + }, + { + "WindowsId": "UTC+13", + "Territory": "TK", + "IanaIds": [ + "Pacific/Fakaofo" + ] + }, + { + "WindowsId": "UTC+13", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-13" + ] + }, + { + "WindowsId": "Tonga Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Tongatapu" + ] + }, + { + "WindowsId": "Tonga Standard Time", + "Territory": "TO", + "IanaIds": [ + "Pacific/Tongatapu" + ] + }, + { + "WindowsId": "Samoa Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Apia" + ] + }, + { + "WindowsId": "Samoa Standard Time", + "Territory": "WS", + "IanaIds": [ + "Pacific/Apia" + ] + }, + { + "WindowsId": "Line Islands Standard Time", + "Territory": "001", + "IanaIds": [ + "Pacific/Kiritimati" + ] + }, + { + "WindowsId": "Line Islands Standard Time", + "Territory": "KI", + "IanaIds": [ + "Pacific/Kiritimati" + ] + }, + { + "WindowsId": "Line Islands Standard Time", + "Territory": "ZZ", + "IanaIds": [ + "Etc/GMT-14" + ] + } + ] + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneIANAVersion.json b/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneIANAVersion.json new file mode 100644 index 000000000000..9c1d1d21cd58 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneIANAVersion.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "version": "2017b" + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneWindowsToIANA.json b/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneWindowsToIANA.json new file mode 100644 index 000000000000..7bdd480909fb --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/examples/GetTimezoneWindowsToIANA.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "format": "json", + "api-version": "1.0", + "query": "pacific standard time", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": [ + { + "id": "America/Los_Angeles", + "isAlias": false, + "hasZone1970Location": true + } + ] + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/timezone.json b/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/timezone.json new file mode 100644 index 000000000000..3ba00c93f71f --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Timezone/preview/1.0/timezone.json @@ -0,0 +1,1009 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Time Zone Service", + "version": "1.0", + "description": "Azure Maps Time Zone REST APIs" + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json", + "application/xml" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "user_impersonation": "Impersonates a user's Azure Active Directory account." + } + }, + "apiKeyQuery": { + "type": "apiKey", + "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + } + }, + "security": [ + { + "azure_auth": [] + }, + { + "apiKeyQuery": [] + } + ], + "responses": { + "400": { + "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "401": { + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + }, + "headers": { + "WWW-Authenticate": { + "type": "string", + "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" + } + } + }, + "403": { + "description": "Permission, capacity, or authentication issues.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "404": { + "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "500": { + "description": "An error occurred while processing the request. Please try again later.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + } + }, + "parameters": { + "ClientId": { + "name": "x-ms-client-id", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "client" + }, + "SubscriptionKey": { + "name": "subscription-key", + "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API. Current version is 1.0", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "JsonFormat": { + "name": "format", + "description": "Desired format of the response. Only `json` format is supported.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "json" + ], + "x-ms-enum": { + "name": "JsonFormat", + "modelAsString": false, + "values": [ + { + "value": "json", + "description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "TimezoneAcceptLanguage": { + "name": "Accept-Language", + "in": "header", + "description": "Specifies the language code in which the timezone names should be returned. If no language code is provided, the response will be in \"EN\". Please refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "TimezoneOptions": { + "name": "options", + "in": "query", + "description": "Alternatively, use alias \"o\". Options available for types of information returned in the result.", + "required": false, + "type": "string", + "enum": [ + "none", + "zoneInfo", + "transitions", + "all" + ], + "x-ms-enum": { + "name": "TimezoneOptions", + "modelAsString": false, + "values": [ + { + "value": "none", + "description": "Do not include zoneinfo or transitions in the result." + }, + { + "value": "zoneInfo", + "description": "Include additional time zone info in the result." + }, + { + "value": "transitions", + "description": "Include transition information in the result (The number of transitions is currently capped at 250)." + }, + { + "value": "all", + "description": "Include both zoneinfo and transitions in the result." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "TimezoneTimeStamp": { + "name": "timeStamp", + "in": "query", + "description": "Alternatively, use alias \"stamp\", or \"s\". Reference time, if omitted, the API will use the machine time serving the request.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "format": "date-time" + }, + "TimezoneTransitionsFrom": { + "name": "transitionsFrom", + "in": "query", + "description": "Alternatively, use alias \"tf\". The start date from which daylight savings time (DST) transitions are requested, only applies when \"options\" = all or \"options\" = transitions.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "format": "date-time" + }, + "TimezoneTransitionsYears": { + "name": "transitionsYears", + "in": "query", + "description": "Alternatively, use alias \"ty\". The number of years from \"transitionsFrom\" for which DST transitions are requested, only applies when \"options\" = all or \"options\" = transitions.", + "required": false, + "type": "integer", + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/timezone/byId/{format}": { + "get": { + "x-publish": true, + "description": "__Time Zone by Id__\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis API returns current, historical, and future time zone information for the specified IANA time zone ID.", + "operationId": "Timezone_GetTimezoneByID", + "x-ms-examples": { + "GetTimezoneByID": { + "$ref": "./examples/GetTimezoneByID.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TimezoneAcceptLanguage" + }, + { + "$ref": "#/parameters/TimezoneOptions" + }, + { + "$ref": "#/parameters/TimezoneTimeStamp" + }, + { + "$ref": "#/parameters/TimezoneTransitionsFrom" + }, + { + "$ref": "#/parameters/TimezoneTransitionsYears" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "query", + "in": "query", + "description": "The IANA time zone ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TimezoneByIdResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "produces": [ + "application/json" + ] + } + }, + "/timezone/byCoordinates/{format}": { + "get": { + "x-publish": true, + "description": "__Time Zone by Coordinates__\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis API returns current, historical, and future time zone information for a specified latitude-longitude pair. In addition, the API provides sunset and sunrise times for a given location.", + "operationId": "Timezone_GetTimezoneByCoordinates", + "x-ms-examples": { + "GetTimezoneByCoordinates": { + "$ref": "./examples/GetTimezoneByCoordinates.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TimezoneAcceptLanguage" + }, + { + "$ref": "#/parameters/TimezoneOptions" + }, + { + "$ref": "#/parameters/TimezoneTimeStamp" + }, + { + "$ref": "#/parameters/TimezoneTransitionsFrom" + }, + { + "$ref": "#/parameters/TimezoneTransitionsYears" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "query", + "in": "query", + "description": "Coordinates of the point for which time zone information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TimezoneByCoordinatesResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "produces": [ + "application/json" + ] + } + }, + "/timezone/enumWindows/{format}": { + "get": { + "x-publish": true, + "description": "__Enumerate Windows Time Zones__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis API returns a full list of Windows Time Zone IDs.", + "operationId": "Timezone_GetTimezoneEnumWindows", + "x-ms-examples": { + "GetTimezoneEnumWindows": { + "$ref": "./examples/GetTimezoneEnumWindows.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TimezoneEnumWindowsResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "produces": [ + "application/json" + ] + } + }, + "/timezone/enumIana/{format}": { + "get": { + "x-publish": true, + "description": "__Enumerate IANA Time Zones__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis API returns a full list of IANA time zone IDs. Updates to the IANA service will be reflected in the system within one day.", + "operationId": "Timezone_GetTimezoneEnumIANA", + "x-ms-examples": { + "GetTimezoneEnumIANA": { + "$ref": "./examples/GetTimezoneEnumIANA.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TimezoneEnumIanaResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "produces": [ + "application/json" + ] + } + }, + "/timezone/ianaVersion/{format}": { + "get": { + "x-publish": true, + "description": "__Time Zone IANA Version__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis API returns the current IANA version number.", + "operationId": "Timezone_GetTimezoneIANAVersion", + "x-ms-examples": { + "GetTimezoneIANAVersion": { + "$ref": "./examples/GetTimezoneIANAVersion.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TimezoneIanaVersionResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "produces": [ + "application/json" + ] + } + }, + "/timezone/windowsToIana/{format}": { + "get": { + "x-publish": true, + "description": "__Windows to IANA Time Zone__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nThis API returns a corresponding IANA ID, given a valid Windows Time Zone ID. Multiple IANA IDs may be returned for a single Windows ID. It is possible to narrow these results by adding an optional territory parameter.", + "operationId": "Timezone_GetTimezoneWindowsToIANA", + "x-ms-examples": { + "GetTimezoneWindowsToIANA": { + "$ref": "./examples/GetTimezoneWindowsToIANA.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "query", + "in": "query", + "description": "The Windows time zone ID.", + "required": true, + "type": "string" + }, + { + "name": "territory", + "in": "query", + "description": "Windows Time Zone territory code.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TimezoneWindowToIanaResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "produces": [ + "application/json" + ] + } + } + }, + "definitions": { + "ODataErrorResponse": { + "type": "object", + "description": "This response object is returned when an error occurs in the Maps API.", + "properties": { + "error": { + "$ref": "#/definitions/ODataError" + } + } + }, + "ODataError": { + "type": "object", + "description": "This object is returned when an error occurs in the Maps API.", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The ODataError code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + } + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the target causing the error." + } + } + }, + "Country": { + "type": "object", + "description": "A country record.", + "properties": { + "Name": { + "description": "Country Name", + "type": "string", + "readOnly": true + }, + "Code": { + "description": "ISO-3166 2-letter country code for the country.", + "type": "string", + "readOnly": true + } + } + }, + "TimeTransition": { + "type": "object", + "readOnly": true, + "properties": { + "Tag": { + "description": "Tag property", + "type": "string", + "readOnly": true + }, + "StandardOffset": { + "description": "StandardOffset property", + "type": "string", + "readOnly": true + }, + "DaylightSavings": { + "description": "DaylightSavings property", + "type": "string", + "readOnly": true + }, + "UtcStart": { + "description": "Start date, start time for this transition period", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "UtcEnd": { + "description": "End date, end time for this transition period", + "type": "string", + "readOnly": true, + "format": "date-time" + } + } + }, + "TimezoneByIdResult": { + "description": "This object is returned from a successful Timezone By ID call", + "type": "object", + "properties": { + "Version": { + "description": "Version property", + "type": "string", + "readOnly": true + }, + "ReferenceUtcTimestamp": { + "description": "Reference Utc Timestamp property", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "TimeZones": { + "$ref": "#/definitions/TimeZonesById" + } + } + }, + "TimezoneByCoordinatesResult": { + "description": "This object is returned from a successful Timezone By Coordinates call", + "type": "object", + "properties": { + "Version": { + "description": "Version property", + "type": "string", + "readOnly": true + }, + "ReferenceUtcTimestamp": { + "description": "Reference Utc Timestamp property", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "TimeZones": { + "$ref": "#/definitions/TimeZonesByCoordinates" + } + } + }, + "TimezoneEnumWindowsResult": { + "description": "This object is returned from a successful Timezone Enum Windows call", + "type": "array", + "items": { + "$ref": "#/definitions/TimezoneEnumWindow" + } + }, + "TimezoneEnumWindow": { + "type": "object", + "properties": { + "WindowsId": { + "description": "Windows Id property", + "type": "string", + "readOnly": true + }, + "Territory": { + "description": "Territory property", + "type": "string", + "readOnly": true + }, + "IanaIds": { + "description": "IanaIds array", + "type": "array", + "items": { + "type": "string", + "readOnly": true + } + } + } + }, + "TimezoneEnumIanaResult": { + "description": "This object is returned from a successful Timezone Enum IANA call", + "type": "array", + "items": { + "$ref": "#/definitions/IanaId" + } + }, + "TimezoneIanaVersionResult": { + "description": "This object is returned from a successful Timezone IANA Version call", + "type": "object", + "properties": { + "version": { + "description": "Version property", + "type": "string", + "readOnly": true + } + } + }, + "TimezoneWindowToIanaResult": { + "description": "This object is returned from a successful Timezone Windows To IANA call", + "type": "array", + "items": { + "$ref": "#/definitions/IanaId" + } + }, + "IanaId": { + "type": "object", + "properties": { + "id": { + "description": "Id property", + "type": "string", + "readOnly": true + }, + "isAlias": { + "description": "IsAlias property", + "type": "boolean", + "readOnly": true + }, + "aliasOf": { + "description": "AliasOf property", + "type": "string", + "readOnly": true + }, + "hasZone1970Location": { + "description": "HasZone1970Location property", + "type": "boolean", + "readOnly": true + } + } + }, + "TimeZonesById": { + "description": "TimeZoneById array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TimezoneById" + } + }, + "TimeZonesByCoordinates": { + "description": "TimeZoneByCoordinates array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TimeZoneByCoordinates" + } + }, + "TimezoneById": { + "type": "object", + "properties": { + "Id": { + "description": "Id property", + "type": "string", + "readOnly": true + }, + "Aliases": { + "description": "An array of time zone ID aliases.  Only returned when [options]=*zoneinfo* or *all*.\n\nNote: may be null.", + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "readOnly": true + } + }, + "Countries": { + "description": "An array of country records. Only returned when [options]=*zoneinfo* or *all*.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Country" + } + }, + "Names": { + "$ref": "#/definitions/Names" + }, + "ReferenceTime": { + "$ref": "#/definitions/ReferenceTimeById" + }, + "RepresentativePoint": { + "$ref": "#/definitions/RepresentativePoint" + }, + "TimeTransitions": { + "description": "Time zone DST transitions from [transitionsFrom] until timestamp + 1 year.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TimeTransition" + } + } + } + }, + "TimeZoneByCoordinates": { + "type": "object", + "properties": { + "Id": { + "description": "Id property", + "type": "string", + "readOnly": true + }, + "Aliases": { + "description": "An array of time zone ID aliases.  Only returned when [options]=*zoneinfo* or *all*.\n\nNote: may be null.", + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "readOnly": true + } + }, + "Countries": { + "description": "An array of country records. Only returned when [options]=*zoneinfo* or *all*.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Country" + } + }, + "Names": { + "$ref": "#/definitions/Names" + }, + "ReferenceTime": { + "$ref": "#/definitions/ReferenceTimeByCoordinates" + }, + "RepresentativePoint": { + "$ref": "#/definitions/RepresentativePoint" + }, + "TimeTransitions": { + "description": "Time zone DST transitions from [transitionsFrom] until timestamp + 1 year.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TimeTransition" + } + } + } + }, + "Names": { + "type": "object", + "description": "Timezone names object.", + "properties": { + "ISO6391LanguageCode": { + "description": "The ISO 639-1 language code of the Names", + "type": "string", + "readOnly": true + }, + "Generic": { + "description": "Generic Name", + "type": "string", + "readOnly": true + }, + "Standard": { + "description": "Standard Name", + "type": "string", + "readOnly": true + }, + "Daylight": { + "description": "Daylight Name", + "type": "string", + "readOnly": true + } + } + }, + "ReferenceTimeById": { + "description": "Details in effect at the local time.", + "type": "object", + "readOnly": true, + "properties": { + "Tag": { + "description": "Time zone name in effect at the reference timestamp (i.e. PST or PDT depending whether Daylight Savings Time is in effect).", + "type": "string", + "readOnly": true + }, + "StandardOffset": { + "description": "UTC offset in effect at the `ReferenceUTCTimestamp`.", + "type": "string", + "readOnly": true + }, + "DaylightSavings": { + "description": "Time saving in minutes in effect at the `ReferenceUTCTimestamp`.", + "type": "string", + "readOnly": true + }, + "WallTime": { + "description": "Current wall time at the given time zone as shown in the `Tag` property.", + "type": "string", + "readOnly": true + }, + "PosixTzValidYear": { + "description": "The year this POSIX string is valid for. Note: A POSIX string will only be valid in the given year.", + "type": "integer", + "readOnly": true + }, + "PosixTz": { + "description": "POSIX string used to set the time zone environment variable.", + "type": "string", + "readOnly": true + } + } + }, + "ReferenceTimeByCoordinates": { + "description": "Details in effect at the local time.", + "type": "object", + "readOnly": true, + "properties": { + "Tag": { + "description": "Time zone name in effect at the reference timestamp (i.e. PST or PDT depending whether Daylight Savings Time is in effect).", + "type": "string", + "readOnly": true + }, + "StandardOffset": { + "description": "UTC offset in effect at the `ReferenceUTCTimestamp`.", + "type": "string", + "readOnly": true + }, + "DaylightSavings": { + "description": "Time saving in minutes in effect at the `ReferenceUTCTimestamp`.", + "type": "string", + "readOnly": true + }, + "WallTime": { + "description": "Current wall time at the given time zone as shown in the `Tag` property.", + "type": "string", + "readOnly": true + }, + "PosixTzValidYear": { + "description": "The year this POSIX string is valid for. Note: A POSIX string will only be valid in the given year.", + "type": "integer", + "readOnly": true + }, + "PosixTz": { + "description": "POSIX string used to set the time zone environment variable.", + "type": "string", + "readOnly": true + }, + "Sunrise": { + "description": "Sunrise at the given time zone as shown in the `Tag` property.", + "type": "string", + "readOnly": true + }, + "Sunset": { + "description": "Sunset at the given time zone as shown in the `Tag` property.", + "type": "string", + "readOnly": true + } + } + }, + "RepresentativePoint": { + "description": "Representative point property", + "type": "object", + "readOnly": true, + "properties": { + "Latitude": { + "description": "Latitude property", + "type": "number", + "readOnly": true + }, + "Longitude": { + "description": "Longitude property", + "type": "number", + "readOnly": true + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/examples/GetTrafficFlowSegment.json b/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/examples/GetTrafficFlowSegment.json new file mode 100644 index 000000000000..260df3e59fd3 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/examples/GetTrafficFlowSegment.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "style": "absolute", + "zoom": 10, + "query": "52.41072,4.84239", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "flowSegmentData": { + "frc": "FRC3", + "currentSpeed": 79, + "freeFlowSpeed": 79, + "currentTravelTime": 33, + "freeFlowTravelTime": 33, + "confidence": 0.5, + "coordinates": { + "coordinate": [ + { + "latitude": 52.404648, + "longitude": 4.8442388 + }, + { + "latitude": 52.408447, + "longitude": 4.8357286 + } + ] + }, + "openlr": null, + "@version": "1.0.53-mascoma" + } + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/examples/GetTrafficFlowTile.json b/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/examples/GetTrafficFlowTile.json new file mode 100644 index 000000000000..db22b3435096 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/examples/GetTrafficFlowTile.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "png", + "style": "absolute", + "zoom": 12, + "x": 2044, + "y": 1360, + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": "binary string image" + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/examples/GetTrafficIncidentDetail.json b/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/examples/GetTrafficIncidentDetail.json new file mode 100644 index 000000000000..69024b136001 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/examples/GetTrafficIncidentDetail.json @@ -0,0 +1,383 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "style": "s3", + "boundingbox": "6841263.950712,511972.674418,6886056.049288,582676.925582", + "boundingZoom": 11, + "trafficmodelid": "1335294634919", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "tm": { + "@id": "1521671948910", + "poi": [ + { + "id": "europe_HD_NL_TTR116377227776064", + "p": { + "x": 538636.9, + "y": 6842004.5 + }, + "ic": 9, + "ty": 1, + "cs": 0, + "d": "roadworks", + "c": "new roadworks layout", + "f": "Amstelveen/Vinkeveen - N201 (N196)", + "t": "Uithoorn-Centrum (N196)", + "l": 220, + "dl": 14, + "r": "N196" + }, + { + "id": "europe_CLUSTER_11_-34959639", + "p": { + "x": 528668.6, + "y": 6848897.9 + }, + "ic": 8, + "ty": 0, + "cbl": { + "x": 528622.5, + "y": 6848661.2 + }, + "ctr": { + "x": 528714.7, + "y": 6849134.6 + }, + "cs": 2, + "l": 190 + }, + { + "id": "europe_CLUSTER_11_-1540737434", + "p": { + "x": 518277, + "y": 6852206.8 + }, + "ic": 9, + "ty": 1, + "cbl": { + "x": 517421.3, + "y": 6851776.4 + }, + "ctr": { + "x": 519132.8, + "y": 6852637.2 + }, + "cs": 2, + "l": 1620 + }, + { + "id": "europe_CLUSTER_11_-26712906", + "p": { + "x": 529902.2, + "y": 6855622.4 + }, + "ic": 8, + "ty": 0, + "cbl": { + "x": 529524.6, + "y": 6855377.2 + }, + "ctr": { + "x": 530279.9, + "y": 6855867.7 + }, + "cs": 4, + "l": 660 + }, + { + "id": "europe_HD_NL_TTR116367997504816", + "p": { + "x": 568216, + "y": 6851287.6 + }, + "ic": 9, + "ty": 1, + "cs": 0, + "d": "roadworks", + "c": "new roadworks layout", + "f": "Ankeveen (N236)", + "t": "Weesp (N236)", + "l": 2760, + "dl": 73, + "r": "N236" + }, + { + "id": "europe_HD_NL_TTR116367997261488", + "p": { + "x": 561973.7, + "y": 6854259.4 + }, + "ic": 9, + "ty": 3, + "cs": 0, + "d": "roadworks", + "c": "new roadworks layout", + "f": "Weesp (N236)", + "t": "Ankeveen (N236)", + "l": 2650, + "r": "N236" + }, + { + "id": "europe_HD_NL_TTR116331064819392", + "p": { + "x": 571268.5, + "y": 6858435.4 + }, + "ic": 8, + "ty": 4, + "cs": 0, + "d": "closed", + "f": "IJsselmeerweg", + "t": "A6", + "l": 370 + }, + { + "id": "europe_CLUSTER_11_-1442937814", + "p": { + "x": 563934, + "y": 6859271.3 + }, + "ic": 9, + "ty": 1, + "cbl": { + "x": 563726.1, + "y": 6859250.4 + }, + "ctr": { + "x": 564141.9, + "y": 6859292.2 + }, + "cs": 2, + "l": 460 + }, + { + "id": "europe_CLUSTER_11_258400781", + "p": { + "x": 558055.6, + "y": 6861147.1 + }, + "ic": 13, + "ty": 1, + "cbl": { + "x": 557493.3, + "y": 6860514.8 + }, + "ctr": { + "x": 558618, + "y": 6861779.4 + }, + "cs": 3, + "l": 1030 + }, + { + "id": "europe_HD_NL_TTR116100227865681", + "p": { + "x": 542665, + "y": 6861959.7 + }, + "ic": 8, + "ty": 4, + "cs": 0, + "d": "closed", + "f": "Strawinskylaan", + "t": "Matthijs Vermeulenpad", + "l": 110 + }, + { + "id": "europe_CLUSTER_11_1438243625", + "p": { + "x": 545058.7, + "y": 6864571.6 + }, + "ic": 8, + "ty": 0, + "cbl": { + "x": 543779.5, + "y": 6864070.7 + }, + "ctr": { + "x": 546337.8, + "y": 6865072.6 + }, + "cs": 5, + "l": 1590 + }, + { + "id": "europe_HD_NL_TTR116081762316976", + "p": { + "x": 547507.8, + "y": 6866259.3 + }, + "ic": 8, + "ty": 4, + "cs": 0, + "d": "closed", + "f": "Alexanderplein (s113)", + "t": "Stadhouderskade", + "l": 390, + "r": "S100" + }, + { + "id": "europe_CLUSTER_11_691732516", + "p": { + "x": 541448.7, + "y": 6867162.1 + }, + "ic": 8, + "ty": 0, + "cbl": { + "x": 541160.1, + "y": 6866710.7 + }, + "ctr": { + "x": 541737.2, + "y": 6867613.5 + }, + "cs": 4, + "l": 430 + }, + { + "id": "europe_CLUSTER_11_1582351486", + "p": { + "x": 534709.6, + "y": 6865174.7 + }, + "ic": 8, + "ty": 0, + "cbl": { + "x": 534562.2, + "y": 6865025.3 + }, + "ctr": { + "x": 534856.9, + "y": 6865324.2 + }, + "cs": 2, + "l": 380 + }, + { + "id": "europe_CLUSTER_11_-2070222267", + "p": { + "x": 536813.1, + "y": 6868188.3 + }, + "ic": 8, + "ty": 0, + "cbl": { + "x": 536191.1, + "y": 6867699.7 + }, + "ctr": { + "x": 537435.1, + "y": 6868677 + }, + "cs": 7, + "l": 1380 + }, + { + "id": "europe_CLUSTER_11_-496866890", + "p": { + "x": 516025.5, + "y": 6871606.3 + }, + "ic": 8, + "ty": 0, + "cbl": { + "x": 514115.1, + "y": 6870216.9 + }, + "ctr": { + "x": 517935.9, + "y": 6872995.7 + }, + "cs": 7, + "l": 1510 + }, + { + "id": "europe_HD_NL_TTR115675492352160", + "p": { + "x": 517835.3, + "y": 6883216.3 + }, + "ic": 8, + "ty": 4, + "cs": 0, + "d": "closed", + "f": "Amsterdamseweg", + "t": "A22", + "l": 710 + }, + { + "id": "europe_CLUSTER_11_834920993", + "p": { + "x": 543803.8, + "y": 6875659.8 + }, + "ic": 8, + "ty": 0, + "cbl": { + "x": 543474.7, + "y": 6875602.7 + }, + "ctr": { + "x": 544133, + "y": 6875716.9 + }, + "cs": 2, + "l": 760 + } + ] + } + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/examples/GetTrafficIncidentTile.json b/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/examples/GetTrafficIncidentTile.json new file mode 100644 index 000000000000..d191b8fedcb3 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/examples/GetTrafficIncidentTile.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "png", + "style": "night", + "zoom": 10, + "x": 175, + "y": 408, + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": {} + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/examples/GetTrafficIncidentViewport.json b/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/examples/GetTrafficIncidentViewport.json new file mode 100644 index 000000000000..42994892b5dd --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/examples/GetTrafficIncidentViewport.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "boundingbox": "-939584.4813015489,-23954526.723651607,14675583.153020501,25043442.895825107", + "boundingzoom": 2, + "overviewbox": "-939584.4813018347,-23954526.723651607,14675583.153020501,25043442.8958229083", + "overviewzoom": 2, + "copyright": true, + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "viewpResp": { + "trafficState": { + "@trafficAge": 18895, + "@trafficModelId": "1504808593298" + }, + "copyrightIds": "© 2017 GeoSmart^© 2017 TomTom^© 2017 Whereis", + "@version": "1.0.51-mascoma", + "@maps": "europe,taiwan,latam,northamerica,israel,middleeast,iraq,guam,australia,newzealand,india,africa,world,southeastasia" + } + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/traffic.json b/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/traffic.json new file mode 100644 index 000000000000..5bf252cbddc8 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Traffic/preview/1.0/traffic.json @@ -0,0 +1,1154 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Traffic Service", + "version": "1.0", + "description": "Azure Maps Traffic REST APIs" + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json", + "application/xml" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "user_impersonation": "Impersonates a user's Azure Active Directory account." + } + }, + "apiKeyQuery": { + "type": "apiKey", + "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + } + }, + "security": [ + { + "azure_auth": [] + }, + { + "apiKeyQuery": [] + } + ], + "responses": { + "202": { + "description": "Request Accepted: The request has been accepted for processing. Please use the URL in the Location Header to retry or access the results.", + "headers": { + "Location": { + "type": "string", + "description": "New URL to check for the results of the long running process." + } + } + }, + "400": { + "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "401": { + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + }, + "headers": { + "WWW-Authenticate": { + "type": "string", + "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" + } + } + }, + "403": { + "description": "Permission, capacity, or authentication issues.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "404": { + "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "500": { + "description": "An error occurred while processing the request. Please try again later.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + } + }, + "parameters": { + "ClientId": { + "name": "x-ms-client-id", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "client" + }, + "SubscriptionKey": { + "name": "subscription-key", + "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API. Current version is 1.0", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "JsonFormat": { + "name": "format", + "description": "Desired format of the response. Only `json` format is supported.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "json" + ], + "x-ms-enum": { + "name": "JsonFormat", + "modelAsString": false, + "values": [ + { + "value": "json", + "description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "TextFormat": { + "name": "format", + "description": "Desired format of the response. Value can be either _json_ or _xml_.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "json", + "xml" + ], + "x-ms-enum": { + "name": "TextFormat", + "modelAsString": false, + "values": [ + { + "value": "json", + "description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)" + }, + { + "value": "xml", + "description": "[The Extensible Markup Language](https://www.w3.org/TR/xml/)" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "RasterTileFormat": { + "name": "format", + "description": "Desired format of the response. Possible value: png.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "png" + ], + "x-ms-enum": { + "name": "RasterTileFormat", + "modelAsString": false, + "values": [ + { + "value": "png", + "description": "An image in the png format. Supports zoom levels 0 through 18." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "TileFormat": { + "name": "format", + "description": "Desired format of the response. Possible values are png & pbf.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "png", + "pbf" + ], + "x-ms-enum": { + "name": "TileFormat", + "modelAsString": false, + "values": [ + { + "value": "png", + "description": "An image in the png format. Supports zoom levels 0 through 18." + }, + { + "value": "pbf", + "description": "Vector graphic in the pbf format. Supports zoom levels 0 through 22." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "RasterZoom": { + "name": "zoom", + "in": "query", + "description": "Zoom level for the desired tile. Zoom value must be in the range: 0-22 (inclusive).\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "x-ms-parameter-location": "method" + }, + "RasterVectorZoom": { + "name": "zoom", + "in": "query", + "description": "Zoom level for the desired tile. For _raster_ tiles, value must be in the range: 0-22 (inclusive). For _vector_ tiles, value must be in the range: 0-22 (inclusive).\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "x-ms-parameter-location": "method" + }, + "xTileIndex": { + "name": "x", + "x-ms-client-name": "xTileIndex", + "in": "query", + "description": "X coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1].\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "x-ms-parameter-location": "method" + }, + "yTileIndex": { + "name": "y", + "x-ms-client-name": "yTileIndex", + "in": "query", + "description": "Y coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1].\n\nPlease see [Zoom Levels and Tile Grid](https://docs.microsoft.com/en-us/azure/location-based-services/zoom-levels-and-tile-grid) for details.", + "required": true, + "type": "integer", + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/traffic/flow/tile/{format}": { + "get": { + "x-publish": true, + "description": "__Traffic Flow Tile__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\nThe Azure Flow Tile API serves 256 x 256 pixel tiles showing traffic flow. All tiles use the same grid system. Because the traffic tiles use transparent images, they can be layered on top of map tiles to create a compound display. The Flow tiles use colors to indicate either the speed of traffic on different road segments, or the difference between that speed and the free-flow speed on the road segment in question.", + "operationId": "Traffic_GetTrafficFlowTile", + "x-ms-examples": { + "GetTrafficFlowTile": { + "$ref": "./examples/GetTrafficFlowTile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TileFormat" + }, + { + "name": "style", + "in": "query", + "description": "

The style to be used to render the tile.

  • Absolute which returns colors reflecting the absolute speed measured.
  • Relative to which returns the speed relative to free-flow.
  • Relative-delay displays when relative speeds are different from the free-flow speeds.
", + "required": true, + "type": "string", + "enum": [ + "absolute", + "relative", + "relative-delay", + "reduced-sensitivity" + ], + "x-ms-enum": { + "name": "TrafficFlowTileStyle", + "modelAsString": false, + "values": [ + { + "value": "absolute", + "description": "Colors will reflect the absolute speed measured." + }, + { + "value": "relative", + "description": "Colors will reflect the speed relative to free-flow." + }, + { + "value": "relative-delay", + "description": "Displays relative colors only where they are different from the freeflow speeds." + }, + { + "value": "reduced-sensitivity", + "description": "Displays relative colors but a larger difference from freeflow is required for segments to change the color. This mode only valid when format is png." + } + ] + } + }, + { + "$ref": "#/parameters/RasterVectorZoom" + }, + { + "$ref": "#/parameters/xTileIndex" + }, + { + "$ref": "#/parameters/yTileIndex" + }, + { + "name": "thickness", + "in": "query", + "description": "The value of the width of the line representing traffic. This value is a multiplier and the accepted values range from 1 - 20. The default value is 10. This parameter is not valid when format is pbf.", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 20, + "default": 10 + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrafficFlowTileResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "produces": [ + "application/json" + ] + } + }, + "/traffic/flow/segment/{format}": { + "get": { + "x-publish": true, + "description": "__Traffic Flow Segment__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\nThis service provides information about the speeds and travel times of the road fragment closest to the given coordinates. It is designed to work alongside the Flow layer of the Render Service to support clickable flow data visualizations. With this API, the client side can connect any place in the map with flow data on the closest road and present it to the user.", + "operationId": "Traffic_GetTrafficFlowSegment", + "x-ms-examples": { + "GetTrafficFlowSegment": { + "$ref": "./examples/GetTrafficFlowSegment.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TextFormat" + }, + { + "name": "style", + "in": "query", + "description": "The style to be used to render the tile. Valid values are absolute which returns colors reflecting the absolute speed measured, relative which returns the speed relative to free-flow, Relative-delay which displays relative speeds only where they are different from the freeflow speeds", + "required": true, + "type": "string", + "enum": [ + "absolute", + "relative", + "relative-delay" + ], + "x-ms-enum": { + "name": "TrafficFlowSegmentStyle", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/RasterZoom" + }, + { + "name": "query", + "in": "query", + "description": "Coordinates of the point close to the road segment. They have to be comma-separated and calculated using EPSG4326 projection.", + "required": true, + "type": "string" + }, + { + "name": "unit", + "in": "query", + "description": "Unit of speed in KMPH or MPH", + "required": false, + "type": "string", + "default": "KMPH", + "enum": [ + "KMPH", + "MPH" + ], + "x-ms-enum": { + "name": "SpeedUnit", + "modelAsString": false, + "values": [ + { + "value": "KMPH", + "description": "Kilometers Per Hour" + }, + { + "value": "MPH", + "description": "Miles Per Hour" + } + ] + } + }, + { + "name": "thickness", + "in": "query", + "description": "The value of the width of the line representing traffic. This value is a multiplier and the accepted values range from 1 - 20. The default value is 10.", + "required": false, + "type": "integer", + "default": 10, + "minimum": 1, + "maximum": 20 + }, + { + "name": "openLr", + "in": "query", + "description": "Boolean on whether the response should include OpenLR code", + "required": false, + "type": "boolean", + "default": false + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrafficFlowSegmentResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/traffic/incident/tile/{format}": { + "get": { + "x-publish": true, + "description": "__Traffic Incident Tile__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\nThis service serves 256 x 256 pixel tiles showing traffic incidents. All tiles use the same grid system. Because the traffic tiles use transparent images, they can be layered on top of map tiles to create a compound display. Traffic tiles render graphics to indicate traffic on the roads in the specified area.", + "operationId": "Traffic_GetTrafficIncidentTile", + "x-ms-examples": { + "GetTrafficIncidentTile": { + "$ref": "./examples/GetTrafficIncidentTile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TileFormat" + }, + { + "name": "style", + "in": "query", + "description": "The style to be used to render the tile. This parameter is not valid when format is pbf.", + "required": true, + "type": "string", + "enum": [ + "s1", + "s2", + "s3", + "night" + ], + "x-ms-enum": { + "name": "TrafficIncidentTileStyle", + "modelAsString": false, + "values": [ + { + "value": "s1", + "description": "Creates traffic lines with colored chevrons indicating severity." + }, + { + "value": "s2", + "description": "Creates plain lines with certain degree of glow." + }, + { + "value": "s3", + "description": "Creates plain lines with certain degree of glow." + }, + { + "value": "night", + "description": "Night style." + } + ] + } + }, + { + "$ref": "#/parameters/RasterVectorZoom" + }, + { + "$ref": "#/parameters/xTileIndex" + }, + { + "$ref": "#/parameters/yTileIndex" + }, + { + "name": "t", + "x-ms-client-name": "trafficState", + "in": "query", + "description": "Reference value for the state of traffic at a particular time, obtained from the Viewport API call, trafficModelId attribute in trafficState field. It is updated every minute, and is valid for two minutes before it times out. Use -1 to get the most recent traffic information. Default: most recent traffic information.", + "required": false, + "type": "string", + "default": "-1" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrafficIncidentTileResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "produces": [ + "application/json" + ] + } + }, + "/traffic/incident/detail/{format}": { + "get": { + "x-publish": true, + "description": "__Traffic Incident Detail__ \n\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\nThis API provides information on traffic incidents inside a given bounding box, based on the current Traffic Model ID. The Traffic Model ID is available to grant synchronization of data between calls and API's. The Traffic Model ID is a key value for determining the currency of traffic incidents. It is updated every minute, and is valid for two minutes before it times out. It is used in rendering [incident tiles](https://docs.microsoft.com/en-us/rest/api/maps/traffic/gettrafficincidenttile). It can be obtained from the [Viewport API](https://docs.microsoft.com/en-us/rest/api/maps/traffic/gettrafficincidentviewport).", + "operationId": "Traffic_GetTrafficIncidentDetail", + "x-ms-examples": { + "GetTrafficIncidentDetail": { + "$ref": "./examples/GetTrafficIncidentDetail.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TextFormat" + }, + { + "name": "style", + "in": "query", + "description": "The style that will be used to render the tile in Traffic [Incident Tile API](https://docs.microsoft.com/en-us/rest/api/maps/traffic/gettrafficincidenttile). This will have an effect on the coordinates of traffic incidents in the reply.", + "required": true, + "type": "string", + "enum": [ + "s1", + "s2", + "s3", + "night" + ], + "x-ms-enum": { + "name": "TrafficIncidentDetailStyle", + "modelAsString": false, + "values": [ + { + "value": "s1", + "description": "Creates traffic lines with colored chevrons indicating severity." + }, + { + "value": "s2", + "description": "Creates plain lines with certain degree of glow." + }, + { + "value": "s3", + "description": "Creates plain lines with certain degree of glow." + }, + { + "value": "night", + "description": "Night style." + } + ] + } + }, + { + "name": "boundingbox", + "in": "query", + "description": "The `boundingbox` is represented by two value pairs describing it's corners (first pair for lower left corner and second for upper right). The pairs can either be specified using any of the `projection`'s specified below (e.g., _minY,minX,maxY,maxX_) or by two latitude-longitude pairs (e.g., _minLat,minLon,maxLat,maxLon_).

NOTE: If latitude/longitude pairs are used, then the `projection` parameter must be set to \"EPSG4326\".", + "required": true, + "type": "string" + }, + { + "name": "boundingZoom", + "in": "query", + "description": "Zoom level for desired tile. 0 to 22 for raster tiles, 0 through 22 for vector tiles", + "required": true, + "type": "integer", + "minimum": 0, + "maximum": 22 + }, + { + "name": "trafficmodelid", + "in": "query", + "description": "Number referencing traffic model. This can be obtained from the [Viewport API](https://docs.microsoft.com/en-us/rest/api/maps/traffic/gettrafficincidentviewport). It is updated every minute, and is valid for two minutes before it times out. If the wrong Traffic Model ID is specified, the correct one will be returned by the interface. A value of -1 will always invoke the most recent traffic model", + "required": true, + "type": "string" + }, + { + "name": "language", + "in": "query", + "description": "[ISO 639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the output language. Supported languages are ar, ca, cs, da, de, el, en, en-GB, en-US, es, et, fi, fr, he, hu, id, in*, it, lt, lv, nb, nl, no, pl, pt, ro, ru, sk, sv, th, tr, zh.\n\nPlease refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details. When invalid language code is provided response is returned in English. When incident cause or description does not have translation, English description is returned.", + "required": false, + "type": "string" + }, + { + "name": "projection", + "in": "query", + "description": "The projection used to specify the coordinates in the request and response. [EPSG900913](http://docs.openlayers.org/library/spherical_mercator.html) (default) or [EPSG4326](http://spatialreference.org/ref/epsg/4326/)", + "required": false, + "type": "string", + "enum": [ + "EPSG900913", + "EPSG4326" + ] + }, + { + "name": "geometries", + "in": "query", + "description": "The type of vector geometry added to incidents (returned in the element of the response).", + "required": false, + "type": "string", + "enum": [ + "original", + "shifted" + ], + "x-ms-enum": { + "name": "IncidentGeometryType", + "modelAsString": false, + "values": [ + { + "value": "original", + "description": "Places incidents precisely on the road." + }, + { + "value": "shifted", + "description": "Moves the incident slightly (depending on zoom level) to indicate specific road lanes." + } + ] + } + }, + { + "name": "expandCluster", + "in": "query", + "description": "Boolean to indicate whether to list all traffic incidents in a cluster separately", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "originalPosition", + "in": "query", + "description": "Boolean on whether to return the original position of the incident () as well as the one shifted to the beginning of the traffic tube ()", + "required": false, + "type": "boolean", + "default": false + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrafficIncidentDetailResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/traffic/incident/viewport/{format}": { + "get": { + "x-publish": true, + "description": "__Traffic Incident Viewport__\n\n\n**Applies to**: S0 and S1 pricing tiers.\n\nThis API returns legal and technical information for the viewport described in the request. It should be called by client applications whenever the viewport changes (for instance, through zooming, panning, going to a location, or displaying a route). The request should contain the bounding box and zoom level of the viewport whose information is needed. The return will contain map version information, as well as the current Traffic Model ID and copyright IDs. The Traffic Model ID returned by the Viewport Description is used by other APIs to retrieve last traffic information for further processing.", + "operationId": "Traffic_GetTrafficIncidentViewport", + "x-ms-examples": { + "GetTrafficIncidentViewport": { + "$ref": "./examples/GetTrafficIncidentViewport.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TextFormat" + }, + { + "name": "boundingbox", + "in": "query", + "description": "Bounding box of the map viewport in [EPSG900913](http://docs.openlayers.org/library/spherical_mercator.html) projection. The `boundingbox` is represented by two value pairs describing it's corners (first pair for lower left corner and second for upper right). All values should be separated by commas (e.g., _minY,minX,maxY,maxX_). The maximum size of the bounding box that can be passed is dependent on the requested zoom level. The width and height cannot exceed 4092 pixels when rendered on the given zoom level.

NOTE: Bounding boxes that cross the 180° meridian require special treatment. For such boxes, the eastern _maxX_ value will be negative, and thus less than the _minX_ value west of the 180° meridian. To address that, the value 40075016.6855874 should be added to the true _maxX_ value before it is passed in the request.", + "required": true, + "type": "string" + }, + { + "name": "boundingzoom", + "in": "query", + "description": "Zoom level of the map viewport. Used to determine whether the view can be zoomed in.", + "required": true, + "type": "integer", + "minimum": 0, + "maximum": 22 + }, + { + "name": "overviewbox", + "in": "query", + "description": "Bounding box of the overview map in [EPSG900913](http://docs.openlayers.org/library/spherical_mercator.html) projection.

Used in case the overview box/mini map has different copyright data than the main map. If there is no mini map, the same coordinates as `boundingBox` is used.", + "required": true, + "type": "string" + }, + { + "name": "overviewzoom", + "in": "query", + "description": "Zoom level of the overview map. If there is no mini map, use the same zoom level as boundingZoom.", + "required": true, + "type": "integer", + "minimum": 0, + "maximum": 22 + }, + { + "name": "copyright", + "in": "query", + "description": "Determines what copyright information to return. When true the copyright text is returned; when false only the copyright index is returned.", + "required": true, + "type": "boolean", + "default": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrafficIncidentViewportResult" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + } + }, + "definitions": { + "ODataErrorResponse": { + "type": "object", + "description": "This response object is returned when an error occurs in the Maps API.", + "properties": { + "error": { + "$ref": "#/definitions/ODataError" + } + } + }, + "ODataError": { + "type": "object", + "description": "This object is returned when an error occurs in the Maps API.", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The ODataError code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + } + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the target causing the error." + } + } + }, + "Coordinate": { + "description": "A location represented as a latitude and longitude.", + "type": "object", + "properties": { + "latitude": { + "description": "Latitude property", + "type": "number", + "format": "double", + "readOnly": true + }, + "longitude": { + "description": "Longitude property", + "type": "number", + "format": "double", + "readOnly": true + } + } + }, + "TrafficFlowTileResult": { + "description": "This image is returned from a successful Traffic Flow Tile call", + "type": "string", + "format": "binary", + "readOnly": true + }, + "TrafficFlowSegmentResult": { + "description": "This object is returned from a successful Traffic Flow Segment call", + "type": "object", + "properties": { + "flowSegmentData": { + "description": "Flow Segment Data property", + "type": "object", + "readOnly": true, + "properties": { + "frc": { + "description": "Functional Road Class. This indicates the road type:\n 0: Motorway, freeway or other major road.\n 1: Major road, less important than a motorway.\n 2: Other major road.\n 3: Secondary road.\n 4: Local connecting road.\n 5: Local road of high importance.\n 6: Local road.", + "type": "string", + "readOnly": true + }, + "currentSpeed": { + "description": "The current average speed at the selected point, in the units requested. This is calculated from the currentTravelTime and the length of the selected segment.", + "type": "integer", + "readOnly": true + }, + "freeFlowSpeed": { + "description": "The free flow speed expected under ideal conditions, expressed in the units requested. This is related to the freeFlowTravelTime.", + "type": "integer", + "readOnly": true + }, + "currentTravelTime": { + "description": "Current travel time in seconds based on fused real-time measurements between the defined locations in the specified direction.", + "type": "integer", + "readOnly": true + }, + "freeFlowTravelTime": { + "description": "The travel time in seconds which would be expected under ideal free flow conditions.", + "type": "integer", + "readOnly": true + }, + "confidence": { + "description": "The confidence is a measure of the quality of the provided travel time and speed. A value of 1 means full confidence, that the response contains the highest quality data. Lower values indicate the degree that the response may vary from the actual conditions on the road. Any value greater than 0.6 means the information was based on real-time probe input. A value of 0.5 means the reported speed is based on historical info. A value between 0.5 and 0.6 has a calculated weighted average between historical and live speeds.", + "type": "number", + "readOnly": true + }, + "coordinates": { + "description": "Includes the coordinates describing the shape of the segment. Coordinates are shifted from the road depending on the zoom level to support high quality visualization in every scale.", + "type": "object", + "properties": { + "coordinate": { + "description": "Coordinate array", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Coordinate" + } + } + } + }, + "@version": { + "description": "This indicates the software version that generated the response.", + "type": "string", + "readOnly": true + }, + "openlr": { + "description": "OpenLR code for segment", + "type": "number", + "readOnly": true + } + } + } + } + }, + "TrafficIncidentTileResult": { + "description": "This object is returned from a successful Traffic Incident Tile call", + "type": "object", + "properties": { + "image": { + "description": "Image property", + "type": "string", + "readOnly": true + } + } + }, + "TrafficIncidentDetailResult": { + "description": "This object is returned from a successful Traffic incident Detail call", + "type": "object", + "properties": { + "tm": { + "description": "Main response element", + "type": "object", + "readOnly": true, + "properties": { + "@id": { + "description": "ID of the traffic incident", + "type": "string", + "readOnly": true + }, + "poi": { + "description": "A single traffic incident, or a cluster of traffic incidents", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TrafficIncidentPoi" + } + } + } + } + } + }, + "TrafficIncidentPoi": { + "type": "object", + "readOnly": true, + "properties": { + "id": { + "description": "ID of the traffic incident", + "type": "string", + "readOnly": true + }, + "p": { + "description": "The point where an icon of the cluster or raw incident should be drawn, expressed in the requested projection. This is affected by traffic style, zoom level and road type", + "type": "object", + "readOnly": true, + "properties": { + "x": { + "description": "x coordinate", + "type": "number", + "readOnly": true + }, + "y": { + "description": "y coordinate", + "type": "number", + "readOnly": true + } + } + }, + "ic": { + "description": "The icon category associated with this incident. Values are numbers in the range 0-13, with the following meanings -- 0: Unknown, 1: Accident, 2: Fog, 3: Dangerous Conditions, 4: Rain, 5: Ice, 6: Jam, 7: Lane Closed, 8: Road Closed, 9: Road Works, 10: Wind, 11: Flooding, 12: Detour, 13: Cluster", + "type": "integer", + "readOnly": true + }, + "ty": { + "description": "The magnitude of delay associated with incident. These values correspond to incident colors in the traffic tiles", + "type": "integer", + "readOnly": true + }, + "cbl": { + "description": "Bottom left coordinate of the cluster in the projection of the request", + "type": "object", + "readOnly": true, + "properties": { + "x": { + "description": "x coordinate", + "type": "number", + "readOnly": true + }, + "y": { + "description": "y coordinate", + "type": "number", + "readOnly": true + } + } + }, + "ctr": { + "description": "Top right coordinate of the cluster in the projection of the request", + "type": "object", + "readOnly": true, + "properties": { + "x": { + "description": "x coordinate", + "type": "number", + "readOnly": true + }, + "y": { + "description": "y coordinate", + "type": "number", + "readOnly": true + } + } + }, + "cs": { + "description": "Cluster size: the number of incidents in the cluster", + "type": "integer", + "readOnly": true + }, + "l": { + "description": "Length of the incident in meters", + "type": "integer", + "readOnly": true + }, + "r": { + "description": "The road number(s) affected by the incident. Multiple road numbers will delimited by slashes", + "type": "string", + "readOnly": true + }, + "dl": { + "description": "Delay caused by the incident in seconds (except in road closures)", + "type": "integer", + "readOnly": true + }, + "t": { + "description": "To: the name of the intersection or location where the traffic due to the incident ends", + "type": "string", + "readOnly": true + }, + "f": { + "description": "From: the name of the intersection or location where the traffic due to the incident starts", + "type": "string", + "readOnly": true + }, + "d": { + "description": "Description of the incident in the language requested", + "type": "string", + "readOnly": true + }, + "c": { + "description": "Cause of the incident, where available, in the language requested", + "type": "string", + "readOnly": true + } + } + }, + "TrafficIncidentViewportResult": { + "description": "This object is returned from a successful Traffic Incident Viewport call", + "type": "object", + "properties": { + "viewpResp": { + "description": "Viewport Response object", + "type": "object", + "readOnly": true, + "properties": { + "trafficState": { + "description": "Traffic State array", + "type": "object", + "readOnly": true, + "properties": { + "@trafficAge": { + "description": "@Traffic Age property", + "type": "integer", + "readOnly": true + }, + "@trafficModelId": { + "description": "@Traffic Model Id property", + "type": "string", + "readOnly": true + } + } + }, + "copyrightIds": { + "description": "Copyright Ids property", + "type": "string", + "readOnly": true + }, + "@version": { + "description": "@Version property", + "type": "string", + "readOnly": true + }, + "@maps": { + "description": "@maps property", + "type": "string", + "readOnly": true + } + } + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/DeleteItem.json b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/DeleteItem.json new file mode 100644 index 000000000000..127a25dc1639 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/DeleteItem.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "1.0", + "datasetid": "018fda98-e638-0edf-5ef7-28491ff3bed4", + "subscription-key": "[subscription-key]", + "collectionId": "facility", + "featureId": "FCL39" + }, + "responses": { + "204": {}, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetCollection.json b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetCollection.json new file mode 100644 index 000000000000..583b150414ee --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetCollection.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "1.0", + "datasetid": "018fda98-e638-0edf-5ef7-28491ff3bed4", + "subscription-key": "[subscription-key]", + "collectionId": "unit" + }, + "responses": { + "200": { + "body": { + "name": "unit", + "description": "A physical and non-overlapping area which might be occupied and traversed by a navigating agent. Can be a hallway, a room, a courtyard, etc. It is surrounded by physical obstruction (wall), unless the isOpenArea attribute is equal to true, and one must add openings where the obstruction shouldn't be there. If isOpenArea attribute is equal to true, all the sides are assumed open to the surroundings and walls are to be added where needed. Walls for open areas are represented as a lineElement or areaElement with isObstruction equal to true.", + "links": [ + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/unit/definition?api-version=1.0", + "rel": "describedBy", + "title": "Metadata catalogue for unit" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/unit/items?api-version=1.0", + "rel": "data", + "title": "unit" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/unit?api-version=1.0", + "rel": "self", + "title": "Metadata catalogue for unit" + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetCollectionDefinition.json b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetCollectionDefinition.json new file mode 100644 index 000000000000..e4d17ccf6650 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetCollectionDefinition.json @@ -0,0 +1,196 @@ +{ + "parameters": { + "api-version": "1.0", + "datasetid": "018fda98-e638-0edf-5ef7-28491ff3bed4", + "subscription-key": "[subscription-key]", + "collectionId": "unit" + }, + "responses": { + "200": { + "body": { + "idPrefix": "UNIT", + "name": "unit", + "description": "A physical and non-overlapping area which might be occupied and traversed by a navigating agent. Can be a hallway, a room, a courtyard, etc. It is surrounded by physical obstruction (wall), unless the isOpenArea attribute is equal to true, and one must add openings where the obstruction shouldn't be there. If isOpenArea attribute is equal to true, all the sides are assumed open to the surroundings and walls are to be added where needed. Walls for open areas are represented as a lineElement or areaElement with isObstruction equal to true.", + "geometryType": "Polygon", + "featureTypes": [], + "properties": [ + { + "name": "externalId", + "required": false, + "type": "text" + }, + { + "name": "originalId", + "required": false, + "type": "text" + }, + { + "name": "categoryId", + "required": true, + "type": { + "featureId": "category" + } + }, + { + "name": "isOpenArea", + "required": false, + "type": "boolean" + }, + { + "name": "navigableBy", + "required": false, + "type": { + "array": { + "enum": [ + "pedestrian", + "wheelchair", + "machine", + "bicycle", + "automobile", + "hiredAuto", + "bus", + "railcar", + "emergency", + "ferry", + "boat" + ] + } + } + }, + { + "name": "isRoutable", + "required": false, + "type": "boolean" + }, + { + "name": "routeThroughBehavior", + "required": false, + "type": { + "enum": [ + "disallowed", + "allowed", + "preferred" + ] + } + }, + { + "name": "nonPublic", + "required": false, + "type": "boolean" + }, + { + "name": "levelId", + "required": true, + "type": { + "featureId": "level" + } + }, + { + "name": "occupants", + "required": false, + "type": { + "array": { + "featureId": "directoryInfo" + } + } + }, + { + "name": "addressId", + "required": false, + "type": { + "featureId": "directoryInfo" + } + }, + { + "name": "addressRoomNumber", + "required": false, + "type": "text" + }, + { + "name": "name", + "required": false, + "type": "text" + }, + { + "name": "nameSubtitle", + "required": false, + "type": "text" + }, + { + "name": "nameAlt", + "required": false, + "type": "text" + }, + { + "name": "anchorPoint", + "required": false, + "type": { + "geometry": [ + "Point" + ], + "isFragmented": false, + "srid": 4326 + } + } + ], + "links": [ + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/unit/definition?api-version=1.0", + "rel": "self", + "title": "Metadata catalogue for unit" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/unit/items?api-version=1.0", + "rel": "data", + "title": "unit" + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetCollections.json b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetCollections.json new file mode 100644 index 000000000000..7048a3299237 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetCollections.json @@ -0,0 +1,297 @@ +{ + "parameters": { + "api-version": "1.0", + "datasetid": "018fda98-e638-0edf-5ef7-28491ff3bed4", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "collections": [ + { + "name": "unit", + "description": "A physical and non-overlapping area which might be occupied and traversed by a navigating agent. Can be a hallway, a room, a courtyard, etc. It is surrounded by physical obstruction (wall), unless the isOpenArea attribute is equal to true, and one must add openings where the obstruction shouldn't be there. If isOpenArea attribute is equal to true, all the sides are assumed open to the surroundings and walls are to be added where needed. Walls for open areas are represented as a lineElement or areaElement with isObstruction equal to true.", + "links": [ + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/unit/definition?api-version=1.0", + "rel": "describedBy", + "title": "Metadata catalogue for unit" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/unit/items?api-version=1.0", + "rel": "data", + "title": "unit" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/unit?api-version=1.0", + "rel": "self", + "title": "Metadata catalogue for unit" + } + ] + }, + { + "name": "zone", + "description": "A virtual area. ex, wifi zone, emergency assembly area. Zones can be used as destinations but not meant for through traffic.", + "links": [ + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/zone/definition?api-version=1.0", + "rel": "describedBy", + "title": "Metadata catalogue for zone" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/zone/items?api-version=1.0", + "rel": "data", + "title": "zone" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/zone?api-version=1.0", + "rel": "self", + "title": "Metadata catalogue for zone" + } + ] + }, + { + "name": "level", + "description": "An indication of the extent and vertical position of a set of features.", + "links": [ + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/level/definition?api-version=1.0", + "rel": "describedBy", + "title": "Metadata catalogue for level" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/level/items?api-version=1.0", + "rel": "data", + "title": "level" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/level?api-version=1.0", + "rel": "self", + "title": "Metadata catalogue for level" + } + ] + }, + { + "name": "facility", + "description": "Area of the site, building footprint etc.", + "links": [ + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/facility/definition?api-version=1.0", + "rel": "describedBy", + "title": "Metadata catalogue for facility" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/facility/items?api-version=1.0", + "rel": "data", + "title": "facility" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/facility?api-version=1.0", + "rel": "self", + "title": "Metadata catalogue for facility" + } + ] + }, + { + "name": "verticalPenetration", + "description": "An area that, when used in a set, represents a method of navigating vertically between levels. It can be used to model stairs, elevators etc. Geometry can overlap units and other vertical penetration features.", + "links": [ + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/verticalPenetration/definition?api-version=1.0", + "rel": "describedBy", + "title": "Metadata catalogue for verticalPenetration" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/verticalPenetration/items?api-version=1.0", + "rel": "data", + "title": "verticalPenetration" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/verticalPenetration?api-version=1.0", + "rel": "self", + "title": "Metadata catalogue for verticalPenetration" + } + ] + }, + { + "name": "opening", + "description": "A usually-traversable boundary between two units, or a unit and verticalPenetration.", + "links": [ + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/opening/definition?api-version=1.0", + "rel": "describedBy", + "title": "Metadata catalogue for opening" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/opening/items?api-version=1.0", + "rel": "data", + "title": "opening" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/opening?api-version=1.0", + "rel": "self", + "title": "Metadata catalogue for opening" + } + ] + }, + { + "name": "directoryInfo", + "description": "Name, address, phone number, website, and hours of operation for a unit, facility, or an occupant of a unit or facility.", + "links": [ + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/directoryInfo/definition?api-version=1.0", + "rel": "describedBy", + "title": "Metadata catalogue for directoryInfo" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/directoryInfo/items?api-version=1.0", + "rel": "data", + "title": "directoryInfo" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/directoryInfo?api-version=1.0", + "rel": "self", + "title": "Metadata catalogue for directoryInfo" + } + ] + }, + { + "name": "pointElement", + "description": "A point feature in a unit, such as a first aid kit or a sprinkler head.", + "links": [ + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/pointElement/definition?api-version=1.0", + "rel": "describedBy", + "title": "Metadata catalogue for pointElement" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/pointElement/items?api-version=1.0", + "rel": "data", + "title": "pointElement" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/pointElement?api-version=1.0", + "rel": "self", + "title": "Metadata catalogue for pointElement" + } + ] + }, + { + "name": "lineElement", + "description": "A line feature in a unit, such as a dividing wall, window.", + "links": [ + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/lineElement/definition?api-version=1.0", + "rel": "describedBy", + "title": "Metadata catalogue for lineElement" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/lineElement/items?api-version=1.0", + "rel": "data", + "title": "lineElement" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/lineElement?api-version=1.0", + "rel": "self", + "title": "Metadata catalogue for lineElement" + } + ] + }, + { + "name": "areaElement", + "description": "A polygon feature in a unit, such as an area open to below, an obstruction like an island in a unit.", + "links": [ + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/areaElement/definition?api-version=1.0", + "rel": "describedBy", + "title": "Metadata catalogue for areaElement" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/areaElement/items?api-version=1.0", + "rel": "data", + "title": "areaElement" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/areaElement?api-version=1.0", + "rel": "self", + "title": "Metadata catalogue for areaElement" + } + ] + }, + { + "name": "category", + "description": "Category names. e.g. \"room.conference\". The isRoutable attribute puts a feature with that category on the routing graph. The routeThroughBehavior attribute determines whether a feature can be used for through traffic or not.", + "links": [ + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/category/definition?api-version=1.0", + "rel": "describedBy", + "title": "Metadata catalogue for category" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/category/items?api-version=1.0", + "rel": "data", + "title": "category" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/category?api-version=1.0", + "rel": "self", + "title": "Metadata catalogue for category" + } + ] + } + ], + "links": [ + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections?api-version=1.0", + "rel": "self" + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetConformance.json b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetConformance.json new file mode 100644 index 000000000000..2087dca71fe4 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetConformance.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "1.0", + "datasetid": "018fda98-e638-0edf-5ef7-28491ff3bed4", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "conformsTo": [ + "http://www.opengis.net/spec/wfs-1/3.0/req/core", + "http://www.opengis.net/spec/wfs-1/3.0/req/oas30", + "http://www.opengis.net/spec/wfs-1/3.0/req/geojson", + "http://tempuri.org/wfs/3.0/edit" + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetItem.json b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetItem.json new file mode 100644 index 000000000000..a83972b09aa0 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetItem.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "1.0", + "datasetid": "018fda98-e638-0edf-5ef7-28491ff3bed4", + "subscription-key": "[subscription-key]", + "collectionId": "unit", + "featureId": "UNIT39" + }, + "responses": { + "200": { + "body": { + "feature": { + "type": "feature", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 139.63304057829211, + 35.457686686108559 + ], + [ + 139.63296283234274, + 35.457783904258683 + ], + [ + 139.63308672404617, + 35.457850229062018 + ], + [ + 139.63314516916711, + 35.457777145699858 + ], + [ + 139.63312747036289, + 35.457767670747167 + ], + [ + 139.63314677109963, + 35.457743535881377 + ], + [ + 139.63304057829211, + 35.457686686108559 + ] + ] + ] + }, + "properties": { + "originalId": "ddbbb583-4621-4e11-8859-299d1057e843", + "categoryId": "CTG10", + "isOpenArea": false, + "navigableBy": [ + "pedestrian" + ], + "isRoutable": false, + "routeThroughBehavior": "allowed", + "nonPublic": false, + "levelId": "LVL18", + "occupants": [], + "addressId": "DIR16", + "addressRoomNumber": "", + "name": "21N13", + "nameSubtitle": "", + "nameAlt": "" + }, + "id": "UNIT39", + "featureType": "" + }, + "links": [ + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/unit/items/UNIT39?api-version=1.0", + "rel": "self" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/unit?api-version=1.0", + "rel": "data" + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetItems.json b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetItems.json new file mode 100644 index 000000000000..0d83c6416334 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetItems.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "api-version": "1.0", + "datasetid": "018fda98-e638-0edf-5ef7-28491ff3bed4", + "subscription-key": "[subscription-key]", + "collectionId": "unit", + "limit": 1, + "bbox": "-122, 47, -120, 46" + }, + "responses": { + "200": { + "body": { + "type": "FeatureCollection", + "features": [ + { + "type": "feature", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 139.63304057829211, + 35.457686686108559 + ], + [ + 139.63296283234274, + 35.457783904258683 + ], + [ + 139.63308672404617, + 35.457850229062018 + ], + [ + 139.63314516916711, + 35.457777145699858 + ], + [ + 139.63312747036289, + 35.457767670747167 + ], + [ + 139.63314677109963, + 35.457743535881377 + ], + [ + 139.63304057829211, + 35.457686686108559 + ] + ] + ] + }, + "properties": { + "originalId": "ddbbb583-4621-4e11-8859-299d1057e843", + "categoryId": "CTG10", + "isOpenArea": false, + "navigableBy": [ + "pedestrian" + ], + "isRoutable": false, + "routeThroughBehavior": "allowed", + "nonPublic": false, + "levelId": "LVL18", + "occupants": [], + "addressId": "DIR16", + "addressRoomNumber": "", + "name": "21N13", + "nameSubtitle": "", + "nameAlt": "" + }, + "id": "UNIT39", + "featureType": "" + } + ], + "numberReturned": 1, + "links": [ + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/unit/items?api-version=1.0&limit=1", + "rel": "self" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/unit?api-version=1.0", + "rel": "data" + }, + { + "href": "https://atlas.microsoft.com/wfs/dataset/4a25a249-8bd4-3f78-8cd8-eff11751d35b/collections/unit/items?n=PMRG4ZLYOQRDUMJMEJYHEZLWEI5C2ML5&api-version=1.0&limit=1", + "rel": "next" + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetLandingPage.json b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetLandingPage.json new file mode 100644 index 000000000000..028fa8cfe0aa --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/examples/GetLandingPage.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "1.0", + "datasetid": "018fda98-e638-0edf-5ef7-28491ff3bed4", + "subscription-key": "[subscription-key]" + }, + "responses": { + "200": { + "body": { + "links": [ + { + "href": "https://atlas.microsoft.com/wfs/datasets/018fda98-e638-0edf-5ef7-28491ff3bed4", + "rel": "self", + "title": "Azure Maps WFS" + }, + { + "href": "https://atlas.microsoft.com/wfs/datasets/018fda98-e638-0edf-5ef7-28491ff3bed4/api", + "rel": "service", + "title": "The API definition" + }, + { + "href": "https://atlas.microsoft.com/wfs/datasets/018fda98-e638-0edf-5ef7-28491ff3bed4/conformance", + "rel": "conformance", + "title": "WFS 3.0 conformance classes implemented by this server" + }, + { + "href": "https://atlas.microsoft.com/wfs/datasets/018fda98-e638-0edf-5ef7-28491ff3bed4/version", + "rel": "data", + "title": "The version information" + }, + { + "href": "https://atlas.microsoft.com/wfs/datasets/018fda98-e638-0edf-5ef7-28491ff3bed4/collections", + "rel": "data", + "title": "Metadata about the feature collections" + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/wfs.json b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/wfs.json new file mode 100644 index 000000000000..962c2490603e --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/WFS/preview/1.0/wfs.json @@ -0,0 +1,984 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Web Feature Service", + "version": "1.0", + "description": "Azure Maps Web Feature REST APIs" + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json", + "application/xml" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "user_impersonation": "Impersonates a user's Azure Active Directory account." + } + }, + "apiKeyQuery": { + "type": "apiKey", + "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + } + }, + "security": [ + { + "azure_auth": [] + }, + { + "apiKeyQuery": [] + } + ], + "responses": { + "202": { + "description": "Request Accepted: The request has been accepted for processing. Please use the URL in the Location Header to retry or access the results.", + "headers": { + "Location": { + "type": "string", + "description": "New URL to check for the results of the long running process." + } + } + }, + "400": { + "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "401": { + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + }, + "headers": { + "WWW-Authenticate": { + "type": "string", + "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" + } + } + }, + "403": { + "description": "Permission, capacity, or authentication issues.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "404": { + "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "500": { + "description": "An error occurred while processing the request. Please try again later.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + } + }, + "parameters": { + "ClientId": { + "name": "x-ms-client-id", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "client" + }, + "SubscriptionKey": { + "name": "subscription-key", + "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API. Current version is 1.0", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "Datasetid": { + "name": "datasetid", + "type": "string", + "in": "path", + "description": "The identifier for the dataset to query from.", + "required": true, + "x-ms-parameter-location": "method" + }, + "LimitWfs": { + "name": "limit", + "in": "query", + "type": "number", + "minimum": 1, + "maximum": 50, + "default": 10, + "description": "The optional limit parameter limits the number of features that are presented in the response document.\nOnly features that are on the first level of the collection in the response document are counted. Nested objects contained within the explicitly requested features shall not be counted.\n* Minimum = 1 * Maximum = 50 * Default = 10", + "x-ms-parameter-location": "method" + }, + "Filter": { + "name": "filter", + "in": "query", + "type": "string", + "description": "Filter expression to search for features with specific property values in a given collection. Only feature properties of scalar type and equals operator are supported.\nThis is a special parameter where the parameter name is the property name. The scheme for this parameter is {property name}={property value}. Unless \"filter\" is one of the property names in the collection, \"filter\" should not be used as a parameter name. To search for features with \"name\" property value \"21N13\", use \"name=21N13\".\nMultiple filters are supported and should be represented as multiple query parameters. E.g., =&= String values are case sensitive.", + "x-ms-parameter-location": "method" + }, + "Bbox": { + "name": "bbox", + "in": "query", + "type": "string", + "description": "Only features that have a geometry that intersects the supplied bounding box are selected.\n* Lower left corner, coordinate axis 1 * Lower left corner, coordinate axis 2 * Upper right corner, coordinate axis 1 * Upper right corner, coordinate axis 2\nThe coordinate reference system of the values is WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter `bbox-crs`.\nFor WGS84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge).", + "required": false, + "x-ms-parameter-location": "method" + }, + "CollectionId": { + "name": "collectionId", + "in": "path", + "type": "string", + "required": true, + "description": "Identifier (name) of a specific collection", + "x-ms-parameter-location": "method" + }, + "FeatureId": { + "name": "featureId", + "in": "path", + "type": "string", + "description": "Local identifier of a specific feature", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/wfs/datasets/{datasetid}/": { + "get": { + "x-publish": true, + "description": "Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Landing Page API provides links to the API definition, the Conformance statements and the metadata about the feature data in this dataset.", + "operationId": "WFS_GetLandingPagePreview", + "x-ms-examples": { + "GetLandingPage": { + "$ref": "./examples/GetLandingPage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/Datasetid" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/Root" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/wfs/datasets/{datasetid}/conformance": { + "get": { + "description": "Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Requirements Classes lists all requirements classes specified in the standard that the server conforms to.", + "x-publish": true, + "operationId": "WFS_GetRequirementsClassesPreview", + "x-ms-examples": { + "GetConformance": { + "$ref": "./examples/GetConformance.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/Datasetid" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/ReqClasses" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/wfs/datasets/{datasetid}/collections": { + "get": { + "description": "Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Collections Description API provides descriptions of all the collections in a given dataset.", + "operationId": "WFS_CollectionsDescriptionPreview", + "x-publish": true, + "x-ms-examples": { + "GetCollections": { + "$ref": "./examples/GetCollections.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/Datasetid" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/Content" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/wfs/datasets/{datasetid}/collections/{collectionId}": { + "get": { + "description": "Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Description API provides the description of a given collection. It includes the links to the operations that can be performed on the collection.", + "operationId": "WFS_CollectionDescriptionPreview", + "x-publish": true, + "x-ms-examples": { + "GetCollection": { + "$ref": "./examples/GetCollection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/Datasetid" + }, + { + "$ref": "#/parameters/CollectionId" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/CollectionInfo" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/wfs/datasets/{datasetid}/collections/{collectionId}/definition": { + "get": { + "description": "Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Definition API provides the detailed data model of a given collection.", + "operationId": "WFS_CollectionDefinitionPreview", + "x-publish": true, + "x-ms-examples": { + "GetCollectionDefinition": { + "$ref": "./examples/GetCollectionDefinition.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/Datasetid" + }, + { + "$ref": "#/parameters/CollectionId" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/CollectionDefinition" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/wfs/datasets/{datasetid}/collections/{collectionId}/items": { + "get": { + "description": "Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Features API returns the list of features in the given collection.", + "operationId": "WFS_GetFeaturesPreview", + "x-publish": true, + "x-ms-examples": { + "Getitems": { + "$ref": "./examples/GetItems.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/Datasetid" + }, + { + "$ref": "#/parameters/CollectionId" + }, + { + "$ref": "#/parameters/LimitWfs" + }, + { + "$ref": "#/parameters/Bbox" + }, + { + "$ref": "#/parameters/Filter" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/FeatureCollectionGeoJSON" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/wfs/datasets/{datasetid}/collections/{collectionId}/items/{featureId}": { + "get": { + "description": "Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Feature API returns the feature identified by the provided id in the given collection.", + "x-publish": true, + "operationId": "WFS_GetFeaturePreview", + "x-ms-examples": { + "GetFeature": { + "$ref": "./examples/GetItem.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/Datasetid" + }, + { + "$ref": "#/parameters/CollectionId" + }, + { + "$ref": "#/parameters/FeatureId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Feature" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + }, + "delete": { + "description": "Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/dataset/createpreview). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Delete Feature API deletes the feature identified by the provided id in the given collection. At this point this API supports only facility features. Deleting a facility feature deletes all the child features of that facility recursively.", + "x-publish": true, + "operationId": "WFS_DeleteFeaturePreview", + "x-ms-examples": { + "GetFeature": { + "$ref": "./examples/DeleteItem.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/Datasetid" + }, + { + "$ref": "#/parameters/CollectionId" + }, + { + "$ref": "#/parameters/FeatureId" + } + ], + "responses": { + "204": { + "description": "Feature Deleted." + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + } + }, + "definitions": { + "ODataErrorResponse": { + "type": "object", + "description": "This response object is returned when an error occurs in the Maps API.", + "properties": { + "error": { + "$ref": "#/definitions/ODataError" + } + } + }, + "ODataError": { + "type": "object", + "description": "This object is returned when an error occurs in the Maps API.", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The ODataError code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + } + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the target causing the error." + } + } + }, + "Exception": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "Root": { + "type": "object", + "required": [ + "links" + ], + "properties": { + "links": { + "type": "array", + "items": { + "$ref": "#/definitions/Link" + } + } + } + }, + "ReqClasses": { + "type": "object", + "required": [ + "conformsTo" + ], + "properties": { + "conformsTo": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "http://www.opengis.net/spec/wfs-1/3.0/req/core", + "http://www.opengis.net/spec/wfs-1/3.0/req/oas30", + "http://www.opengis.net/spec/wfs-1/3.0/req/html", + "http://www.opengis.net/spec/wfs-1/3.0/req/geojson" + ] + } + } + }, + "Link": { + "description": "Links to other WFS endpoints", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "type": "string" + }, + "rel": { + "type": "string", + "example": "prev" + }, + "type": { + "type": "string", + "example": "application/geo+json" + }, + "hreflang": { + "type": "string", + "example": "en" + }, + "title": { + "type": "string" + } + } + }, + "Content": { + "type": "object", + "required": [ + "links", + "collections" + ], + "properties": { + "links": { + "type": "array", + "items": { + "$ref": "#/definitions/Link" + }, + "example": [ + { + "href": "http://data.example.org/collections.json", + "rel": "self", + "type": "application/json", + "title": "this document" + }, + { + "href": "http://data.example.org/collections.html", + "rel": "alternate", + "type": "text/html", + "title": "this document as HTML" + }, + { + "href": "http://schemas.example.org/1.0/foobar.xsd", + "rel": "describedBy", + "type": "application/xml", + "title": "XML schema for Acme Corporation data" + } + ] + }, + "collections": { + "type": "array", + "items": { + "$ref": "#/definitions/CollectionInfo" + } + } + } + }, + "Version": { + "type": "object", + "required": [ + "version", + "revisionTimestamp", + "links" + ], + "properties": { + "version": { + "description": "version number of the dataset", + "type": "string", + "example": "1.0.0" + }, + "revisionTimestamp": { + "description": "timestamp of the revision", + "type": "string", + "example": "2020-01-02T03:04:05" + }, + "links": { + "type": "array", + "items": { + "$ref": "#/definitions/Link" + }, + "example": [ + { + "href": "http://data.example.org/collections.json", + "rel": "self", + "type": "application/json", + "title": "this document" + }, + { + "href": "http://data.example.org/collections.html", + "rel": "alternate", + "type": "text/html", + "title": "this document as HTML" + }, + { + "href": "http://schemas.example.org/1.0/foobar.xsd", + "rel": "describedBy", + "type": "application/xml", + "title": "XML schema for Acme Corporation data" + } + ] + } + } + }, + "CollectionInfo": { + "type": "object", + "required": [ + "name", + "links" + ], + "properties": { + "name": { + "description": "identifier of the collection used, for example, in URIs", + "type": "string", + "example": "buildings" + }, + "title": { + "description": "human readable title of the collection", + "type": "string", + "example": "Buildings" + }, + "description": { + "description": "a description of the features in the collection", + "type": "string", + "example": "Buildings in the city of Bonn." + }, + "links": { + "type": "array", + "items": { + "$ref": "#/definitions/Link" + }, + "example": [ + { + "href": "http://data.example.org/collections/buildings/items", + "rel": "item", + "type": "application/geo+json", + "title": "Buildings" + }, + { + "href": "http://example.org/concepts/building.html", + "rel": "describedBy", + "type": "text/html", + "title": "Feature catalogue for buildings" + } + ] + } + } + }, + "CollectionDefinition": { + "description": "collection of GeoJSON features", + "type": "object", + "required": [ + "idPrefix", + "name", + "geometryType", + "featureTypes" + ], + "properties": { + "description": { + "description": "describes the collection", + "type": "string" + }, + "idPrefix": { + "description": "prefix of the collection used", + "type": "string", + "example": "BLD" + }, + "name": { + "description": "identifier of the collection used, for example, in URIs", + "type": "string", + "example": "buildings" + }, + "title": { + "description": "title of collection", + "type": "string", + "example": "Feature Class buildings" + }, + "geometryType": { + "description": "type of geometry returned", + "type": "string", + "enum": [ + "Point", + "MultiPoint", + "LineString", + "MultiLineString", + "Polygon", + "MultiPolygon", + "GeometryCollection" + ] + }, + "featureTypes": { + "description": "type of features returned", + "type": "array", + "items": { + "type": "string" + } + }, + "properties": { + "description": "attributes of the collection used", + "type": "array", + "items": { + "$ref": "#/definitions/DefinitionProperties" + } + }, + "links": { + "type": "array", + "items": { + "$ref": "#/definitions/Link" + } + } + } + }, + "DefinitionProperties": { + "type": "object", + "required": [ + "name", + "required", + "type" + ], + "properties": { + "name": { + "description": "name of attribute", + "type": "string", + "example": "external_id" + }, + "required": { + "description": "is attribute required", + "type": "boolean" + }, + "type": { + "description": "type of attribute", + "type": "object" + } + } + }, + "FeatureCollectionGeoJSON": { + "type": "object", + "required": [ + "type", + "features" + ], + "properties": { + "type": { + "type": "string" + }, + "numberReturned": { + "type": "integer" + }, + "features": { + "type": "array", + "items": { + "$ref": "#/definitions/FeatureGeoJSON" + } + }, + "links": { + "type": "array", + "items": { + "$ref": "#/definitions/Link" + } + } + } + }, + "Feature": { + "type": "object", + "required": [ + "feature" + ], + "properties": { + "feature": { + "$ref": "#/definitions/FeatureGeoJSON" + }, + "links": { + "type": "array", + "items": { + "$ref": "#/definitions/Link" + } + } + } + }, + "FeatureGeoJSON": { + "description": "GeoJSON Feature", + "type": "object", + "required": [ + "type", + "geometry", + "properties" + ], + "properties": { + "type": { + "description": "feature", + "type": "string" + }, + "geometry": { + "description": "This represents the geometry for one or more geographical features (parks, state boundary etc.) and should be a `GeoJSON` compliant type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946) for details.", + "type": "object" + }, + "properties": { + "description": "Additional properties of the feature.", + "type": "object" + }, + "id": { + "description": "Identifier for the feature.", + "type": "string" + }, + "featureType": { + "description": "The type of the feature. The value depends on the data model the current feature is part of. Some data models may have an empty value.", + "type": "string" + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetCurrentConditions.json b/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetCurrentConditions.json new file mode 100644 index 000000000000..7a176b6faf64 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetCurrentConditions.json @@ -0,0 +1,224 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "query": "47.641268,-122.125679" + }, + "responses": { + "200": { + "body": { + "results": [ + { + "dateTime": "2019-11-14T15:08:00-08:00", + "phrase": "Cloudy", + "iconCode": 7, + "hasPrecipitation": false, + "isDayTime": true, + "temperature": { + "value": 13.7, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 13.6, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperatureShade": { + "value": 13.6, + "unit": "C", + "unitType": 17 + }, + "relativeHumidity": 75, + "dewPoint": { + "value": 9.2, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 315, + "localizedDescription": "NW" + }, + "speed": { + "value": 3.6, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 4.9, + "unit": "km/h", + "unitType": 7 + } + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "visibility": { + "value": 8, + "unit": "km", + "unitType": 6 + }, + "obstructionsToVisibility": "", + "cloudCover": 95, + "ceiling": { + "value": 4359, + "unit": "m", + "unitType": 5 + }, + "pressure": { + "value": 1014.9, + "unit": "mb", + "unitType": 14 + }, + "pressureTendency": { + "localizedDescription": "Steady", + "code": "S" + }, + "past24HourTemperatureDeparture": { + "value": 1.8, + "unit": "C", + "unitType": 17 + }, + "apparentTemperature": { + "value": 16.1, + "unit": "C", + "unitType": 17 + }, + "windChillTemperature": { + "value": 13.9, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 11.4, + "unit": "C", + "unitType": 17 + }, + "precipitationSummary": { + "pastHour": { + "value": 0.5, + "unit": "mm", + "unitType": 3 + }, + "past3Hours": { + "value": 0.8, + "unit": "mm", + "unitType": 3 + }, + "past6Hours": { + "value": 0.8, + "unit": "mm", + "unitType": 3 + }, + "past9Hours": { + "value": 0.8, + "unit": "mm", + "unitType": 3 + }, + "past12Hours": { + "value": 0.8, + "unit": "mm", + "unitType": 3 + }, + "past18Hours": { + "value": 0.8, + "unit": "mm", + "unitType": 3 + }, + "past24Hours": { + "value": 0.8, + "unit": "mm", + "unitType": 3 + } + }, + "temperatureSummary": { + "past6Hours": { + "minimum": { + "value": 8.3, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 13.7, + "unit": "C", + "unitType": 17 + } + }, + "past12Hours": { + "minimum": { + "value": 5.9, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 13.7, + "unit": "C", + "unitType": 17 + } + }, + "past24Hours": { + "minimum": { + "value": 5.9, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 13.7, + "unit": "C", + "unitType": 17 + } + } + } + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetDailyForecast.json b/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetDailyForecast.json new file mode 100644 index 000000000000..01c9363275db --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetDailyForecast.json @@ -0,0 +1,284 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "query": "62.6490341,30.0734812", + "duration": 5 + }, + "responses": { + "200": { + "body": { + "summary": { + "startDate": "2019-11-17T09:00:00-08:00", + "endDate": "2019-11-17T15:00:00-08:00", + "severity": 5, + "phrase": "Rain Sunday evening", + "category": "rain" + }, + "forecasts": [ + { + "date": "2019-11-13T21:00:00-08:00", + "temperature": { + "minimum": { + "value": 0.8, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 5.3, + "unit": "C", + "unitType": 17 + } + }, + "realFeelTemperature": { + "minimum": { + "value": -3.4, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 1.3, + "unit": "C", + "unitType": 17 + } + }, + "realFeelTemperatureShade": { + "minimum": { + "value": -3.4, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 1.6, + "unit": "C", + "unitType": 17 + } + }, + "hoursOfSun": 1.1, + "degreeDaySummary": { + "heating": { + "value": 15, + "unit": "C", + "unitType": 17 + }, + "cooling": { + "value": 0, + "unit": "C", + "unitType": 17 + } + }, + "airAndPollen": [ + { + "name": "AirQuality", + "value": 0, + "category": "Good", + "categoryValue": 1, + "type": "Ozone" + }, + { + "name": "Grass", + "value": 0, + "category": "Low", + "categoryValue": 1 + }, + { + "name": "Mold", + "value": 0, + "category": "Low", + "categoryValue": 1 + }, + { + "name": "Ragweed", + "value": 0, + "category": "Low", + "categoryValue": 1 + }, + { + "name": "Tree", + "value": 0, + "category": "Low", + "categoryValue": 1 + }, + { + "name": "UVIndex", + "value": 0, + "category": "Low", + "categoryValue": 1 + } + ], + "day": { + "iconCode": 12, + "iconPhrase": "Showers", + "hasPrecipitation": true, + "precipitationType": "Rain", + "precipitationIntensity": "Light", + "shortPhrase": "Cloudy with a few showers", + "longPhrase": "Cloudy with a couple of showers, mainly later", + "precipitationProbability": 75, + "thunderstormProbability": 20, + "rainProbability": 75, + "snowProbability": 40, + "iceProbability": 0, + "wind": { + "direction": { + "degrees": 160, + "localizedDescription": "SSE" + }, + "speed": { + "value": 16.7, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "direction": { + "degrees": 160, + "localizedDescription": "SSE" + }, + "speed": { + "value": 48.2, + "unit": "km/h", + "unitType": 7 + } + }, + "totalLiquid": { + "value": 6.1, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 6.1, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "hoursOfPrecipitation": 3.5, + "hoursOfRain": 3.5, + "hoursOfSnow": 0, + "hoursOfIce": 0, + "cloudCover": 100 + }, + "night": { + "iconCode": 12, + "iconPhrase": "Showers", + "hasPrecipitation": true, + "precipitationType": "Rain", + "precipitationIntensity": "Light", + "shortPhrase": "Breezy early; cloudy", + "longPhrase": "Breezy this evening; otherwise, low clouds", + "precipitationProbability": 65, + "thunderstormProbability": 0, + "rainProbability": 64, + "snowProbability": 40, + "iceProbability": 0, + "wind": { + "direction": { + "degrees": 181, + "localizedDescription": "S" + }, + "speed": { + "value": 20.4, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "direction": { + "degrees": 170, + "localizedDescription": "S" + }, + "speed": { + "value": 42.6, + "unit": "km/h", + "unitType": 7 + } + }, + "totalLiquid": { + "value": 4, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 4, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "hoursOfPrecipitation": 2.5, + "hoursOfRain": 2.5, + "hoursOfSnow": 0, + "hoursOfIce": 0, + "cloudCover": 98 + }, + "sources": [ + "AccuWeather" + ] + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetDailyIndices.json b/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetDailyIndices.json new file mode 100644 index 000000000000..660e58e670ca --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetDailyIndices.json @@ -0,0 +1,251 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "query": "43.84745,-79.37849", + "indexGroupId": 11 + }, + "responses": { + "200": { + "body": { + "results": [ + { + "indexName": "Running Forecast", + "indexId": 1, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.2, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "This is an excellent day for outdoor running!" + }, + { + "indexName": "Jogging Forecast", + "indexId": 2, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.4, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "Conditions are excellent for jogging outdoors!" + }, + { + "indexName": "Hiking Forecast", + "indexId": 3, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.8, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "Conditions are excellent for hiking!" + }, + { + "indexName": "Bicycling Forecast", + "indexId": 4, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.9, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "Conditions are excellent for bicycling outdoors!" + }, + { + "indexName": "Golf Weather Forecast", + "indexId": 5, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 10.0, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "This is a great day for golf." + }, + { + "indexName": "Tennis Forecast", + "indexId": 6, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.2, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "This is an excellent day for playing tennis!" + }, + { + "indexName": "Skateboarding Forecast", + "indexId": 7, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.9, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "This is an excellent day for skateboarding!" + }, + { + "indexName": "Outdoor Concert Forecast", + "indexId": 8, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.7, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "Conditions are excellent for attending an outdoor concert!" + }, + { + "indexName": "Kite Flying Forecast", + "indexId": 9, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 8.5, + "category": "Very Good", + "categoryValue": 4, + "ascending": true, + "description": "Conditions are very good today for kite-flying." + }, + { + "indexName": "Beach & Pool Forecast", + "indexId": 10, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 8.6, + "category": "Very Good", + "categoryValue": 4, + "ascending": true, + "description": "Conditons will be very good for a visit to the beach or pool." + }, + { + "indexName": "Sailing Forecast", + "indexId": 11, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 8.3, + "category": "Very Good", + "categoryValue": 4, + "ascending": true, + "description": "Conditions will be very good for sailing." + }, + { + "indexName": "Stargazing Forecast", + "indexId": 12, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.5, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "This is a great night to be stargazing!" + }, + { + "indexName": "Fishing Forecast", + "indexId": 13, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 3.5, + "category": "Fair", + "categoryValue": 2, + "ascending": true, + "description": "Expect only fair conditions for fishing." + }, + { + "indexName": "Ski Weather Forecast", + "indexId": 15, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 0.0, + "category": "Poor", + "categoryValue": 1, + "ascending": true, + "description": "Expect poor conditions for skiing." + }, + { + "indexName": "Mosquito Activity Forecast", + "indexId": 17, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 7.0, + "category": "Very High", + "categoryValue": 4, + "ascending": true, + "description": "The weather is favorable for a very high level of mosquito activity. Plan activities and insect repellents accordingly." + }, + { + "indexName": "Hunting Forecast", + "indexId": 20, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 4.5, + "category": "Fair", + "categoryValue": 2, + "ascending": true, + "description": "Expect only fair conditions for hunting." + }, + { + "indexName": "Outdoor Barbecue", + "indexId": 24, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.8, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "This is a great day for an outdoor barbecue!" + }, + { + "indexName": "Lawn Mowing Forecast", + "indexId": 28, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 9.6, + "category": "Excellent", + "categoryValue": 5, + "ascending": true, + "description": "This is a great day for lawn mowing!" + }, + { + "indexName": "Outdoor Activity Forecast", + "indexId": 29, + "dateTime": "2020-07-14T07:00:00-04:00", + "value": 8.7, + "category": "Very Good", + "categoryValue": 4, + "ascending": true, + "description": "Conditions will be very good for outdoor activities." + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetHourlyForecast.json b/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetHourlyForecast.json new file mode 100644 index 000000000000..f3ea02454b5d --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetHourlyForecast.json @@ -0,0 +1,1057 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "query": "47.632346,-122.138874", + "duration": 12 + }, + "responses": { + "200": { + "body": { + "forecasts": [ + { + "date": "2019-11-14T16:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": true, + "temperature": { + "value": 13.4, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 14.1, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 10.9, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 8.4, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 311, + "localizedDescription": "NW" + }, + "speed": { + "value": 3.7, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 5.6, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 72, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 100, + "ceiling": { + "value": 3901, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 39, + "rainProbability": 39, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T17:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 12.5, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 12.8, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 10.2, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 7.8, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 281, + "localizedDescription": "W" + }, + "speed": { + "value": 5.6, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 7.4, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 73, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 94, + "ceiling": { + "value": 4054, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 34, + "rainProbability": 34, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T18:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 11.3, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 11.3, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 9.5, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 7.4, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 206, + "localizedDescription": "SSW" + }, + "speed": { + "value": 7.4, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 77, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 94, + "ceiling": { + "value": 4176, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 29, + "rainProbability": 29, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T19:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 10.4, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 9.8, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.8, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 7, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 169, + "localizedDescription": "S" + }, + "speed": { + "value": 7.4, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 11.1, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 79, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 93, + "ceiling": { + "value": 4542, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 20, + "rainProbability": 20, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T20:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 10.1, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 9.2, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.6, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 6.9, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 170, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 11.1, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 80, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 92, + "ceiling": { + "value": 4389, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 20, + "rainProbability": 20, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T21:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 10.1, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 9, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.8, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 7.1, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 170, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 82, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 91, + "ceiling": { + "value": 4481, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 20, + "rainProbability": 20, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T22:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 9.8, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 8.5, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.6, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 7.2, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 174, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 84, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 92, + "ceiling": { + "value": 4481, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 20, + "rainProbability": 20, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T23:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 9.8, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 8.5, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.5, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 7, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 175, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 82, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 94, + "ceiling": { + "value": 3688, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 20, + "rainProbability": 20, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-15T00:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 10.1, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 8.8, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.6, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 6.9, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 176, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 81, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 97, + "ceiling": { + "value": 2926, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 20, + "rainProbability": 20, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-15T01:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 9.9, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 8.5, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.5, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 6.8, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 177, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 81, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 99, + "ceiling": { + "value": 2164, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 21, + "rainProbability": 21, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-15T02:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 9.8, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 8.5, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.4, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 6.8, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 172, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 82, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 100, + "ceiling": { + "value": 1737, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 21, + "rainProbability": 21, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-15T03:00:00-08:00", + "iconCode": 7, + "iconPhrase": "Cloudy", + "hasPrecipitation": false, + "isDaylight": false, + "temperature": { + "value": 9.7, + "unit": "C", + "unitType": 17 + }, + "realFeelTemperature": { + "value": 8.6, + "unit": "C", + "unitType": 17 + }, + "wetBulbTemperature": { + "value": 8.4, + "unit": "C", + "unitType": 17 + }, + "dewPoint": { + "value": 6.9, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 161, + "localizedDescription": "SSE" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "relativeHumidity": 83, + "visibility": { + "value": 16.1, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 100, + "ceiling": { + "value": 1311, + "unit": "m", + "unitType": 5 + }, + "uvIndex": 0, + "uvIndexPhrase": "Low", + "precipitationProbability": 26, + "rainProbability": 26, + "snowProbability": 0, + "iceProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetMinuteForecast.json b/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetMinuteForecast.json new file mode 100644 index 000000000000..d122f2685328 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetMinuteForecast.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "query": "47.632346,-122.138874", + "interval": 15 + }, + "responses": { + "200": { + "body": { + "summary": { + "briefPhrase60": "Rain ending in 25 min", + "shortPhrase": "Rain ending in 25 min", + "briefPhrase": "Rain ending in 25 min", + "longPhrase": "Rain ending in 25 min", + "iconCode": 12 + }, + "intervalSummaries": [ + { + "startMinute": 0, + "endMinute": 24, + "totalMinutes": 25, + "shortPhrase": "Rain ending in %minute_value min", + "briefPhrase": "Rain ending in %minute_value min", + "longPhrase": "Rain ending in %minute_value min", + "iconCode": 12 + }, + { + "startMinute": 25, + "endMinute": 119, + "totalMinutes": 95, + "shortPhrase": "No precip for %MINUTE_VALUE min", + "briefPhrase": "No precipitation for at least %MINUTE_VALUE min", + "longPhrase": "No precipitation for at least %MINUTE_VALUE min", + "iconCode": 7 + } + ], + "intervals": [ + { + "startTime": "2019-11-14T15:18:00-08:00", + "minute": 0, + "dbz": 23, + "shortPhrase": "Light Rain", + "threshold": "LIGHT", + "color": { + "red": 8, + "green": 98, + "blue": 2, + "hex": "#086202" + }, + "simplifiedColor": { + "red": 35, + "green": 190, + "blue": 39, + "hex": "#23BE27" + }, + "precipitationType": "rain", + "iconCode": 12, + "cloudCover": 100 + }, + { + "startTime": "2019-11-14T15:33:00-08:00", + "minute": 15, + "dbz": 18, + "shortPhrase": "Light Rain", + "threshold": "LIGHT", + "color": { + "red": 32, + "green": 133, + "blue": 9, + "hex": "#208509" + }, + "simplifiedColor": { + "red": 35, + "green": 190, + "blue": 39, + "hex": "#23BE27" + }, + "precipitationType": "rain", + "iconCode": 12, + "cloudCover": 100 + }, + { + "startTime": "2019-11-14T15:48:00-08:00", + "minute": 30, + "dbz": 0, + "shortPhrase": "No Precipitation", + "iconCode": 7, + "cloudCover": 100 + }, + { + "startTime": "2019-11-14T16:03:00-08:00", + "minute": 45, + "dbz": 0, + "shortPhrase": "No Precipitation", + "iconCode": 7, + "cloudCover": 100 + }, + { + "startTime": "2019-11-14T16:18:00-08:00", + "minute": 60, + "dbz": 0, + "shortPhrase": "No Precipitation", + "iconCode": 7, + "cloudCover": 100 + }, + { + "startTime": "2019-11-14T16:33:00-08:00", + "minute": 75, + "dbz": 0, + "shortPhrase": "No Precipitation", + "iconCode": 7, + "cloudCover": 100 + }, + { + "startTime": "2019-11-14T16:48:00-08:00", + "minute": 90, + "dbz": 0, + "shortPhrase": "No Precipitation", + "iconCode": 7, + "cloudCover": 100 + }, + { + "startTime": "2019-11-14T17:03:00-08:00", + "minute": 105, + "dbz": 0, + "shortPhrase": "No Precipitation", + "iconCode": 7, + "cloudCover": 100 + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetQuarterDayForecast.json b/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetQuarterDayForecast.json new file mode 100644 index 000000000000..add8661be976 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetQuarterDayForecast.json @@ -0,0 +1,423 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "query": "47.632346,-122.138874", + "duration": 1 + }, + "responses": { + "200": { + "body": { + "forecasts": [ + { + "date": "2019-11-14T00:00:00", + "effectiveDate": "2019-11-14T07:00:00-08:00", + "quarter": 0, + "iconCode": 12, + "iconPhrase": "Showers", + "phrase": "Mostly cloudy with a shower in spots", + "temperature": { + "minimum": { + "value": 6.9, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 11.1, + "unit": "C", + "unitType": 17 + } + }, + "realFeelTemperature": { + "minimum": { + "value": 7.9, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 11.2, + "unit": "C", + "unitType": 17 + } + }, + "dewPoint": { + "value": 7.5, + "unit": "C", + "unitType": 17 + }, + "relativeHumidity": 90, + "wind": { + "direction": { + "degrees": 206, + "localizedDescription": "SSW" + }, + "speed": { + "value": 3.7, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "direction": { + "degrees": 192, + "localizedDescription": "SSW" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "visibility": { + "value": 2, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 99, + "hasPrecipitation": true, + "precipitationType": "Rain", + "precipitationIntensity": "Light", + "precipitationProbability": 55, + "thunderstormProbability": 20, + "totalLiquid": { + "value": 0.6, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0.6, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T00:00:00", + "effectiveDate": "2019-11-14T13:00:00-08:00", + "quarter": 1, + "iconCode": 12, + "iconPhrase": "Showers", + "phrase": "Mostly cloudy with a shower in spots", + "temperature": { + "minimum": { + "value": 11.3, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 13.7, + "unit": "C", + "unitType": 17 + } + }, + "realFeelTemperature": { + "minimum": { + "value": 11.3, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 14.7, + "unit": "C", + "unitType": 17 + } + }, + "dewPoint": { + "value": 8.4, + "unit": "C", + "unitType": 17 + }, + "relativeHumidity": 76, + "wind": { + "direction": { + "degrees": 296, + "localizedDescription": "WNW" + }, + "speed": { + "value": 3.7, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "direction": { + "degrees": 206, + "localizedDescription": "SSW" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "visibility": { + "value": 8, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 96, + "hasPrecipitation": true, + "precipitationType": "Rain", + "precipitationIntensity": "Light", + "precipitationProbability": 50, + "thunderstormProbability": 20, + "totalLiquid": { + "value": 0.3, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0.3, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T00:00:00", + "effectiveDate": "2019-11-14T19:00:00-08:00", + "quarter": 2, + "iconCode": 7, + "iconPhrase": "Cloudy", + "phrase": "Cloudy", + "temperature": { + "minimum": { + "value": 9.8, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 10.4, + "unit": "C", + "unitType": 17 + } + }, + "realFeelTemperature": { + "minimum": { + "value": 8.5, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 9.8, + "unit": "C", + "unitType": 17 + } + }, + "dewPoint": { + "value": 7, + "unit": "C", + "unitType": 17 + }, + "relativeHumidity": 81, + "wind": { + "direction": { + "degrees": 172, + "localizedDescription": "S" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "direction": { + "degrees": 174, + "localizedDescription": "S" + }, + "speed": { + "value": 13, + "unit": "km/h", + "unitType": 7 + } + }, + "visibility": { + "value": 10, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 93, + "hasPrecipitation": false, + "precipitationProbability": 25, + "thunderstormProbability": 0, + "totalLiquid": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 0, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + }, + { + "date": "2019-11-14T00:00:00", + "effectiveDate": "2019-11-15T01:00:00-08:00", + "quarter": 3, + "iconCode": 12, + "iconPhrase": "Showers", + "phrase": "Cloudy with a little rain", + "temperature": { + "minimum": { + "value": 8.9, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 9.9, + "unit": "C", + "unitType": 17 + } + }, + "realFeelTemperature": { + "minimum": { + "value": 6.2, + "unit": "C", + "unitType": 17 + }, + "maximum": { + "value": 8.6, + "unit": "C", + "unitType": 17 + } + }, + "dewPoint": { + "value": 6.9, + "unit": "C", + "unitType": 17 + }, + "relativeHumidity": 84, + "wind": { + "direction": { + "degrees": 164, + "localizedDescription": "SSE" + }, + "speed": { + "value": 9.3, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "direction": { + "degrees": 165, + "localizedDescription": "SSE" + }, + "speed": { + "value": 14.8, + "unit": "km/h", + "unitType": 7 + } + }, + "visibility": { + "value": 9, + "unit": "km", + "unitType": 6 + }, + "cloudCover": 99, + "hasPrecipitation": true, + "precipitationType": "Rain", + "precipitationIntensity": "Light", + "precipitationProbability": 59, + "thunderstormProbability": 0, + "totalLiquid": { + "value": 1.4, + "unit": "mm", + "unitType": 3 + }, + "rain": { + "value": 1.4, + "unit": "mm", + "unitType": 3 + }, + "snow": { + "value": 0, + "unit": "cm", + "unitType": 4 + }, + "ice": { + "value": 0, + "unit": "mm", + "unitType": 3 + } + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetSevereWeatherAlerts.json b/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetSevereWeatherAlerts.json new file mode 100644 index 000000000000..3974b02f3a3a --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetSevereWeatherAlerts.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "query": "48.057,-81.091" + }, + "responses": { + "200": { + "body": { + "results": [ + { + "countryCode": "CA", + "alertId": 242621, + "description": { + "localized": "Heat Warning", + "english": "Heat Warning" + }, + "category": "NON-PRECIPITATION", + "priority": 31, + "source": "Environment Canada", + "sourceId": 3, + "alertAreas": [ + { + "name": "Kirkland Lake - Englehart", + "summary": "Heat Warning in effect until Thursday, 3:16 AM EDT. Source: Environment Canada", + "startTime": "2020-06-29T19:44:00+00:00", + "endTime": "2020-07-02T07:16:03+00:00", + "latestStatus": { + "localized": "Continue", + "english": "Continue" + }, + "alertDetails": "\nA heat event continues through Thursday.\n\nDaytime high temperatures in the low thirties with overnight lows near 18 degrees Celsius are expected to continue until Thursday. Humidex values are expected to reach between 36 and 40 today. Cooler air will move into the region Thursday night. \n\nPlease refer to your public forecast for further details on expected temperatures.\n\nHot and humid air can also bring deteriorating air quality and can result in the air quality health index to approach the high risk category.\n\n###\n\nExtreme heat affects everyone.\n\nThe risks are greater for young children, pregnant women, older adults, people with chronic illnesses and people working or exercising outdoors.\n\nWatch for the effects of heat illness: swelling, rash, cramps, fainting, heat exhaustion, heat stroke and the worsening of some health conditions.\n\nPlease continue to monitor alerts and forecasts issued by Environment Canada. To report severe weather, send an email to ONstorm@canada.ca or tweet reports using #ONStorm.\n", + "alertDetailsLanguageCode": "en-CA" + } + ] + }, + { + "countryCode": "CA", + "alertId": 242633, + "description": { + "localized": "Heat Warning", + "english": "Heat Warning" + }, + "category": "NON-PRECIPITATION", + "priority": 31, + "source": "Environment Canada", + "sourceId": 3, + "alertAreas": [ + { + "name": "Kirkland Lake - Englehart", + "summary": "Heat Warning in effect until 9:25 PM EDT. Source: Environment Canada", + "startTime": "2020-07-01T09:25:59+00:00", + "endTime": "2020-07-02T01:25:59+00:00", + "latestStatus": { + "localized": "New", + "english": "New" + }, + "alertDetails": "\nA heat event is expected through Thursday. \n\nDaytime high temperatures in the low thirties on Wednesday and Thursday with overnight lows near 18 degrees Celsius are expected. This heat event may be extended into the weekend with daytime high temperatures near 30 degrees Celsius. \n\nPlease refer to your public forecast for further details on expected temperatures. \n\nHot and humid air can also bring deteriorating air quality and can result in the Air Quality Health Index to approach the high risk category.\n\n###\n\nExtreme heat affects everyone.\n\nThe risks are greater for young children, pregnant women, older adults, people with chronic illnesses and people working or exercising outdoors.\n\nPlease continue to monitor alerts and forecasts issued by Environment Canada. To report severe weather, send an email to ONstorm@canada.ca or tweet reports using #ONStorm.\n", + "alertDetailsLanguageCode": "en-CA" + } + ] + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetWeatherAlongRoute.json b/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetWeatherAlongRoute.json new file mode 100644 index 000000000000..8e2d64d78d09 --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/examples/GetWeatherAlongRoute.json @@ -0,0 +1,353 @@ +{ + "parameters": { + "api-version": "1.0", + "format": "json", + "query": "38.907,-77.037,0:38.907,-77.009,10:38.926,-76.928,20:39.033,-76.852,30:39.168,-76.732,40:39.269,-76.634,50:39.287,-76.612,60" + }, + "responses": { + "200": { + "body": { + "summary": { + "iconCode": 35, + "hazards": { + "maxHazardIndex": 0 + } + }, + "waypoints": [ + { + "iconCode": 38, + "shortPhrase": "Mostly cloudy", + "isDayTime": false, + "cloudCover": 70, + "temperature": { + "value": 3.4, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 142 + }, + "speed": { + "value": 2, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 3, + "unit": "km/h", + "unitType": 7 + } + }, + "precipitation": { + "dbz": 0, + "type": "SNOW" + }, + "lightningCount": 0, + "sunGlare": { + "calculatedVehicleHeading": 90, + "glareIndex": 0 + }, + "hazards": { + "maxHazardIndex": 0 + }, + "notifications": [] + }, + { + "iconCode": 38, + "shortPhrase": "Mostly cloudy", + "isDayTime": false, + "cloudCover": 65, + "temperature": { + "value": 3.4, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 166 + }, + "speed": { + "value": 1, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 2, + "unit": "km/h", + "unitType": 7 + } + }, + "precipitation": { + "dbz": 0, + "type": "SNOW" + }, + "lightningCount": 0, + "sunGlare": { + "calculatedVehicleHeading": 77, + "glareIndex": 0 + }, + "hazards": { + "maxHazardIndex": 0 + }, + "notifications": [] + }, + { + "iconCode": 35, + "shortPhrase": "Partly cloudy", + "isDayTime": false, + "cloudCover": 43, + "temperature": { + "value": 3.2, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 163 + }, + "speed": { + "value": 2, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 2, + "unit": "km/h", + "unitType": 7 + } + }, + "precipitation": { + "dbz": 0, + "type": "SNOW" + }, + "lightningCount": 0, + "sunGlare": { + "calculatedVehicleHeading": 44, + "glareIndex": 0 + }, + "hazards": { + "maxHazardIndex": 0 + }, + "notifications": [] + }, + { + "iconCode": 35, + "shortPhrase": "Partly cloudy", + "isDayTime": false, + "cloudCover": 34, + "temperature": { + "value": 1.6, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 189 + }, + "speed": { + "value": 2, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 4, + "unit": "km/h", + "unitType": 7 + } + }, + "precipitation": { + "dbz": 0, + "type": "SNOW" + }, + "lightningCount": 0, + "sunGlare": { + "calculatedVehicleHeading": 32, + "glareIndex": 0 + }, + "hazards": { + "maxHazardIndex": 0 + }, + "notifications": [] + }, + { + "iconCode": 38, + "shortPhrase": "Mostly cloudy", + "isDayTime": false, + "cloudCover": 54, + "temperature": { + "value": 0.5, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 202 + }, + "speed": { + "value": 4, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 5, + "unit": "km/h", + "unitType": 7 + } + }, + "precipitation": { + "dbz": 0, + "type": "SNOW" + }, + "lightningCount": 0, + "sunGlare": { + "calculatedVehicleHeading": 36, + "glareIndex": 0 + }, + "hazards": { + "maxHazardIndex": 0 + }, + "notifications": [] + }, + { + "iconCode": 35, + "shortPhrase": "Partly cloudy", + "isDayTime": false, + "cloudCover": 46, + "temperature": { + "value": 2.4, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 222 + }, + "speed": { + "value": 4, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 5, + "unit": "km/h", + "unitType": 7 + } + }, + "precipitation": { + "dbz": 0, + "type": "SNOW" + }, + "lightningCount": 0, + "sunGlare": { + "calculatedVehicleHeading": 38, + "glareIndex": 0 + }, + "hazards": { + "maxHazardIndex": 0 + }, + "notifications": [] + }, + { + "iconCode": 35, + "shortPhrase": "Partly cloudy", + "isDayTime": false, + "cloudCover": 39, + "temperature": { + "value": 2.3, + "unit": "C", + "unitType": 17 + }, + "wind": { + "direction": { + "degrees": 231 + }, + "speed": { + "value": 4, + "unit": "km/h", + "unitType": 7 + } + }, + "windGust": { + "speed": { + "value": 5, + "unit": "km/h", + "unitType": 7 + } + }, + "precipitation": { + "dbz": 0, + "type": "SNOW" + }, + "lightningCount": 0, + "sunGlare": { + "calculatedVehicleHeading": 43, + "glareIndex": 0 + }, + "hazards": { + "maxHazardIndex": 0 + }, + "notifications": [] + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "400 BadRequest", + "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." + } + } + }, + "401": { + "headers": {}, + "body": { + "error": { + "code": "401 Unauthorized", + "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "403": { + "headers": {}, + "body": { + "error": { + "code": "403 Forbidden", + "message": "Permission, capacity, or authentication issues." + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "404 NotFound", + "message": "Not Found: the requested resource could not be found, but it may be available again in the future." + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "500 InternalServerError", + "message": "An error occurred while processing the request. Please try again later." + } + } + } + } +} diff --git a/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/weather.json b/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/weather.json new file mode 100644 index 000000000000..4cf5e087e01c --- /dev/null +++ b/specification/maps/data-plane/Microsoft.Maps/Weather/preview/1.0/weather.json @@ -0,0 +1,2397 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Weather Service", + "version": "1.0" + }, + "host": "atlas.microsoft.com", + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure Role Based Access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Note\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* The Azure role based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.\n* Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "scopes": { + "user_impersonation": "Impersonates a user's Azure Active Directory account." + } + }, + "apiKeyQuery": { + "type": "apiKey", + "description": "This is a shared key which is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + } + }, + "security": [ + { + "azure_auth": [] + }, + { + "apiKeyQuery": [] + } + ], + "responses": { + "400": { + "description": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "401": { + "description": "Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided AAD bearer token.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + }, + "headers": { + "WWW-Authenticate": { + "type": "string", + "description": "Bearer realm=\"https://atlas.microsoft.com/\", error=\"invalid_token\", error_description=\"The access token expired\"" + } + } + }, + "403": { + "description": "Permission, capacity, or authentication issues.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "404": { + "description": "Not Found: the requested resource could not be found, but it may be available again in the future.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + }, + "500": { + "description": "An error occurred while processing the request. Please try again later.", + "schema": { + "$ref": "#/definitions/ODataErrorResponse" + } + } + }, + "parameters": { + "ClientId": { + "name": "x-ms-client-id", + "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.", + "type": "string", + "in": "header", + "required": false, + "x-ms-parameter-location": "client" + }, + "SubscriptionKey": { + "name": "subscription-key", + "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "client" + }, + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API. Current version is 1.0", + "type": "string", + "in": "query", + "required": true, + "default": "1.0", + "x-ms-parameter-location": "client" + }, + "JsonFormat": { + "name": "format", + "description": "Desired format of the response. Only `json` format is supported.", + "type": "string", + "in": "path", + "required": true, + "enum": [ + "json" + ], + "x-ms-enum": { + "name": "JsonFormat", + "modelAsString": false, + "values": [ + { + "value": "json", + "description": "[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "WeatherLanguage": { + "name": "language", + "description": "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Default value is en-us. \n\nPlease refer to [Supported languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + }, + "WeatherUnit": { + "name": "unit", + "description": "Specifies to return the data in either metric units or imperial units. Default value is metric.", + "default": "metric", + "in": "query", + "type": "string", + "required": false, + "enum": [ + "metric", + "imperial" + ], + "x-ms-enum": { + "name": "Unit", + "modelAsString": false, + "values": [ + { + "value": "metric", + "description": "Return data in metric units. Some example units of metric system are Celsius and kilometer." + }, + { + "value": "imperial", + "description": "Return data in imperial units. Some example units of imperial system are Fahrenheit and mile." + } + ] + }, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/weather/forecast/hourly/{format}": { + "get": { + "x-publish": true, + "description": "**Get Hourly Forecast**\n\n**Applies to**: S0 and S1 pricing tiers.\n\n\nRequest detailed weather forecast by the hour for the next 1, 12, 24 (1 day), 72 (3 days), 120 (5 days), and 240 hours (10 days) for the given the given coordinate location. The API returns details such as temperature, humidity, wind, precipitation, and ultraviolet (UV) index.\n\nIn S0 you can request hourly forecast for the next 1, 12, 24 hours (1 day), and 72 hours (3 days). In S1 you can also request hourly forecast for the next 120 (5 days) and 240 hours (10 days).", + "operationId": "Weather_GetHourlyForecastPreview", + "x-ms-examples": { + "HourlyForecast": { + "$ref": "./examples/GetHourlyForecast.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "query", + "description": "Coordinates of the location for which hourly forecast information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "in": "query", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/WeatherUnit" + }, + { + "name": "duration", + "description": "Time frame of the returned weather forecast. By default, the forecast data for next hour will be returned. Available values are\n * `1` - Return forecast data for the next hour. Default value.\n * `12` - Return hourly forecast for next 12 hours.\n * `24` - Return hourly forecast for next 24 hours.\n * `72` - Return hourly forecast for next 72 hours (3 days).\n * `120` - Return hourly forecast for next 120 hours (5 days). Only available in S1 SKU. \n * `240` - Return hourly forecast for next 240 hours (10 days). Only available in S1 SKU.", + "default": 1, + "in": "query", + "type": "integer" + }, + { + "$ref": "#/parameters/WeatherLanguage" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HourlyForecastResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/weather/forecast/minute/{format}": { + "get": { + "x-publish": true, + "description": "**Get Minute Forecast**\n \n \n**Applies to**: S1 pricing tier.\n\n\nGet Minute Forecast service returns minute-by-minute forecasts for a given location for the next 120 minutes. Users can request weather forecasts in the interval of 1, 5 and 15 minutes. The response will include details such as the type of precipitation (including rain, snow, or a mixture of both), start time, and precipitation intensity value (dBZ).", + "operationId": "Weather_GetMinuteForecastPreview", + "x-ms-examples": { + "MinuteForecast": { + "$ref": "./examples/GetMinuteForecast.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "query", + "description": "Coordinates of the location for which minute forecast information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "in": "query", + "type": "string", + "required": true + }, + { + "name": "interval", + "description": "Specifies time interval in minutes for the returned weather forecast. Supported values are\n * `1` - Retrieve forecast for 1-minute intervals. Returned by default.\n * `5` - Retrieve forecasts for 5-minute intervals.\n * `15` - Retrieve forecasts for 15-minute intervals.", + "default": 1, + "in": "query", + "type": "integer" + }, + { + "$ref": "#/parameters/WeatherLanguage" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MinuteForecastResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/weather/forecast/quarterDay/{format}": { + "get": { + "x-publish": true, + "description": "**Get Quarter-Day Forecast**\n \n \n**Applies to**: S0 and S1 pricing tiers.\n\n\nService returns detailed weather forecast by quarter-day for the next 1, 5, 10, or 15 days for a given location. Response data is presented by quarters of the day - morning, afternoon, evening, and overnight. Details such as temperature, humidity, wind, precipitation, and UV index are returned.", + "operationId": "Weather_GetQuarterDayForecastPreview", + "x-ms-examples": { + "QuarterDayForecast": { + "$ref": "./examples/GetQuarterDayForecast.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "query", + "description": "Coordinates of the location for which quarter-day forecast information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "in": "query", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/WeatherUnit" + }, + { + "name": "duration", + "description": "Specifies for how many days the quester-day forecast responses are returned. Supported values are:\n * `1` - Return forecast data for the next day. Returned by default.\n * `5` - Return forecast data for the next 5 days.\n * `10` - Return forecast data for next 10 days.\n * `15` - Return forecast data for the next 15 days.", + "default": 1, + "in": "query", + "type": "integer" + }, + { + "$ref": "#/parameters/WeatherLanguage" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/QuarterDayForecastResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/weather/currentConditions/{format}": { + "get": { + "x-publish": true, + "description": "**Get Current Conditions**\n \n \n**Applies to**: S0 and S1 pricing tiers.\n\n\nGet Current Conditions service returns detailed current weather conditions such as precipitation, temperature and wind for a given coordinate location. Also, observations from the past 6 or 24 hours for a particular location can be retrieved. The basic information returned with the response include details such as observation date and time, brief description of the weather conditions, weather icon, precipitation indicator flags, and temperature. Additional details such as RealFeel™ Temperature and UV index are also returned.", + "operationId": "Weather_GetCurrentConditionsPreview", + "x-ms-examples": { + "CurrentConditions": { + "$ref": "./examples/GetCurrentConditions.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "query", + "description": "Coordinates of the location for which current conditions information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "in": "query", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/WeatherUnit" + }, + { + "name": "details", + "description": "Return full details for the current conditions. Available values are\n * `true` - Returns full details. By default all details are returned.\n * `false` - Returns a truncated version of the current condition data, which includes observation date time, weather phrase, icon code, precipitation indicator flag, and temperature.", + "default": "true", + "in": "query", + "type": "string" + }, + { + "name": "duration", + "description": "Time frame of the returned weather conditions. By default, the most current weather conditions will be returned. Default value is 0. Supported values are:\n * `0` - Return the most current weather conditions.\n * `6` - Return weather conditions from past 6 hours.\n * `24` - Return weather conditions from past 24 hours.", + "default": 0, + "in": "query", + "type": "integer" + }, + { + "$ref": "#/parameters/WeatherLanguage" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CurrentConditionsResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/weather/forecast/daily/{format}": { + "get": { + "x-publish": true, + "description": "**Get Daily Forecast**\n \n \n**Applies to**: S0 and S1 pricing tiers.\n\n\nThe service returns detailed weather forecast such as temperature and wind by day for the next 1, 5, 10, 15, 25, or 45 days for a given coordinate location. The response include details such as temperature, wind, precipitation, air quality, and UV index.\n\nIn S0 you can request daily forecast for the next 1, 5, 10, and 15 days. In S1 you can also request daily forecast for the next 25 days, and 45 days.", + "operationId": "Weather_GetDailyForecastPreview", + "x-ms-examples": { + "DailyForecast": { + "$ref": "./examples/GetDailyForecast.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "query", + "description": "Coordinates of the location for which current conditions information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "in": "query", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/WeatherUnit" + }, + { + "name": "duration", + "description": "Specifies for how many days the daily forecast responses are returned. Available values are\n * `1` - Return forecast data for the next day. Returned by default.\n * `5` - Return forecast data for the next 5 days.\n * `10` - Return forecast data for the next 10 days.\n * `25` - Return forecast data for the next 25 days. Only available in S1 SKU.\n * `45` - Return forecast data for the next 45 days. Only available in S1 SKU.", + "default": 1, + "in": "query", + "type": "integer" + }, + { + "$ref": "#/parameters/WeatherLanguage" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DailyForecastResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/weather/route/{format}": { + "get": { + "x-publish": true, + "description": "**Get Weather along route**\n \n \n **Applies to**: S1 pricing tier.\n\n Weather along a route API returns hyper local (one kilometer or less), up-to-the-minute weather nowcasts, weather hazard assessments, and notifications along a route described as a sequence of waypoints. \n This includes a list of weather hazards affecting the waypoint or route, and the aggregated hazard index for each waypoint might be used to paint each portion of a route according to how safe it is for the driver. When submitting the waypoints, it is recommended to stay within, or close to, the distance that can be traveled within 120-mins or shortly after. Data is updated every five minutes. \n \n The service supplements Azure Maps [Route Service](https://docs.microsoft.com/rest/api/maps/route) that allows you to first request a route between an origin and a destination and use that as an input for Weather Along Route endpoint.\n \n In addition, the service supports scenarios to generate weather notifications for waypoints that experience an increase in intensity of a weather hazard. For example, if the vehicle is expected to begin experiencing heavy rain as it reaches a waypoint, a weather notification for heavy rain will be generated for that waypoint allowing the end product to display a heavy rain notification before the driver reaches that waypoint. \n The trigger for when to display the notification for a waypoint could be based, for example, on a [geofence](https://docs.microsoft.com/azure/azure-maps/tutorial-iot-hub-maps), or selectable distance to the waypoint.\n\n The API covers all regions of the planet except latitudes above Greenland and Antarctica.", + "operationId": "Weather_GetWeatherAlongRoutePreview", + "x-ms-examples": { + "WeatherAlongRoute": { + "$ref": "./examples/GetWeatherAlongRoute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "query", + "description": "Coordinates through which the route is calculated, separated by colon (:) and entered in chronological order. A minimum of two waypoints is required. A single API call may contain up to 60 waypoints. \nA waypoint indicates location, ETA, and optional heading: latitude,longitude,ETA,heading, where\n * `Latitude` - Latitude coordinate in decimal degrees.\n * `Longitude` - Longitude coordinate in decimal degrees.\n * `ETA (estimated time of arrival)` - The number of minutes from the present time that it will take for the vehicle to reach the waypoint. Allowed range is from 0.0 to 120.0 minutes.\n * `Heading` - An optional value indicating the vehicle heading as it passes the waypoint. Expressed in clockwise degrees relative to true north. This is issued to calculate sun glare as a driving hazard. Allowed range is from 0.0 to 360.0 degrees. If not provided, a heading will automatically be derived based on the position of neighboring waypoints.\n\nIt is recommended to stay within, or close to, the distance that can be traveled within 120-mins or shortly after. This way a more accurate assessment can be provided for the trip and prevent isolated events not being captured between waypoints. Information can and should be updated along the route (especially for trips greater than 2 hours) to continuously pull new waypoints moving forward, but also to ensure that forecast information for content such as precipitation type and intensity is accurate as storms develop and dissipate over time.", + "in": "query", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/WeatherLanguage" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WeatherAlongRouteResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/weather/severe/alerts/{format}": { + "get": { + "x-publish": true, + "description": "**Get Severe Weather Alerts**\n\n**Applies to**: S0 and S1 pricing tiers.\n\nSevere weather phenomenon can significantly impact our everyday life and business operations. For example, severe weather conditions such as tropical storms, high winds or flooding can close roads and force logistics companies to reroute their fleet causing delays in reaching destinations and breaking the cold chain of refrigerated food products.  Azure Maps Severe Weather Alerts API returns the severe weather alerts that are available worldwide from both official Government Meteorological Agencies and leading global to regional weather alert providers. The service can return details such as alert type, category, level and detailed description about the active severe alerts for the requested location, like hurricanes, thunderstorms, lightning, heat waves or forest fires.", + "operationId": "Weather_GetSevereWeatherAlertsPreview", + "x-ms-examples": { + "SevereWeatherAlert": { + "$ref": "./examples/GetSevereWeatherAlerts.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "query", + "description": "Coordinates of the location for which severe weather alerts are requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "in": "query", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/WeatherLanguage" + }, + { + "name": "details", + "description": "Return full details for the severe weather alerts. Available values are\n * `true` - Returns full details. By default all details are returned.\n * `false` - Returns a truncated version of the alerts data, which excludes the area-specific full description of alert details (`alertDetails`).", + "default": "true", + "in": "query", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK,", + "schema": { + "$ref": "#/definitions/SevereWeatherAlertsResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + }, + "/weather/indices/daily/{format}": { + "get": { + "x-publish": true, + "description": "**Get Daily Indices Preview**\n\n**Applies to**: S0 and S1 pricing tiers.\n\nThere may be times when you want to know if the weather conditions are optimal for a specific activity, for example, for outdoor construction, indoor activities, running or farming including soil moisture information. Azure Maps Indices API returns index values that will guide end users to plan future activities. For example, a health mobile application can notify users that today is good weather for running or for other outdoors activities like for playing golf, and retail stores can optimize their digital marketing campaigns based on predicted index values. The service returns in daily indices values for current and next 5, 10 and 15 days starting from current day.", + "operationId": "Weather_GetDailyIndicesPreview", + "x-ms-examples": { + "DailyIndices": { + "$ref": "./examples/GetDailyIndices.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientId" + }, + { + "$ref": "#/parameters/SubscriptionKey" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JsonFormat" + }, + { + "name": "query", + "description": "Coordinates of the location for which daily indices are requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. \"47.641268,-122.125679\".", + "in": "query", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/WeatherLanguage" + }, + { + "name": "duration", + "description": "Specifies for how many days the daily indices are returned. By default, the indices data for the current day will be returned. When requesting future indices data, the current day is included in the response as day 1. Available values are\n * `1` - Return daily index data for the current day. Default value.\n * `5` - Return 5 days of daily index data starting from the current day.\n * `10` - Return 10 days of daily index data starting from the current day.\n * `15` - Return 15 days of daily index data starting from the current day.", + "default": 1, + "in": "query", + "type": "integer" + }, + { + "name": "indexId", + "description": "Numeric index identifier that can be used for restricting returned results to the corresponding index type. Cannot be paired with `indexGroupId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported indices.", + "in": "query", + "type": "integer" + }, + { + "name": "indexGroupId", + "description": "Numeric index group identifier that can be used for restricting returned results to the corresponding subset of indices (index group). Cannot be paired with `indexId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported index groups.", + "in": "query", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DailyIndicesResponse" + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "500": { + "$ref": "#/responses/500" + } + } + } + } + }, + "definitions": { + "ODataErrorResponse": { + "type": "object", + "description": "This response object is returned when an error occurs in the Maps API.", + "properties": { + "error": { + "$ref": "#/definitions/ODataError" + } + } + }, + "ODataError": { + "type": "object", + "description": "This object is returned when an error occurs in the Maps API.", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The ODataError code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "If available, a human readable description of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + } + }, + "target": { + "type": "string", + "readOnly": true, + "description": "If available, the target causing the error." + } + } + }, + "WeatherUnit": { + "type": "object", + "properties": { + "value": { + "type": "number", + "format": "float", + "description": "Rounded value." + }, + "unit": { + "type": "string", + "description": "Type of unit for the returned value." + }, + "unitType": { + "type": "integer", + "format": "int32", + "description": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + } + } + }, + "Wind": { + "type": "object", + "description": "Wind details being returned including speed and direction.", + "properties": { + "direction": { + "$ref": "#/definitions/WindDirection", + "description": "Wind direction" + }, + "speed": { + "$ref": "#/definitions/WindSpeed", + "description": "Speed of the wind in specified unit." + } + } + }, + "WindDirection": { + "type": "object", + "properties": { + "degrees": { + "type": "integer", + "format": "int32", + "description": "Wind direction in Azimuth degrees, starting at true North and continuing in clockwise direction. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. Possible values 0-359." + }, + "localizedDescription": { + "type": "string", + "description": "Direction abbreviation in the specified language." + } + }, + "description": "Wind direction" + }, + "WindSpeed": { + "type": "object", + "description": "Speed of wind in specified unit.", + "properties": { + "value": { + "type": "number", + "format": "float", + "description": "Rounded value of the speed." + }, + "unit": { + "type": "string", + "description": "Type of unit for the speed value." + }, + "unitType": { + "type": "integer", + "format": "int32", + "description": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + } + } + }, + "WeatherUnitRange": { + "type": "object", + "description": "Returned temperature values.", + "properties": { + "minimum": { + "$ref": "#/definitions/WeatherUnit", + "description": "Minimum temperature for the time period." + }, + "maximum": { + "$ref": "#/definitions/WeatherUnit", + "description": "Maximum temperature for the time period" + } + } + }, + "UVIndex": { + "type": "integer", + "format": "int32", + "description": "Measure of the strength of the ultraviolet radiation from the sun. Supported values are:\n * `0-2` - Low danger from the sun's UV rays or the average person.\n * `3-5` - Moderate risk of harm from unprotected sun exposure.\n * `6-7` - High risk of harm from unprotected sun exposure.\n * `8-10` - Very high risk of harm from unprotected sun exposure.\n * `11+` - Extreme risk of harm from unprotected sun exposure." + }, + "HazardIndex": { + "type": "integer", + "format": "int32", + "description": "A severity/hazard index.\n * `0` - No hazard.\n * `1` - Be informed, be aware.\n * `2` - Pay attention, be prepared.\n * `3` - Take action.\n * `4` - Life threatening, emergency." + }, + "HourlyForecast": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date and time of the forecast in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "iconCode": { + "type": "integer", + "format": "int32", + "description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + }, + "iconPhrase": { + "type": "string", + "description": "Phrase description of the weather icon." + }, + "hasPrecipitation": { + "type": "boolean", + "description": "Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation." + }, + "isDaylight": { + "type": "boolean", + "description": "Specifies whether or not it is daylight. True indicates day light." + }, + "temperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "Temperature being returned." + }, + "realFeelTemperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "RealFeel™ Temperature being returned. Describes what the temperature really feels like in the shade." + }, + "wetBulbTemperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "The temperature to which air may be cooled by evaporating water into it at constant pressure until it reaches saturation." + }, + "dewPoint": { + "$ref": "#/definitions/WeatherUnit", + "description": "The dewpoint temperature in specified unit. The dewpoint temperature is the temperature that the air must be cooled to in order to reach saturation." + }, + "wind": { + "$ref": "#/definitions/Wind", + "description": "Wind details being returned including speed and direction." + }, + "windGust": { + "$ref": "#/definitions/Wind", + "description": "Wind gust. Wind gust is a sudden, brief increase in speed of the wind." + }, + "relativeHumidity": { + "type": "integer", + "format": "int32", + "description": "Relative humidity is the amount of water vapor present in air expressed as a percentage of the amount needed for saturation at the same temperature." + }, + "visibility": { + "$ref": "#/definitions/WeatherUnit", + "description": "Visibility in specified unit. A measure of the distance at which an object or light can be clearly discerned." + }, + "ceiling": { + "$ref": "#/definitions/WeatherUnit", + "description": "Cloud ceiling in specified unit. The ceiling is a measurement of the height of the base of the lowest clouds." + }, + "uvIndex": { + "$ref": "#/definitions/UVIndex" + }, + "uvIndexPhrase": { + "type": "string", + "description": "Phrase associated with the `uvIndex`." + }, + "precipitationProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of precipitation. For example, '20'." + }, + "rainProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of rain. For example, '50'." + }, + "snowProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of snow. For example, '50'." + }, + "iceProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of snow. For example, '5'." + }, + "totalLiquid": { + "$ref": "#/definitions/WeatherUnit", + "description": "Total liquid equivalent of precipitation during the forecast period." + }, + "rain": { + "$ref": "#/definitions/WeatherUnit", + "description": "Rain" + }, + "snow": { + "$ref": "#/definitions/WeatherUnit", + "description": "Snow" + }, + "ice": { + "$ref": "#/definitions/WeatherUnit", + "description": "Ice" + }, + "cloudCover": { + "type": "integer", + "format": "int32", + "description": "Percent representing cloud cover." + } + } + }, + "HourlyForecastResponse": { + "type": "object", + "properties": { + "forecasts": { + "type": "array", + "description": "Forecast data for each returned hour.", + "items": { + "$ref": "#/definitions/HourlyForecast" + } + } + } + }, + "MinuteForecastSummary": { + "type": "object", + "properties": { + "briefPhrase60": { + "type": "string", + "description": "Summary phrase for the next 60 minutes. Phrase length is approximately 60 characters." + }, + "shortPhrase": { + "type": "string", + "description": "Short summary phrase for the next 120 minutes. Phrase length is approximately 25 characters." + }, + "briefPhrase": { + "type": "string", + "description": "Summary phrase for the next 120 minutes. Phrase length is approximately 60 characters." + }, + "longPhrase": { + "type": "string", + "description": "Long summary phrase for the next 120 minutes. Phrase length is 60+ characters." + }, + "iconCode": { + "type": "integer", + "format": "int32", + "description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + } + }, + "description": "Phrase summaries for the entire forecast period." + }, + "IntervalSummary": { + "type": "object", + "properties": { + "startMinute": { + "type": "integer", + "format": "int32", + "description": "The first minute to which the summary applies." + }, + "endMinute": { + "type": "integer", + "format": "int32", + "description": "The last minute to which the summary applies." + }, + "totalMinutes": { + "type": "integer", + "format": "int32", + "description": "The number of minutes for which the summary applies." + }, + "shortPhrase": { + "type": "string", + "description": "Short summary phrase. Phrase length is approximately 25 characters." + }, + "briefPhrase": { + "type": "string", + "description": "Brief summary phrase. Phrase length is approximately 60 characters." + }, + "longPhrase": { + "type": "string", + "description": "Long summary phrase. Phrase length is 60+ characters." + }, + "iconCode": { + "type": "integer", + "format": "int32", + "description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + } + } + }, + "Interval": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "description": "The date and time for the start of the interval in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "minute": { + "type": "integer", + "format": "int32", + "description": "The first minute for the interval." + }, + "dbz": { + "type": "number", + "format": "double", + "description": "A unit that represents forecasted precipitation intensity." + }, + "shortPhrase": { + "type": "string", + "description": "A short phrase describing precipitation condition for the interval." + }, + "threshold": { + "type": "string", + "description": "Key that specifies the threshold value. Along with precipitationType, can be used to determine the simplifiedColor. If dbz is zero, not present in the response." + }, + "color": { + "$ref": "#/definitions/Color", + "description": "The full spectrum color that maps to the dBZ (decibel relative to Z). If dbz is zero, color is not present in the response." + }, + "simplifiedColor": { + "$ref": "#/definitions/Color", + "description": "The band color that maps to the precipitation type and threshold. If dbz is zero, not present in the response." + }, + "precipitationType": { + "type": "string", + "description": "Specifies the type of precipitation (\"rain\" \"snow\" \"ice\" or \"mix\"). If dbz is zero, precipitationType is not present in the response." + }, + "iconCode": { + "type": "integer", + "format": "int32", + "description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + }, + "cloudCover": { + "type": "integer", + "format": "int32", + "description": "Percent representing cloud cover." + } + } + }, + "MinuteForecastResponse": { + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/MinuteForecastSummary" + }, + "intervalSummaries": { + "type": "array", + "items": { + "$ref": "#/definitions/IntervalSummary" + }, + "description": "Summary information for each interval in the forecast. The Summaries breaks down each potential interval where precipitation starts and stops." + }, + "intervals": { + "type": "array", + "description": "Forecast data for each interval in the forecast.", + "items": { + "$ref": "#/definitions/Interval" + } + } + } + }, + "Color": { + "type": "object", + "properties": { + "red": { + "type": "integer", + "format": "int32", + "description": "Red component of the RGB value." + }, + "green": { + "type": "integer", + "format": "int32", + "description": "Green component of the RGB value." + }, + "blue": { + "type": "integer", + "format": "int32", + "description": "Blue component of the RGB value" + }, + "hex": { + "type": "string", + "description": "Hexadecimal color value." + } + } + }, + "QuarterDayForecast": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date and time of the forecast in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "effectiveDate": { + "type": "string", + "description": "Date and time of the beginning of the forecast quarter displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "quarter": { + "description": "Quarter of the day.", + "type": "integer", + "format": "int32", + "enum": [ + 0, + 1, + 2, + 3 + ], + "x-ms-enum": { + "name": "Quarter", + "modelAsString": false, + "values": [ + { + "value": 0, + "description": "7:00 am - 1:00 pm / 7:00- 13:00" + }, + { + "value": 1, + "description": "1:00 pm - 7:00 pm/ 13:00- 19:00" + }, + { + "value": 2, + "description": "7:00 pm - 1:00 am/ 19:00 - 01:00" + }, + { + "value": 3, + "description": "1:00 am - 7:00 am/ 01:00 - 07:00" + } + ] + } + }, + "iconCode": { + "type": "integer", + "format": "int32", + "description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + }, + "iconPhrase": { + "type": "string", + "description": "Phrase description of the icon. Displayed in specified language. For example, 'Sunny'." + }, + "phrase": { + "type": "string", + "description": "Short summary phrase summary for quarter." + }, + "temperature": { + "$ref": "#/definitions/WeatherUnitRange", + "description": "Temperature values for the quarter." + }, + "realFeelTemperature": { + "$ref": "#/definitions/WeatherUnitRange", + "description": "RealFeel™ Temperature values for the quarter." + }, + "dewPoint": { + "$ref": "#/definitions/WeatherUnit", + "description": "The dewpoint temperature in specified unit. The dewpoint temperature is the temperature that the air must be cooled to in order to reach saturation." + }, + "relativeHumidity": { + "type": "integer", + "format": "int32", + "description": "Relative humidity is the amount of water vapor present in air expressed as a percentage of the amount needed for saturation at the same temperature." + }, + "wind": { + "$ref": "#/definitions/Wind", + "description": "Wind details being returned including speed and direction." + }, + "windGust": { + "$ref": "#/definitions/Wind", + "description": "Wind gust. Wind gust is a sudden, brief increase in speed of the wind." + }, + "visibility": { + "$ref": "#/definitions/WeatherUnit", + "description": "Visibility in specified unit. A measure of the distance at which an object or light can be clearly discerned." + }, + "cloudCover": { + "type": "integer", + "format": "int32", + "description": "Percent representing cloud cover." + }, + "hasPrecipitation": { + "type": "boolean", + "description": "Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation." + }, + "precipitationType": { + "type": "string", + "description": "Specifies the type of precipitation (\"rain\" \"snow\" \"ice\" or \"mix\"). If dbz = zero, precipitationType is not present in the response." + }, + "precipitationIntensity": { + "type": "string", + "description": "Description of the intensity." + }, + "precipitationProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of precipitation. For example, '20'." + }, + "thunderstormProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of a thunderstorm. For example, '10'." + }, + "totalLiquid": { + "$ref": "#/definitions/WeatherUnit", + "description": "Total liquid equivalent of precipitation during the forecast period." + }, + "rain": { + "$ref": "#/definitions/WeatherUnit", + "description": "Rain" + }, + "snow": { + "$ref": "#/definitions/WeatherUnit", + "description": "Snow" + }, + "ice": { + "$ref": "#/definitions/WeatherUnit", + "description": "Ice" + } + } + }, + "QuarterDayForecastResponse": { + "type": "object", + "properties": { + "forecasts": { + "type": "array", + "description": "Forecast data for each quarter in the response.", + "items": { + "$ref": "#/definitions/QuarterDayForecast" + } + } + } + }, + "CurrentConditionsResponse": { + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/definitions/CurrentConditions" + } + } + } + }, + "PressureTendency": { + "type": "object", + "properties": { + "localizedDescription": { + "type": "string", + "description": "Description of the pressure tendency in specified language" + }, + "code": { + "type": "string", + "description": "Pressure tendency code regardless of language. One of F=Falling, S=Steady, R=Rising." + } + } + }, + "PrecipitationSummary": { + "type": "object", + "properties": { + "pastHour": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen in the past hour." + }, + "past3Hours": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen in the past three hours." + }, + "past6Hours": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen in the past six hours. Contains Metric and Imperial Values." + }, + "past9Hours": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen in the past nine hours." + }, + "past12Hours": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen in the past 12 hours." + }, + "past18Hours": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen in the past 18 hours." + }, + "past24Hours": { + "$ref": "#/definitions/WeatherUnit", + "description": "The amount of precipitation (liquid equivalent) that has fallen in the past 24 hours." + } + } + }, + "TemperatureSummary": { + "type": "object", + "properties": { + "past6Hours": { + "type": "object", + "properties": { + "minimum": { + "$ref": "#/definitions/WeatherUnit", + "description": "minimum" + }, + "maximum": { + "$ref": "#/definitions/WeatherUnit", + "description": "maximum" + } + }, + "description": "Summary of temperature fluctuations over the past 6 hours." + }, + "past12Hours": { + "type": "object", + "properties": { + "minimum": { + "$ref": "#/definitions/WeatherUnit", + "description": "minimum" + }, + "maximum": { + "$ref": "#/definitions/WeatherUnit", + "description": "maximum" + } + }, + "description": "Summary of temperature fluctuations over the past 12 hours." + }, + "past24Hours": { + "type": "object", + "properties": { + "minimum": { + "$ref": "#/definitions/WeatherUnit", + "description": "minimum" + }, + "maximum": { + "$ref": "#/definitions/WeatherUnit", + "description": "maximum" + } + }, + "description": "Summary of temperature fluctuations over the past 24 hours." + } + } + }, + "CurrentConditions": { + "type": "object", + "properties": { + "dateTime": { + "type": "string", + "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "phrase": { + "type": "string", + "description": "Phrase description of the current weather condition. Displayed in specified language." + }, + "iconCode": { + "type": "integer", + "format": "int32", + "description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + }, + "hasPrecipitation": { + "type": "boolean", + "description": "Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation." + }, + "isDayTime": { + "type": "boolean", + "description": "Indicates the time of the day. True indicates 'day',', false indicates 'night." + }, + "temperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "Temperature being returned." + }, + "realFeelTemperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "RealFeel™ Temperature being returned." + }, + "realFeelTemperatureShade": { + "$ref": "#/definitions/WeatherUnit", + "description": "RealFeel™ Temperature being returned. Describes what the temperature really feels like in the shade." + }, + "relativeHumidity": { + "type": "integer", + "format": "int32", + "description": "Relative humidity is the amount of water vapor present in air expressed as a percentage of the amount needed for saturation at the same temperature." + }, + "dewPoint": { + "$ref": "#/definitions/WeatherUnit", + "description": "The dewpoint temperature in specified unit. The dewpoint temperature is the temperature that the air must be cooled to in order to reach saturation." + }, + "wind": { + "$ref": "#/definitions/Wind", + "description": "Wind details being returned including speed and direction." + }, + "windGust": { + "$ref": "#/definitions/Wind", + "description": "Wind gust. Wind gust is a sudden, brief increase in speed of the wind." + }, + "uvIndex": { + "$ref": "#/definitions/UVIndex" + }, + "uvIndexPhrase": { + "type": "string", + "description": "Phrase associated with the `uvIndex`." + }, + "visibility": { + "$ref": "#/definitions/WeatherUnit", + "description": "Visibility in specified unit. A measure of the distance at which an object or light can be clearly discerned." + }, + "obstructionsToVisibility": { + "type": "string", + "description": "Cause of limited visibility." + }, + "cloudCover": { + "type": "integer", + "format": "int32", + "description": "Percent representing cloud cover." + }, + "ceiling": { + "$ref": "#/definitions/WeatherUnit", + "description": "Cloud ceiling in specified unit. The ceiling is a measurement of the height of the base of the lowest clouds." + }, + "pressure": { + "$ref": "#/definitions/WeatherUnit", + "description": "Atmospheric pressure in specified unit." + }, + "pressureTendency": { + "$ref": "#/definitions/PressureTendency", + "description": "Atmospheric pressure change." + }, + "past24HourTemperatureDeparture": { + "$ref": "#/definitions/WeatherUnit", + "description": "Departure from the temperature observed 24 hours ago in specified unit." + }, + "apparentTemperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "Perceived outdoor temperature caused by the combination of air temperature, relative humidity, and wind speed in specified unit." + }, + "windChillTemperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "Perceived air temperature on exposed skin due to wind." + }, + "wetBulbTemperature": { + "$ref": "#/definitions/WeatherUnit", + "description": "The temperature to which air may be cooled by evaporating water into it at constant pressure until it reaches saturation." + }, + "precipitationSummary": { + "$ref": "#/definitions/PrecipitationSummary", + "description": "Summary of precipitation amounts over the past 24 hours." + }, + "temperatureSummary": { + "$ref": "#/definitions/TemperatureSummary", + "description": "Summary of temperature fluctuations over the past 6, 12, and 24 hours." + } + } + }, + "DailyForecastSummary": { + "type": "object", + "properties": { + "startDate": { + "type": "string", + "description": "Date and time that the summary is in effect, displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "endDate": { + "type": "string", + "description": "Date and time that the summary period ends, displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "severity": { + "type": "integer", + "format": "int32", + "description": "severity" + }, + "phrase": { + "type": "string", + "description": "Summary phrase of the daily forecast. Displayed in specified language." + }, + "category": { + "type": "string", + "description": "one or 2 word(s) to summarize the phrase." + } + }, + "description": "Summary for the main conditions for the requested time period. Notice that summary can cover only part of the time period." + }, + "DegreeDaySummary": { + "type": "object", + "properties": { + "heating": { + "$ref": "#/definitions/WeatherUnit", + "description": "Number of degrees that the mean temperature is below 65 degrees F/ 18 degree C." + }, + "cooling": { + "$ref": "#/definitions/WeatherUnit", + "description": "Number of degrees that the mean temperature is above 65 degrees F/ 18 degree C." + } + } + }, + "AirAndPollen": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the pollen or pollutant. For example, grass, mold, weed, air quality, tree and UV index." + }, + "value": { + "type": "integer", + "format": "int32", + "description": "Value of the given type above. Values associated with mold, grass, weed and tree are in units of parts per cubic meter. Both air quality and UV are indices, so they are unitless." + }, + "category": { + "type": "string", + "description": "Category of the air quality or pollution type. For example, low, high, good, moderate, unhealthy, hazardous." + }, + "categoryValue": { + "type": "integer", + "format": "int32", + "description": "Value associated with the air quality or pollution category. These values range from 1 to 6. 1 implying good conditions, 6 implying hazardous conditions." + }, + "type": { + "type": "string", + "description": "Only exists for air quality. Examples include ozone and particle pollution." + } + } + }, + "DailyForecast": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "temperature": { + "$ref": "#/definitions/WeatherUnitRange", + "description": "Temperature values for the day." + }, + "realFeelTemperature": { + "$ref": "#/definitions/WeatherUnitRange", + "description": "RealFeel™ Temperature being returned." + }, + "realFeelTemperatureShade": { + "$ref": "#/definitions/WeatherUnitRange", + "description": "RealFeel™ Temperature being returned. Describes what the temperature really feels like in the shade." + }, + "hoursOfSun": { + "type": "number", + "format": "float", + "description": "Hours of sun." + }, + "degreeDaySummary": { + "$ref": "#/definitions/DegreeDaySummary", + "description": "Summary of Heating Degree Day or Cooling Degree Day information" + }, + "airAndPollen": { + "type": "array", + "items": { + "$ref": "#/definitions/AirAndPollen" + }, + "description": "airAndPollen" + }, + "day": { + "$ref": "#/definitions/DayOrNight", + "description": "Day" + }, + "night": { + "$ref": "#/definitions/DayOrNight", + "description": "Night" + }, + "sources": { + "type": "array", + "items": { + "type": "string", + "description": "Source(s) of the forecast data." + } + } + } + }, + "DailyForecastResponse": { + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/DailyForecastSummary" + }, + "forecasts": { + "type": "array", + "description": "Forecast data for each requested day.", + "items": { + "$ref": "#/definitions/DailyForecast" + } + } + } + }, + "LocalSource": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "Numeric identifier, unique to the local data provider." + }, + "name": { + "type": "string", + "description": "Name of the local data provider. Name is displayed in the language specified by language code in URL, if available. Otherwise, Name is displayed in English or the language in which the name was provided." + }, + "weatherCode": { + "type": "string", + "description": "Weather code provided by the local data provider. This weather code allows the forecast to be matched to icons provided by the local data provider instead of Azure Maps icons." + } + } + }, + "DayOrNight": { + "type": "object", + "properties": { + "iconCode": { + "type": "integer", + "format": "int32", + "description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + }, + "iconPhrase": { + "type": "string", + "description": "Phrase description of the icon. Displayed in specified language. For example, 'Sunny'." + }, + "localSource": { + "$ref": "#/definitions/LocalSource" + }, + "hasPrecipitation": { + "type": "boolean", + "description": "Indicates the presence or absence of precipitation. True indicates the presence of precipitation, false indicates the absence of precipitation." + }, + "precipitationType": { + "type": "string", + "description": "Specifies the type of precipitation (\"rain\" \"snow\" \"ice\" or \"mix\"). If dbz = zero, precipitationType is not present in the response." + }, + "precipitationIntensity": { + "type": "string", + "description": "Description of the intensity." + }, + "shortPhrase": { + "type": "string", + "description": "Phrase description of the forecast in specified language. Azure Maps attempts to keep this phrase under 30 characters in length, but some languages/weather events may result in a longer phrase length, exceeding 30 characters." + }, + "longPhrase": { + "type": "string", + "description": "Phrase description of the forecast in specified language. Azure Maps attempts to keep this phrase under 100 characters in length, but some languages/weather events may result in a longer phrase length, exceeding 100 characters." + }, + "precipitationProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of precipitation. For example, '20'." + }, + "thunderstormProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of a thunderstorm. For example, '80'." + }, + "rainProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of rain. For example, '40'." + }, + "snowProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of snow. For example, '30'." + }, + "iceProbability": { + "type": "integer", + "format": "int32", + "description": "Percent representing the probability of ice. For example, '30'." + }, + "wind": { + "$ref": "#/definitions/Wind", + "description": "Wind details being returned including speed and direction." + }, + "windGust": { + "$ref": "#/definitions/Wind", + "description": "Wind gust. Wind gust is a sudden, brief increase in speed of the wind." + }, + "totalLiquid": { + "$ref": "#/definitions/WeatherUnit", + "description": "Total liquid equivalent of precipitation during the forecast period." + }, + "rain": { + "$ref": "#/definitions/WeatherUnit", + "description": "Rain" + }, + "snow": { + "$ref": "#/definitions/WeatherUnit", + "description": "Snow" + }, + "ice": { + "$ref": "#/definitions/WeatherUnit", + "description": "Ice" + }, + "hoursOfPrecipitation": { + "type": "number", + "format": "float", + "description": "Hours of precipitation" + }, + "hoursOfRain": { + "type": "number", + "format": "float", + "description": "Hours of rain." + }, + "hoursOfSnow": { + "type": "number", + "format": "float", + "description": "Hours of snow." + }, + "hoursOfIce": { + "type": "number", + "format": "float", + "description": "Hours of ice." + }, + "cloudCover": { + "type": "integer", + "format": "int32", + "description": "Percent representing cloud cover." + } + } + }, + "WeatherAlongRouteSummary": { + "type": "object", + "properties": { + "iconCode": { + "type": "integer", + "format": "int32", + "description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + }, + "hazards": { + "$ref": "#/definitions/Hazards" + } + } + }, + "WeatherAlongRouteResponse": { + "type": "object", + "description": "This object is returned from a successful Weather Along Route.", + "properties": { + "summary": { + "$ref": "#/definitions/WeatherAlongRouteSummary" + }, + "waypoints": { + "type": "array", + "description": "Data for each waypoint returned in the same order as specified in the request.", + "items": { + "$ref": "#/definitions/Waypoint" + } + } + } + }, + "WeatherAlongRoutePrecipitation": { + "type": "object", + "properties": { + "dbz": { + "type": "number", + "format": "double", + "description": "The forecasted precipitation intensity in dBZ (decibels relative to Z) from 0.0 to 100.0." + }, + "type": { + "type": "string", + "description": "Precipitation type. If precipitation should occur, the type that it will be: \"RAIN,\" \"HAIL,\" \"SNOW,\" \"ICE,\" or \"MIX.\"" + } + } + }, + "SunGlare": { + "type": "object", + "description": "A rating that indicates how blinding the sun is for the driver.", + "properties": { + "calculatedVehicleHeading": { + "type": "integer", + "format": "int32", + "description": "If the vehicle heading value is not provided for a waypoint, then the service will calculate a heading based upon the location of neighboring waypoints if provided." + }, + "glareIndex": { + "type": "integer", + "format": "int32", + "description": "An index from 0 to 100 indicating sun glare intensity for a driver. A value of 50 and above can be considered a hazard for some drivers and a value of 100 signifies the driver is driving straight into the sun and atmospheric conditions are clear allowing for the full intensity of the sun to blind the driver." + } + } + }, + "Waypoint": { + "type": "object", + "properties": { + "iconCode": { + "type": "integer", + "format": "int32", + "description": "Numeric value representing an image that displays the `iconPhrase`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + }, + "shortPhrase": { + "type": "string", + "description": "A displayable short phrase describing the forecasted conditions and precipitation intensity/type." + }, + "isDayTime": { + "type": "boolean", + "description": "Indicates the time of the day. True indicates 'day',', false indicates 'night." + }, + "cloudCover": { + "type": "integer", + "format": "int32", + "description": "Percent representing cloud cover." + }, + "temperature": { + "$ref": "#/definitions/WeatherUnit" + }, + "wind": { + "$ref": "#/definitions/Wind" + }, + "windGust": { + "$ref": "#/definitions/Wind" + }, + "precipitation": { + "$ref": "#/definitions/WeatherAlongRoutePrecipitation" + }, + "lightningCount": { + "type": "integer", + "format": "int32", + "description": "Estimation of thunderstorm intensity on an open scale. A value of 0 means there is no thunderstorm; values of 1 and higher mean there is a thunderstorm in increasing intensity." + }, + "sunGlare": { + "$ref": "#/definitions/SunGlare", + "description": "A rating that indicates how blinding the sun is for the driver." + }, + "hazards": { + "$ref": "#/definitions/Hazards" + }, + "notifications": { + "type": "array", + "items": { + "$ref": "#/definitions/Notification" + } + } + } + }, + "Hazards": { + "type": "object", + "properties": { + "maxHazardIndex": { + "$ref": "#/definitions/HazardIndex" + }, + "hazardDetails": { + "type": "array", + "description": "Details of the weather hazards affecting the trip.", + "items": { + "$ref": "#/definitions/HazardDetail" + } + } + } + }, + "HazardDetail": { + "type": "object", + "properties": { + "hazardIndex": { + "$ref": "#/definitions/HazardIndex" + }, + "hazardCode": { + "type": "string", + "description": "A unique identifier (non-displayable) for each type of hazard: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning." + }, + "shortPhrase": { + "type": "string", + "description": "A displayable short phrase describing the forecasted conditions and precipitation intensity/type." + } + } + }, + "Notification": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "A type of notification generated to warn drivers of the onset of a hazard, or increase in intensity of a hazard." + }, + "hazardIndex": { + "$ref": "#/definitions/HazardIndex" + }, + "hazardCode": { + "type": "string", + "description": "A unique identifier (non-displayable) for each type of hazard: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning." + }, + "shortPhrase": { + "type": "string", + "description": "A displayable short phrase describing the forecasted conditions and precipitation intensity/type." + } + } + }, + "SevereWeatherAlertsResponse": { + "type": "object", + "description": "This object is returned from a successful Get Severe Weather Alerts call.", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/definitions/SevereWeatherAlert" + }, + "description": "A list of all severe weather alerts for the queried location." + } + } + }, + "SevereWeatherAlert": { + "type": "object", + "description": "Information about a severe weather alert.", + "properties": { + "countryCode": { + "type": "string", + "description": "2-character ISO 3166-1 Alpha-2 country code, for example, \"US\"." + }, + "alertId": { + "type": "integer", + "format": "int32", + "description": "A unique numerical identifier for a weather alert." + }, + "description": { + "$ref": "#/definitions/Description", + "description": "Description of the alert." + }, + "category": { + "type": "string", + "description": "Category of the alert." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "Number signifying the importance or ranking order of the given alert within the country/region it has originated. A lower number signifies a higher priority. For example, 1 is the highest priority. The number varies by country/region and can change over time as each country/region evolves their alert systems." + }, + "class": { + "type": "string", + "description": "Classification of the alert. This field is not available for all countries and therefore not always returned." + }, + "level": { + "type": "string", + "description": "Severity level of the alert. This field is not available for all countries and therefore not always returned." + }, + "source": { + "type": "string", + "description": "The provider of the alert information. By default the source is returned in English (en-US). The alerts are from official Government Meteorological Agencies and leading global weather alert providers." + }, + "sourceId": { + "type": "integer", + "format": "int32", + "description": "A numerical identifier associated with the source provider name of the alert data." + }, + "disclaimer": { + "type": "string", + "description": "A disclaimer regarding the source of the alert information. This field is not always available. For example, disclaimer may include details about the delays or potential issues related to the alarm." + }, + "alertAreas": { + "type": "array", + "items": { + "$ref": "#/definitions/AlertArea" + }, + "description": "Information about the alert specific to the affected area(s)." + } + } + }, + "Description": { + "type": "object", + "description": "Description of a severe weather alert.", + "properties": { + "localized": { + "type": "string", + "description": "Description of the alert in the specified language. By default English (en-US) is returned if the language parameter is not specified in the request." + }, + "english": { + "type": "string", + "description": "Description of the alert in English (en-US)." + } + } + }, + "AlertArea": { + "type": "object", + "description": "Information about a severe weather alert issued within an affected area(s). If multiple alerts are active for the same location, the alerts will be returned in order of `priority` within the API response, with the highest priority alert being returned at the top of the response.", + "properties": { + "name": { + "type": "string", + "description": "The name of an area which is affected by the alert. The location that was requested falls under the alert area." + }, + "summary": { + "type": "string", + "description": "Text summarizing the alert in the returned area." + }, + "startTime": { + "type": "string", + "description": "The start date and time of the alert in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. If the alert crosses multiple time zones the returned time in the response is the local time to the requested coordinate location." + }, + "endTime": { + "type": "string", + "description": "The end date and time of the alert in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00. If the alert crosses multiple time zones the returned time in the response is the local time to the requested coordinate location." + }, + "latestStatus": { + "$ref": "#/definitions/LatestStatus", + "description": "The latest status of the alert in the current area." + }, + "alertDetails": { + "type": "string", + "description": "Full details associated with the alert. Returned if `details`=True. This field is always returned in the language(s) of choice by the issuing provider and Azure Maps only returns what is created by the provider. Please note, some countries/regions may offer their native language and English. Language parameter won’t apply to this field." + }, + "alertDetailsLanguageCode": { + "type": "string", + "description": "Language of the `alertDetails`. This field helps to point out that the language of the `alertDetails` may differ from the requested language parameter. Returned if `details`=True. Language code has been derived from the ISO 639-1 Alpha-2 codes." + } + } + }, + "LatestStatus": { + "type": "object", + "description": "The latest status on the alert in the current area.", + "properties": { + "localized": { + "type": "string", + "description": "The latest status keyword for the alert, in the specified language. By default, returned in English (en-US)." + }, + "english": { + "$ref": "#/definitions/LatestStatusKeyword", + "description": "Latest status keyword for the alert, in English (en-US)." + } + } + }, + "LatestStatusKeyword": { + "type": "string", + "description": "Keyword for the latest status of the alert.", + "enum": [ + "New", + "Extend", + "Cancel", + "Correct", + "Expire", + "Upgrade", + "Continue", + "Update" + ], + "x-ms-enum": { + "name": "LatestStatusKeyword", + "modelAsString": false, + "values": [ + { + "value": "New", + "description": "\"New\" - the status of an alert upon initial issuance." + }, + { + "value": "Extend", + "description": "\"Extend\" - the alert has been extended in time, in area, or both since its initial issuance." + }, + { + "value": "Cancel", + "description": "\"Cancel\" - the alert has been canceled prior to its original expiration time." + }, + { + "value": "Correct", + "description": "\"Correct\" - the alert has been modified to correct a previous error." + }, + { + "value": "Expire", + "description": "\"Expire\" - the alert has expired and is no longer active." + }, + { + "value": "Upgrade", + "description": "\"Upgrade\" - the alert has been upgraded to a higher class or category since its initial issuance." + }, + { + "value": "Continue", + "description": "\"Continue\" - the alert has been updated since its initial issuance, but no changes were made to `alertAreas`, `startTime`, `endTime`, or `class`." + }, + { + "value": "Update", + "description": "\"Update\" - the alert has been updated since its initial issuance." + } + ] + } + }, + "DailyIndicesResponse": { + "type": "object", + "description": "This object is returned from a successful Get Daily Indices call.", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/definitions/DailyIndex" + }, + "description": "A list of all daily indices for the queried location." + } + } + }, + "DailyIndex": { + "type": "object", + "description": "Information about a daily index.", + "properties": { + "indexName": { + "type": "string", + "description": "Name of the index, for example, \"Construction\", \"Outdoor Activity\", \"Flight Delays\"." + }, + "indexId": { + "type": "integer", + "format": "int32", + "description": "Numeric ID used to identify the specific index. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported index IDs. For example, the index ID can support UI visualization scenarios." + }, + "dateTime": { + "type": "string", + "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "value": { + "type": "number", + "format": "float", + "description": "Index value. Ranges from 0.0 to 10.0. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported ranges." + }, + "category": { + "type": "string", + "description": "Textual description for `categoryValue` corresponding to the level that the index value falls under, for example \"Very Good\"." + }, + "categoryValue": { + "type": "integer", + "format": "int32", + "description": "Level that the index value falls under, represented by an integer. This value can be 1 through 5 and should be used in combination with the `ascending` flag because it can differ among indices. For example, the following values apply for Mosquito Activity: Low=1, Moderate=2, High=3, Very High=4, and Extreme=5." + }, + "ascending": { + "type": "boolean", + "description": "Describes the direction of the `value` and `categoryValue`. For example, when `ascending`=True, the poorest index value is 0 and the best index value is 10. When `ascending`=True, the poorest index value is 10 and the best index value is 0." + }, + "description": { + "type": "string", + "description": "A textual explanation that can be used for display purposes to summarize the index value and category. For example, when the index value for Flight Delays is very good, the description will be \"Conditions are excellent for flying!\"." + } + } + }, + "CurrentAirQualityResponse": { + "type": "object", + "description": "This object is returned from a successful Get Current Air Quality call.", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/definitions/AirQuality" + }, + "description": "A list of all air quality results for the queried location." + } + } + }, + "HourlyAirQualityForecastResponse": { + "type": "object", + "description": "This object is returned from a successful Get Hourly Air Quality Forecast call.", + "properties": { + "forecasts": { + "type": "array", + "items": { + "$ref": "#/definitions/AirQuality" + }, + "description": "A list of all hourly air quality forecasts for the queried location." + } + } + }, + "DailyAirQualityForecastResponse": { + "type": "object", + "description": "This object is returned from a successful Get Daily Air Quality Forecast call.", + "properties": { + "forecasts": { + "type": "array", + "items": { + "$ref": "#/definitions/DailyAirQuality" + }, + "description": "A list of all daily air quality forecasts for the queried location." + } + } + }, + "AirQuality": { + "type": "object", + "description": "Information about the air quality in a specific location at a specific time.", + "properties": { + "dateTime": { + "type": "string", + "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "index": { + "type": "number", + "format": "float", + "description": "Air quality rating on a scale set by local regulating bodies. Scales can vary widely based on location. See [Wikipedia](https://en.wikipedia.org/wiki/Air_quality_index) for more information." + }, + "globalIndex": { + "type": "number", + "format": "float", + "description": "Internationally normalized air quality rating on a scale from 0 to 300 and up, with higher numbers representing worse air quality." + }, + "dominantPollutant": { + "type": "string", + "description": "The pollutant with the highest concentration." + }, + "category": { + "type": "string", + "description": "One-word description of the air quality in the requested language. For example, \"Excellent\"." + }, + "categoryColor": { + "type": "string", + "description": "A unique color corresponding to the category of this air quality result." + }, + "description": { + "type": "string", + "description": "A textual explanation of this air quality result in the requested language." + }, + "pollutants": { + "type": "array", + "items": { + "$ref": "#/definitions/Pollutant" + }, + "description": "Information about individual pollutants." + } + } + }, + "DailyAirQuality": { + "type": "object", + "description": "Information about the air quality in a specific location at a specific time.", + "properties": { + "dateTime": { + "type": "string", + "description": "Date and time of the current observation displayed in ISO 8601 format, for example, 2019-10-27T19:39:57-08:00." + }, + "index": { + "type": "number", + "format": "float", + "description": "Air quality rating on a scale set by local regulating bodies. Scales can vary widely based on location. See [Wikipedia](https://en.wikipedia.org/wiki/Air_quality_index) for more information." + }, + "globalIndex": { + "type": "number", + "format": "float", + "description": "Internationally normalized air quality rating on a scale from 0 to 300 and up, with higher numbers representing worse air quality." + }, + "dominantPollutant": { + "$ref": "#/definitions/DominantPollutant", + "description": "The pollutant with the highest concentration." + }, + "category": { + "type": "string", + "description": "One-word description of the air quality in the requested language. For example, \"Excellent\"." + }, + "categoryColor": { + "type": "string", + "description": "A unique color corresponding to the category of this air quality result." + }, + "description": { + "type": "string", + "description": "A textual explanation of this air quality result in the requested language." + } + } + }, + "Pollutant": { + "type": "object", + "description": "Detailed information about an individual pollutant. Not returned if `pollutants`=false.", + "properties": { + "type": { + "$ref": "#/definitions/PollutantType", + "description": "Type of pollutant. Please note that more may be added at any time." + }, + "name": { + "type": "string", + "description": "The name of the pollutant in English." + }, + "index": { + "type": "number", + "format": "float", + "description": "Air quality rating on a scale set by local regulating bodies. Scales can vary widely based on location. See [Wikipedia](https://en.wikipedia.org/wiki/Air_quality_index) for more information." + }, + "globalIndex": { + "type": "number", + "format": "float", + "description": "Internationally normalized air quality rating on a scale from 0 to 300 and up, with higher numbers representing worse air quality." + }, + "concentration": { + "$ref": "#/definitions/Concentration", + "description": "An object containing the number of pollutant particles per volume of air." + } + } + }, + "PollutantType": { + "type": "string", + "description": "Type of pollutant. Please note that more may be added at any time.", + "enum": [ + "CO", + "NO2", + "O3", + "PM2.5", + "PM10", + "SO2" + ], + "x-ms-enum": { + "name": "PollutantType", + "modelAsString": false, + "values": [ + { + "value": "CO", + "description": "Carbon monoxide (\"CO\")" + }, + { + "value": "NO2", + "description": "Nitrogen dioxide (\"NO2\")" + }, + { + "value": "O3", + "description": "Ozone (\"O3\")" + }, + { + "value": "PM2.5", + "description": "Particulate matter 2.5 (\"PM2.5\")" + }, + { + "value": "PM10", + "description": "Particulate matter 10 (\"PM10\")" + }, + { + "value": "SO2", + "description": "Sulfur dioxide (\"SO2\")" + } + ] + } + }, + "Concentration": { + "type": "object", + "description": "An object containing the number of pollutant particles per volume of air.", + "properties": { + "value": { + "type": "number", + "format": "float", + "description": "The numerical value indicating the concentration of the corresponding pollutant." + }, + "unit": { + "type": "string", + "description": "Type of unit for the concentration of the pollutant." + }, + "unitType": { + "type": "integer", + "description": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details." + } + } + }, + "DominantPollutant": { + "type": "string", + "description": "Type of pollutant. Please note that more may be added at any time.", + "enum": [ + "Carbon Monoxide", + "Nitrogen Dioxide", + "Ozone", + "Particulate Matter 2.5", + "Particulate Matter 10", + "Sulfur Dioxide" + ], + "x-ms-enum": { + "name": "DominantPollutant", + "modelAsString": false, + "values": [ + { + "value": "Carbon Monoxide", + "description": "Carbon monoxide (\"CO\")" + }, + { + "value": "Nitrogen Dioxide", + "description": "Nitrogen dioxide (\"NO2\")" + }, + { + "value": "Ozone", + "description": "Ozone (\"O3\")" + }, + { + "value": "Particulate Matter 2.5", + "description": "Particulate matter 2.5 (\"PM2.5\")" + }, + { + "value": "Particulate Matter 10", + "description": "Particulate matter 10 (\"PM10\")" + }, + { + "value": "Sulfur Dioxide", + "description": "Sulfur dioxide (\"SO2\")" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/readme.md b/specification/maps/data-plane/readme.md new file mode 100644 index 000000000000..b31946f65218 --- /dev/null +++ b/specification/maps/data-plane/readme.md @@ -0,0 +1,63 @@ +# Azure Maps + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for MapsClient + + +--- +## Getting Started +To build the SDK for Maps, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + +### Basic Information +These are the global settings for MapsClient. + +``` yaml +title: MapsClient +openapi-type: data-plane +tag: package-1.0-preview +``` + +### Suppression + +``` yaml +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + from: timezone.json + reason: It will break existing clients if we change the name + +``` + +### Tag: package-1.0-preview + +These settings apply only when `--tag=package-1.0-preview` is specified on the command line. + +``` yaml $(tag) == 'package-1.0-preview' +input-file: + - Microsoft.Maps/Alias/preview/1.0/alias.json + - Microsoft.Maps/Data/preview/1.0/data.json + - Microsoft.Maps/Dataset/preview/1.0/dataset.json + - Microsoft.Maps/DwgConversion/preview/1.0/dwgconversion.json + - Microsoft.Maps/FeatureState/preview/1.0/featurestate.json + - Microsoft.Maps/Feedback/preview/1.0/feedback.json + - Microsoft.Maps/Geolocation/preview/1.0/geolocation.json + - Microsoft.Maps/Mobility/preview/1.0/mobility.json + - Microsoft.Maps/Render/preview/1.0/render.json + - Microsoft.Maps/Route/preview/1.0/route.json + - Microsoft.Maps/Search/preview/1.0/search.json + - Microsoft.Maps/Spatial/preview/1.0/spatial.json + - Microsoft.Maps/Tileset/preview/1.0/tileset.json + - Microsoft.Maps/Timezone/preview/1.0/timezone.json + - Microsoft.Maps/Traffic/preview/1.0/traffic.json + - Microsoft.Maps/Weather/preview/1.0/weather.json + - Microsoft.Maps/WFS/preview/1.0/wfs.json +``` From 9ce0ebb1f9fb2d1863282710145c78f79a802f51 Mon Sep 17 00:00:00 2001 From: Phoenix He Date: Tue, 22 Sep 2020 09:43:41 +0800 Subject: [PATCH 099/164] Bugfix SDK Automation switch (#10864) --- .azure-pipelines/SDKAutomation.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.azure-pipelines/SDKAutomation.yml b/.azure-pipelines/SDKAutomation.yml index 4cd770c7861d..a567d468ab0b 100644 --- a/.azure-pipelines/SDKAutomation.yml +++ b/.azure-pipelines/SDKAutomation.yml @@ -42,8 +42,8 @@ jobs: Trenton: SDK_REPO_NAME: azure-sdk-for-trenton ${{ if eq(variables['ENABLE_RESOURCE_MANAGER_SCHEMAS'], 'true') }}: - Schema: - SDK_REPO_NAME: azure-resource-manager-schemas + Schema: + SDK_REPO_NAME: azure-resource-manager-schemas steps: - checkout: none - script: | From 480fa2a589fcbe3b53454252547f5bd441accd2a Mon Sep 17 00:00:00 2001 From: Ritesh chitlangia <60164879+riteshchitlangia1@users.noreply.github.com> Date: Mon, 21 Sep 2020 20:12:31 -0700 Subject: [PATCH 100/164] Fixing hsmUri property name and removing regex pattern for name validation, delegating it to service side validations (#10872) --- azure-rest-api-specs | 2 +- .../examples/ManagedHsm_CreateOrUpdate.json | 4 ++-- .../preview/2020-04-01-preview/examples/ManagedHsm_Get.json | 2 +- .../examples/ManagedHsm_ListByResourceGroup.json | 4 ++-- .../examples/ManagedHsm_ListBySubscription.json | 4 ++-- .../2020-04-01-preview/examples/ManagedHsm_Update.json | 4 ++-- .../preview/2020-04-01-preview/managedHsm.json | 4 +--- 7 files changed, 11 insertions(+), 13 deletions(-) diff --git a/azure-rest-api-specs b/azure-rest-api-specs index 545a9ad7563f..f83281b2fed8 160000 --- a/azure-rest-api-specs +++ b/azure-rest-api-specs @@ -1 +1 @@ -Subproject commit 545a9ad7563fe2858d08aba9ee5b8444375d47a9 +Subproject commit f83281b2fed8011962c4e91b7b0270f6391a0832 diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/examples/ManagedHsm_CreateOrUpdate.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/examples/ManagedHsm_CreateOrUpdate.json index 73da0e381c22..16c3ad45709d 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/examples/ManagedHsm_CreateOrUpdate.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/examples/ManagedHsm_CreateOrUpdate.json @@ -36,7 +36,7 @@ "enableSoftDelete": true, "softDeleteRetentionInDays": 90, "enablePurgeProtection": true, - "hsmPoolUri": null, + "hsmUri": null, "provisioningState": "Provisioning", "statusMessage": "Allocating hardware" }, @@ -64,7 +64,7 @@ "enableSoftDelete": true, "softDeleteRetentionInDays": 90, "enablePurgeProtection": true, - "hsmPoolUri": "https://westus.hsm1.managedhsm.azure.net", + "hsmUri": "https://westus.hsm1.managedhsm.azure.net", "provisioningState": "Succeeded", "statusMessage": "ManagedHsm is functional." }, diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/examples/ManagedHsm_Get.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/examples/ManagedHsm_Get.json index 09952f621ce4..9dd9972f3fac 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/examples/ManagedHsm_Get.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/examples/ManagedHsm_Get.json @@ -16,7 +16,7 @@ "enableSoftDelete": true, "softDeleteRetentionInDays": 90, "enablePurgeProtection": true, - "hsmPoolUri": "https://westus.hsm1.managedhsm.azure.net", + "hsmUri": "https://westus.hsm1.managedhsm.azure.net", "provisioningState": "Succeeded", "statusMessage": "ManagedHsm is functional." }, diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/examples/ManagedHsm_ListByResourceGroup.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/examples/ManagedHsm_ListByResourceGroup.json index 52723b08d547..7a3fe9cb1ee9 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/examples/ManagedHsm_ListByResourceGroup.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/examples/ManagedHsm_ListByResourceGroup.json @@ -17,7 +17,7 @@ "enableSoftDelete": true, "softDeleteRetentionInDays": 90, "enablePurgeProtection": true, - "hsmPoolUri": "https://westus.hsm1.managedhsm.azure.net", + "hsmUri": "https://westus.hsm1.managedhsm.azure.net", "provisioningState": "Succeeded", "statusMessage": "ManagedHsm is functional." }, @@ -43,7 +43,7 @@ "enableSoftDelete": true, "softDeleteRetentionInDays": 90, "enablePurgeProtection": true, - "hsmPoolUri": "https://westus.hsm2.managedhsm.azure.net", + "hsmUri": "https://westus.hsm2.managedhsm.azure.net", "provisioningState": "Succeeded", "statusMessage": "ManagedHsm is functional." }, diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/examples/ManagedHsm_ListBySubscription.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/examples/ManagedHsm_ListBySubscription.json index e792f31cecef..63ae1da82161 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/examples/ManagedHsm_ListBySubscription.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/examples/ManagedHsm_ListBySubscription.json @@ -16,7 +16,7 @@ "enableSoftDelete": true, "softDeleteRetentionInDays": 90, "enablePurgeProtection": true, - "hsmPoolUri": "https://westus.hsm1.managedhsm.azure.net", + "hsmUri": "https://westus.hsm1.managedhsm.azure.net", "provisioningState": "Succeeded", "statusMessage": "ManagedHsm is functional." }, @@ -42,7 +42,7 @@ "enableSoftDelete": true, "softDeleteRetentionInDays": 90, "enablePurgeProtection": true, - "hsmPoolUri": "https://westus.hsm2.managedhsm.azure.net", + "hsmUri": "https://westus.hsm2.managedhsm.azure.net", "provisioningState": "Succeeded", "statusMessage": "ManagedHsm is functional." }, diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/examples/ManagedHsm_Update.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/examples/ManagedHsm_Update.json index eaea40a4cefe..ebedabe4e003 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/examples/ManagedHsm_Update.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/examples/ManagedHsm_Update.json @@ -23,7 +23,7 @@ "enableSoftDelete": true, "softDeleteRetentionInDays": 90, "enablePurgeProtection": true, - "hsmPoolUri": "https://westus.hsm1.managedhsm.azure.net", + "hsmUri": "https://westus.hsm1.managedhsm.azure.net", "provisioningState": "Succeeded", "statusMessage": "ManagedHsm is functional." }, @@ -52,7 +52,7 @@ "enableSoftDelete": true, "softDeleteRetentionInDays": 90, "enablePurgeProtection": true, - "hsmPoolUri": "https://westus.hsm1.managedhsm.azure.net", + "hsmUri": "https://westus.hsm1.managedhsm.azure.net", "provisioningState": "Updating", "statusMessage": "ManagedHsm is updating." }, diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json index 7c8276ac052f..34462f6b4514 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json @@ -51,7 +51,6 @@ "in": "path", "required": true, "type": "string", - "pattern": "^[a-zA-Z0-9]{3,24}$", "description": "Name of the managed HSM Pool" }, { @@ -112,7 +111,6 @@ "in": "path", "required": true, "type": "string", - "pattern": "^[a-zA-Z0-9]{3,24}$", "description": "Name of the managed HSM Pool" }, { @@ -393,7 +391,7 @@ }, "description": "Array of initial administrators object ids for this managed hsm pool." }, - "hsmPoolUri": { + "hsmUri": { "type": "string", "description": "The URI of the managed hsm pool for performing operations on keys." }, From 7727c9aba722f50c5029807737c4f39bb283aa72 Mon Sep 17 00:00:00 2001 From: Tanyi Chen Date: Tue, 22 Sep 2020 11:18:22 +0800 Subject: [PATCH 101/164] compute add java readme (#10875) --- specification/compute/resource-manager/readme.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md index 9480f7c084d3..f3bf70b2dee3 100644 --- a/specification/compute/resource-manager/readme.md +++ b/specification/compute/resource-manager/readme.md @@ -786,12 +786,26 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-compute ```yaml $(java) && $(multiapi) batch: + - tag: package-2020-06-01 - tag: package-disks-2018-04 - tag: package-compute-only-2017-12 - tag: package-skus-2017-09 - tag: package-compute-2017-03 ``` +### Tag: package-2020-06-01 and java + +These settings apply only when `--tag=package-2020-06-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2020-06-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.compute.v2020_06_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/compute/mgmt-v2020_06_01 +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-disks-2018-04 and java These settings apply only when `--tag=package-disks-2018-04 --java` is specified on the command line. From 74900e122c02fcf55e46e26d6e38db497df7d28d Mon Sep 17 00:00:00 2001 From: rapatchi <31914689+rapatchi@users.noreply.github.com> Date: Tue, 22 Sep 2020 08:52:20 +0530 Subject: [PATCH 102/164] Remove Cert based auth form ListClusterUserCredentials (#10845) --- .../2020-01-01-preview/connectedClusters.json | 23 +------------------ ...ersListClusterCredentialsResultNonAad.json | 9 +++----- 2 files changed, 4 insertions(+), 28 deletions(-) diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json index 594cbe5f46d6..ef6bfc6f5488 100644 --- a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json @@ -630,8 +630,7 @@ "type": "string", "description": "The mode of client authentication.", "enum": [ - "Token", - "ClientCertificate" + "Token" ], "x-ms-enum": { "name": "AuthenticationMethod", @@ -644,31 +643,11 @@ "token": { "type": "string", "description": "Authentication token." - }, - "clientCertificate": { - "$ref": "#/definitions/AuthenticationCertificateDetails" } } } } }, - "AuthenticationCertificateDetails": { - "type": "object", - "required": [ - "certificateData", - "keyData" - ], - "properties": { - "certificateData": { - "type": "string", - "description": "Base64 encoded client certificate data." - }, - "keyData": { - "type": "string", - "description": "Base64 encoded key data." - } - } - }, "ConnectedClusterProvisioningState": { "type": "string", "description": "The current deployment state of connectedClusters.", diff --git a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/examples/ConnectedClustersListClusterCredentialsResultNonAad.json b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/examples/ConnectedClustersListClusterCredentialsResultNonAad.json index a201d8d63b6b..c453bcbf273c 100644 --- a/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/examples/ConnectedClustersListClusterCredentialsResultNonAad.json +++ b/specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2020-01-01-preview/examples/ConnectedClustersListClusterCredentialsResultNonAad.json @@ -5,12 +5,9 @@ "clusterName": "testCluster", "api-version": "2020-01-01-preview", "ClientAuthenticationDetails": { - "authenticationMethod": "ClientCertificate", + "authenticationMethod": "Token", "value": { - "clientCertificate": { - "certificateData": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO", - "keyData": "MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEChMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NTlaMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZbdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNMEsGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+zaj1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiM D6oYq+ZnfvM0n8G/Y79q8nhwvuxpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWAGy6Vf1nYi/rO+ryMO" - } + "token": "2c64fr2d61daffd8684bda773f6a478e1e5879ae15fdd3d54584cd5350c6ae139a0b7998a76f1a97e8b7ca052bb20ef4f9ce037d9a323fc161fb40b895e9b0f3" } } }, @@ -20,7 +17,7 @@ "kubeconfigs": [ { "name": "credentialName1", - "value": "YXBpVmVyc2lvbjogdjENCmNsdXN0ZXJzOg0KLSBjbHVzdGVyOg0KICAgIGNlcnRpZmljYXRlLWF1dGhvcml0eS1kYXRhOiBMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VWNGVrTkRRWEVyWjBGM1NVSkJaMGxSVTJ0dVdsWnZaekp1VmpKVmNYZEtjblZYTTFCSGVrRk9RbWRyY1docmFVYzVkekJDUVZGelJrRkVRVTRLVFZGemQwTlJXVVJXVVZGRVJYZEthbGVsSlEwbHFRVTVDWjJ0eGFHdHBSemwzTUVKQlVVVkdRVUZQUTBGbk9FRk5TVWxEUTJkTFEwRm5SVUUwV1hCNUNsUmtUMVJSU1dNdmVsaERlR3hTZWtVMF" + "value": "YXBpVmVyc2lvbjogdjEKY2x1c3RlcnM6CiAgLSBjbHVzdGVyOgogICAgICBjZXJ0aWZpY2F0ZS1hdXRob3JpdHktZGF0YTogTFMwdExTMUNSVWRKVGlCRFJWSlVTVVpKUTBGVVJTMHRMUzB0Q2sxSlNVaDJWRU5EUW1GWFowRjNTVUpCWjBsVVlYZEJRVUV5VkhWQlRYaEJhVWx5UldsQlFVRkJRVUZFV2tSQlRrSm5hM0ZvYTJsSE9YY3dRa0ZSYzBaQlJFSlFUVkZ6ZDBOUldVUldVVkZIUlhkS1ZsVjZSV1ZOUW5kSFFURlZSVU5vVFZaVVYyeHFZMjA1ZW1JeVdqQkpSVTUyWTI1Q2RtTnRSakJoVnpsMVRWTkJkMGhuV1VSV1VWRkVSWGhrVG1GWFRubGlNMDUyV201UloxVnNUa0pKUmxKTlZYbENSRkZUUVhkTlZFRmxSbmN3ZVUxRVFUUk5hbU40VFdwTmVFNVVXbUZHZHpCNVRWUkJORTFxWTNoTmFrMTRUbFJhWVUxRFdYaEtSRUZwUW1kT1ZrSkJUVTFIZVc5MVlYcG9lbGt5T1hWaWJWWnFaRU0xTUZwWVRqQk1iVVkyWkZoS2JFeHRUblppVkVORFFWTkpkMFJSV1VwTGIxcEphSFpqVGtGUlJVSkNVVUZFWjJkRlVFRkVRME5CVVc5RFoyZEZRa0ZOU0VwVU0wZEtXbWhMTm5KaVVHSm9XRWN6V21SU05HVlhNSGhSVmxVclIwTjVXSEFyY0VwRFNtUjBhbGgyTjNwMFEzTnJRV0ZaZDJobmQyMHpOMGhFVkVWamNFVlFjR1p6TDJSSFdsQktiek5vU0ZOemVGaENUMUJXYUVsVVRHZFBSa1E0YW5BMVlWZG1kVXA0WWsxUFNqZ3dObWxST0VkT1NVdEZURGM1ZDFkMVNWcG5MemhCWTBZeVNEWnJTMDlWVVhJdmVFMWFjVWx1WW5sQk1XVmhPVW8xTmpKbVNVODRUbEp2YWxORVRFUlBWRzFyWTFaYVdHcHlTaTlsYW1wclVVMUhiV0YyT1hreE9EQjJUVkZ5TTBjM2FXZ3Jkell2VFZocGVWWkpLMGxhY3pSaGVXVTJhREo0VDA5VlNYQnRWVTQ0UlhVNWIwY3ZTSGRHV2swemJHWnBkR0ZQZUhsblEydHBNV2R0VFRsd09FcHhNMVIyVVRSbU9YSnBRVWRUVFhaWWVsSlpTa2hOU2toVVRtZFZhV1pZVjFWb1VFWTJWMkZGTWxwbFdVWkdOV1ozU0U5MlVYRnFSa2tyUlZWS1JscE1kekJEUVhkRlFVRmhUME5CTjJ0M1oyZFBNVTFKU1VKQmQxbExTM2RaUWtKQlNGZGxVVWxGUVdkVFFqbEJVMEk0VVVSMlFVaFZRVGxzZVZWTU9VWXpUVU5KVlZaQ1owbE5TbEpYYW5WT1RrVjRhM3AyT1RoTlRIbEJUSHBGTjNoYVQwMUJRVUZHTUV3dlFuTjNRVUZCUWtGTlFWSnFRa1ZCYVVJMFpWSlVTMHhZY1hsM09HazFMeTlyVmtaNWNrTlhZMFZtY0VaV2NGUlZSVFIzYlVNME1rZHhSMkpCU1dkTkswVllkRWhtV0Rrd05WVklZall3Y1hKUlEzUTRibkZhTkUxamRVUjNOMlJaZVhwdGJFc3pja05SUVdSblFtTXpSVTlUTDNWaGNsSlZVM2hZY0hKVlZuVlpVVTR2ZGxZcmEyWmpiMWhQVlhOc04yMDVjMk5QZVdkQlFVRllVWFk0UjNwd1FVRkJSVUYzUWtoTlJWVkRTVVZZYTFwcWMyOUNVamhWZEc5blQwbFhWeXQyVTFOQ2NWcEViRGxIVEVRME1uWXdNR0ZXTkRVMVF6RkJhVVZCZDI1aE4zaDVWRUZJUTBJemNqVTBSSG93WnpKMVJHWktNa2ROUVdod2RuRnJiSGN5YXpka1VrMVdZM2RLZDFsS1MzZFpRa0pCUjBOT2VGVkxRa0p2ZDBkRVFVdENaMmR5UW1kRlJrSlJZMFJCVkVGTFFtZG5ja0puUlVaQ1VXTkVRV3BCSzBKbmEzSkNaMFZGUVZsSk0wWlJZMFZOVkVGMlFtbGpja0puUlVWQldVa3pSbEZwU0RKdldqRm5LemRhUVZsTVNtaFNkVUowV2pWb2FHWlVjbGxKUm1Sb1dXRlBVVmxtUTIxR1FVTkJWMUZEUVZOVmQyZFpZMGREUTNOSFFWRlZSa0ozUlVKQ1NITjNaVlJDVkVKblozSkNaMFZHUWxGamQwRnZXa2hoU0ZJd1kwUnZka3d6WkROa2VUVjBZVmRPZVdJelRuWmFibEYxV1RJNWRFd3pRbkpoVXpsMFl6Sk9kbU51UVhaVVYyeHFZMjA1ZW1JeVdqQktWRWwzVld4T1FrcFVTWGRXUlhoVVNsUkpkMUV3Uld4TmFrRjNUVk0xYW1OdVVYZEpaMWxKUzNkWlFrSlJWVWhOUVVkSFJtMW9NR1JJUVRaTWVUbDJXVE5PZDB4dE1YcGlNazU2WTBNMWFtSXlNSGRJVVZsRVZsSXdUMEpDV1VWR1N6ZFZhQ3M1WkdnNUwxRjFZM0ZKTlVFNVJHc3djMlpzTTFsVFRVRnpSMEV4VldSRWQxRkZRWGRKUlhORVFrSkNaMDVXU0ZKRlJVOXFRVFJuYUhOeFRHMXpOR015VG5aaWJUVnNXVE5SZFdSSFZucGtRelZvWlc1V2VWcFROV3BpTWpKRFIxZHpOR015VG5aaWJUVnNXVE5SZFdSSFZucGtRelZvWlc1V2VWcFROV3BpTWpCM1oySkJSMEV4VldSSWQxTkNjVVJEUW5CVVEwSnZjVU5DYmpaRFFtNUpXazVoU0ZJd1kwUnZka3d5TVhwWk0wcHpURzB4Y0ZrelNuWmpNamx0WkVNMWFtSXlNSFpqUjNSd1RESXhlbGt5T1hsalF6bHFZMjEzZGxSWGJHcGpiVGw2WWpKYU1FcFVTWGRWYkU1Q1NsUkpkMVpGZUZSS1ZFbDNVVEJGYkUxcVFYZE5VelZxWTIxNVIxTXlhREJrU0VFMlRIazVhbU50ZDNWaVYyeHFZMjA1ZW1JeVdqQk1iVTUyWWxNNWQyRXlhM1ppV0U1cVlqTktkMHd5VG5saVF6bE9ZVmRPZVdJelRuWmFibEZzVFdwQ1UxVXdSV3hOYWtKVlZFWk5iRTFxUWtSUlUxVjVUVVJCZUV4dFRubGlSRUpZUW1kT1ZraFRRVVZWUkVKUFRVVkpSME5UYzBkQlVWRkNaMnBqY1VGVVFURk5SRTFIUTBOelIwRlJWVVpDZDBsQ1JtbGtiMlJJVW5kUGFUaDJaRE5rTTB4dE1YQlpNMHAyWXpJNWJXUkROV3BpTWpCMlkwZDBjRXd5TVhwWk1qbDVZME01YW1OSVRYZERRVmxIV2pSRlRVRlJTVUpOUWpoSFFURlZaRWwzVVZsTlFtRkJSa3hXTWtSRVFWSjZjMlZUVVdzeFRYZ3hkM041UzJ0Tk5rRjBhMDFDTUVkQk1WVmtTbEZSVjAxQ1VVZERRM05IUVZGVlJrSjNUVUpDWjJkeVFtZEZSa0pSWTBSQmFrRk9RbWRyY1docmFVYzVkekJDUVZGelJrRkJUME5CWjBWQlJWZHRUVmRzWjJ3NGQzSlRUWHBQTW1Ob1pVbHZhbkZRVjBNd2FVVlVkSGRZYVVreWRqVmtWVkV5ZG01eWMydFVZM1ZzV1ZJNFExSllRemxXY0hWTU5YZDJUbEJaWlVzNWFtRjRhRXhGZW14YUt6aENTaTlhSzA5Q1NsRlBiV0k0VDIxRkwzcEVha1o1WVU5WWIzUXZNMEl3ZG5CcE9FWk1NalZNUkhGbGVuZExSeXN5VHpSVVJWQkhha1pGTmxONVRqWmlVR2d5ZG1Vck4wSTJLemQwVWpWeWVEZEtlU3RVY2pGcE9XdDBkV1p6UVhGWk5HSmtaMmd4Y2xWTGFsSkZVemRLVjNWek9HZDNVWG80YmtkSGMzaEhXbVJuU25oYVpISlJjVlZJUzNFMFlWcDJVVEZtWmtrM1RUbHVXWGhOVFM5VFNURkRlbTkxWkd0NmFHVnFSRXgzYW5vdk5UZHRaR04xYVdZck56TkpUbUZDVG5KRFprRXljemM1T1hwV1lVeDNkbXBMTlhRcmEwOVNSelI0TkZoWVpTdFphelZhV2pWQlkyMUZVa05NWnpSTGJHVkpiRFJJY3pSeGRYSkxhbGMxTjI1SFRYTnhLMHBXVGpBd2FFWXhXR1pETkZCVlpYbFJObFJPTUcxNlVGRXhia2RaZENzcmJVSTFWV053TURkWVRuVnpWR1JoTW05SGF6SlNOak5PVWsxWWIzcHRTbkYxVnlzNGRFVlVMMUJLUzNGUGFrVlNRalJXZHpOQ1IwUnZWRTVYVTNwb1dIbDRTVlp0TVhOT1dUSkJUVlpYYUdOYVkzRXpPVWRYVUc5UVp6RXpSbW80VDFsc2NFRm1SR1o2YURGaWRYWkdVbVpwVFZVME1sbHROa3c1YlROVVMwUjRlVXdyTWxKVmVESlNNbUo1VUZWTVQyVXdSMnd4T1hKelUyWlpjeTlvYjNkb1dWSnNXWEp1T0dKYVJFTkhiRFUzTDFGTWVHcEJXWFJVVWtZdlZFaHZLM1JOYTJSVmFTOWhUV2xVU0hoMlltcGtZeTlsYWxocVVISjRTbUp5UzFCVU1tUkVXRVk0ZG5aRGQzZGFRazAwUjFGWlNGaDViRFV6VTB4cU1VdHJRMjlvVlZKTkwzcDBlVEZpVTJOWWRIcE5aMDFJVmpWUFRYVkthVVZYVVhKV1NpOUhWRzlNVGxsUVNHMWxORXROY21jOUNpMHRMUzB0UlU1RUlFTkZVbFJKUmtsRFFWUkZMUzB0TFMwPQogICAgICBzZXJ2ZXI6IGh0dHBzOi8vYTljNDMzYzMtNjhlMS00NTY2LWI2MzMtODM0NzUyOWYzNjIwLms4c2Nvbm5lY3QudGVzdC5henVyZS5jb20KICAgIG5hbWU6IGNsdXN0ZXIKY29udGV4dHM6CiAgLSBjb250ZXh0OgogICAgICBjbHVzdGVyOiBjbHVzdGVyCiAgICAgIHVzZXI6IGNsdXN0ZXJVc2VyX3Rlc3RfY2x1c3RlcgogICAgbmFtZTogY2x1c3RlcgpjdXJyZW50LWNvbnRleHQ6IGNsdXN0ZXIKa2luZDogQ29uZmlnCnByZWZlcmVuY2VzOiBudWxsCnVzZXJzOgogIC0gbmFtZTogY2x1c3RlclVzZXJfdGVzdF9jbHVzdGVyCiAgICB1c2VyOgogICAgICB0b2tlbjogMmM2NGZyMmQ2MWRhZmZkODY4NGJkYTc3M2Y2YTQ3OGUxZTU4NzlhZTE1ZmRkM2Q1NDU4NGNkNTM1MGM2YWUxMzlhMGI3OTk4YTc2ZjFhOTdlOGI3Y2EwNTJiYjIwZWY0ZjljZTAzN2Q5YTMyM2ZjMTYxZmI0MGI4OTVlOWIwZjM=" } ] } From 58aa6f70372bcb3afbae8c09b77ec82939d6018b Mon Sep 17 00:00:00 2001 From: Reza Jooyandeh Date: Mon, 21 Sep 2020 21:23:25 -0700 Subject: [PATCH 103/164] Add the swagger files (#10878) * Add Communication Services Specifications * Remove Go code generation --- cSpell.json | 7 + .../communicationserviceschat.json | 1617 +++++++++++++++++ .../Conversations_ListChatReadReceipts.json | 50 + .../Conversations_SendChatReadReceipt.json | 37 + .../examples/Messages_DeleteChatMessage.json | 35 + .../examples/Messages_GetChatMessage.json | 46 + ...Messages_ListChatMessagesWithPageSize.json | 89 + .../examples/Messages_SendChatMessage.json | 46 + .../Messages_SendTypingNotification.json | 35 + .../examples/Messages_UpdateChatMessage.json | 38 + .../ThreadMembers_AddChatThreadMembers.json | 69 + .../ThreadMembers_ListChatThreadMembers.json | 50 + .../ThreadMembers_RemoveChatThreadMember.json | 35 + .../examples/Threads_CreateChatThread.json | 83 + .../examples/Threads_DeleteChatThread.json | 34 + .../examples/Threads_GetChatThread.json | 51 + .../Threads_ListChatThreadsWithPageSize.json | 70 + .../Threads_UpdateChatThreadTopic.json | 37 + .../CommunicationIdentity.json | 264 +++ .../examples/CreateIdentity.json | 14 + .../examples/DeleteIdentity.json | 11 + .../examples/IssueToken.json | 22 + .../examples/UpdateIdentity.json | 14 + .../communicationservicessms.json | 145 ++ .../2020-07-20-preview1/examples/send.json | 23 + .../communication/data-plane/readme.csharp.md | 15 + .../communication/data-plane/readme.md | 91 + .../communication/data-plane/readme.python.md | 21 + .../communication/data-plane/readme.ruby.md | 19 + .../data-plane/readme.typescript.md | 13 + 30 files changed, 3081 insertions(+) create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/communicationserviceschat.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Conversations_ListChatReadReceipts.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Conversations_SendChatReadReceipt.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_DeleteChatMessage.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_GetChatMessage.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_ListChatMessagesWithPageSize.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_SendChatMessage.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_SendTypingNotification.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_UpdateChatMessage.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/ThreadMembers_AddChatThreadMembers.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/ThreadMembers_ListChatThreadMembers.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/ThreadMembers_RemoveChatThreadMember.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Threads_CreateChatThread.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Threads_DeleteChatThread.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Threads_GetChatThread.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Threads_ListChatThreadsWithPageSize.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Threads_UpdateChatThreadTopic.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesIdentity/preview/2020-07-20-preview2/CommunicationIdentity.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesIdentity/preview/2020-07-20-preview2/examples/CreateIdentity.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesIdentity/preview/2020-07-20-preview2/examples/DeleteIdentity.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesIdentity/preview/2020-07-20-preview2/examples/IssueToken.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesIdentity/preview/2020-07-20-preview2/examples/UpdateIdentity.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesSms/preview/2020-07-20-preview1/communicationservicessms.json create mode 100644 specification/communication/data-plane/Microsoft.CommunicationServicesSms/preview/2020-07-20-preview1/examples/send.json create mode 100644 specification/communication/data-plane/readme.csharp.md create mode 100644 specification/communication/data-plane/readme.md create mode 100644 specification/communication/data-plane/readme.python.md create mode 100644 specification/communication/data-plane/readme.ruby.md create mode 100644 specification/communication/data-plane/readme.typescript.md diff --git a/cSpell.json b/cSpell.json index 794394747940..15c786ff967f 100644 --- a/cSpell.json +++ b/cSpell.json @@ -729,5 +729,12 @@ "Fpushpins" ] } + , + { + "filename": "**/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/communicationserviceschat.json", + "words": [ + "readreceipts" + ] + } ] } diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/communicationserviceschat.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/communicationserviceschat.json new file mode 100644 index 000000000000..73e83b57a414 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/communicationserviceschat.json @@ -0,0 +1,1617 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Communication Chat Service", + "description": "Azure Communication Chat Service", + "contact": { + "email": "acsdevexdisc@microsoft.com" + }, + "version": "2020-09-21-preview2" + }, + "paths": { + "/chat/threads/{chatThreadId}/readreceipts": { + "get": { + "tags": [ + "Threads" + ], + "summary": "Gets read receipts for a thread.", + "operationId": "ListChatReadReceipts", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Thread id to get the read receipts for.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The action returns the requested `ReadReceipt` resources.", + "schema": { + "$ref": "#/definitions/ReadReceiptsCollection" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get thread read receipts": { + "$ref": "./examples/Conversations_ListChatReadReceipts.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + }, + "post": { + "tags": [ + "Threads" + ], + "summary": "Sends a read receipt event to a thread, on behalf of a user.", + "operationId": "SendChatReadReceipt", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Thread id to send the read receipt event to.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Read receipt details.", + "required": true, + "schema": { + "$ref": "#/definitions/SendReadReceiptRequest" + } + } + ], + "responses": { + "201": { + "description": "Request successful." + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Send read receipt": { + "$ref": "./examples/Conversations_SendChatReadReceipt.json" + } + } + } + }, + "/chat/threads/{chatThreadId}/messages": { + "post": { + "tags": [ + "Messages" + ], + "summary": "Sends a message to a thread.", + "operationId": "SendChatMessage", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id to send the message to.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Details of the message to send.", + "required": true, + "schema": { + "$ref": "#/definitions/SendChatMessageRequest" + } + } + ], + "responses": { + "201": { + "description": "Message sent, the `Location` header contains the URL for the newly sent message.", + "schema": { + "$ref": "#/definitions/SendChatMessageResult" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Send Message": { + "$ref": "./examples/Messages_SendChatMessage.json" + } + } + }, + "get": { + "tags": [ + "Messages" + ], + "summary": "Gets a list of messages from a thread.", + "operationId": "ListChatMessages", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id of the message.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "maxPageSize", + "description": "The maximum number of messages to be returned per page.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "startTime", + "description": "The earliest point in time to get messages up to. The timestamp should be in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ChatMessagesCollection" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get messages with pagination (max page size)": { + "$ref": "./examples/Messages_ListChatMessagesWithPageSize.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/chat/threads/{chatThreadId}/messages/{chatMessageId}": { + "get": { + "tags": [ + "Messages" + ], + "summary": "Gets a message by id.", + "operationId": "GetChatMessage", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id to which the message was sent.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "chatMessageId", + "description": "The message id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The action returns a `Message` resource.", + "schema": { + "$ref": "#/definitions/ChatMessage" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get Message": { + "$ref": "./examples/Messages_GetChatMessage.json" + } + } + }, + "patch": { + "tags": [ + "Messages" + ], + "summary": "Updates a message.", + "operationId": "UpdateChatMessage", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id to which the message was sent.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "chatMessageId", + "description": "The message id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Details of the request to update the message.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateChatMessageRequest" + } + } + ], + "responses": { + "200": { + "description": "Message is successfully updated." + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Update message content": { + "$ref": "./examples/Messages_UpdateChatMessage.json" + } + } + }, + "delete": { + "tags": [ + "Messages" + ], + "summary": "Deletes a message.", + "operationId": "DeleteChatMessage", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The thread id to which the message was sent.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "chatMessageId", + "description": "The message id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Request successful." + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Delete message": { + "$ref": "./examples/Messages_DeleteChatMessage.json" + } + } + } + }, + "/chat/threads/{chatThreadId}/typing": { + "post": { + "tags": [ + "Messages" + ], + "summary": "Posts a typing event to a thread, on behalf of a user.", + "operationId": "SendTypingNotification", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Id of the thread.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful." + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Post typing event to a thread": { + "$ref": "./examples/Messages_SendTypingNotification.json" + } + } + } + }, + "/chat/threads/{chatThreadId}/members": { + "get": { + "tags": [ + "ThreadMembers" + ], + "summary": "Gets the members of a thread.", + "operationId": "ListChatThreadMembers", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Thread id to get members for.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The action returns the members of a thread.", + "schema": { + "$ref": "#/definitions/ChatThreadMembersCollection" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get thread members": { + "$ref": "./examples/ThreadMembers_ListChatThreadMembers.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + }, + "post": { + "tags": [ + "ThreadMembers" + ], + "summary": "Adds thread members to a thread. If members already exist, no change occurs.", + "operationId": "AddChatThreadMembers", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Id of the thread to add members to.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Thread members to be added to the thread.", + "required": true, + "schema": { + "$ref": "#/definitions/AddChatThreadMembersRequest" + } + } + ], + "responses": { + "207": { + "description": "Multi status response, containing the status for the thread member addition operations." + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Add thread members": { + "$ref": "./examples/ThreadMembers_AddChatThreadMembers.json" + } + } + } + }, + "/chat/threads/{chatThreadId}/members/{chatMemberId}": { + "delete": { + "tags": [ + "ThreadMembers" + ], + "summary": "Remove a member from a thread.", + "operationId": "RemoveChatThreadMember", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Thread id to remove the member from.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "chatMemberId", + "description": "Id of the thread member to remove from the thread.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Request successful." + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Remove thread member": { + "$ref": "./examples/ThreadMembers_RemoveChatThreadMember.json" + } + } + } + }, + "/chat/threads": { + "post": { + "tags": [ + "Threads" + ], + "summary": "Creates a chat thread.", + "operationId": "CreateChatThread", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Request payload for creating a chat thread.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateChatThreadRequest" + } + } + ], + "responses": { + "207": { + "description": "Multi status response, containing the status for the thread creation and the thread member addition operations.\r\nIf the thread was created successfully, `Location` header would contain the URL for the newly created thread.", + "schema": { + "$ref": "#/definitions/MultiStatusResponse" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Create chat thread": { + "$ref": "./examples/Threads_CreateChatThread.json" + } + } + }, + "get": { + "tags": [ + "Threads" + ], + "summary": "Gets the list of chat threads of a user.", + "operationId": "ListChatThreads", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "maxPageSize", + "description": "The maximum number of chat threads returned per page.", + "type": "integer", + "format": "int32" + }, + { + "in": "query", + "name": "startTime", + "description": "The earliest point in time to get chat threads up to. The timestamp should be in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "format": "date-time" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The action returns a `GetThreadsResponse` resource.", + "schema": { + "$ref": "#/definitions/ChatThreadsInfoCollection" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get threads with pagination (Max Page Size)": { + "$ref": "./examples/Threads_ListChatThreadsWithPageSize.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/chat/threads/{chatThreadId}": { + "patch": { + "tags": [ + "Threads" + ], + "summary": "Updates a thread's properties.", + "operationId": "UpdateChatThread", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "The id of the thread to update.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "Request payload for updating a chat thread.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateChatThreadRequest" + } + } + ], + "responses": { + "200": { + "description": "Thread was successfully updated." + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Update chat thread topic": { + "$ref": "./examples/Threads_UpdateChatThreadTopic.json" + } + } + }, + "get": { + "tags": [ + "Threads" + ], + "summary": "Gets a chat thread.", + "operationId": "GetChatThread", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Thread id to get.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The action returns a `Thread` resource.", + "schema": { + "$ref": "#/definitions/ChatThread" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get chat thread": { + "$ref": "./examples/Threads_GetChatThread.json" + } + } + }, + "delete": { + "tags": [ + "Threads" + ], + "summary": "Deletes a thread.", + "operationId": "DeleteChatThread", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "chatThreadId", + "description": "Thread id to delete.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Request successful." + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/Error" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Delete chat thread": { + "$ref": "./examples/Threads_DeleteChatThread.json" + } + } + } + } + }, + "definitions": { + "ReadReceipt": { + "description": "A read receipt indicates the time a chat message was read by a recipient.", + "type": "object", + "properties": { + "senderId": { + "description": "Read receipt sender id.", + "type": "string", + "readOnly": true, + "example": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + }, + "chatMessageId": { + "description": "Id for the chat message that has been read. This id is generated by the server.", + "type": "string", + "readOnly": true, + "example": "1591137790240" + }, + "readOn": { + "format": "date-time", + "description": "Read receipt timestamp. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "readOnly": true, + "example": "2020-10-30T10:50:50Z" + } + } + }, + "ReadReceiptsCollection": { + "type": "object", + "properties": { + "value": { + "description": "Collection of read receipts.", + "type": "array", + "items": { + "$ref": "#/definitions/ReadReceipt" + }, + "readOnly": true + }, + "nextLink": { + "description": "If there are more read receipts that can be retrieved, the next link will be populated.", + "type": "string", + "readOnly": true + } + } + }, + "Error": { + "type": "object", + "properties": { + "code": { + "type": "string", + "readOnly": true + }, + "message": { + "type": "string", + "readOnly": true + }, + "target": { + "type": "string", + "readOnly": true + }, + "innerErrors": { + "type": "array", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true + } + } + }, + "SendReadReceiptRequest": { + "description": "Request payload for sending a read receipt.", + "required": [ + "chatMessageId" + ], + "type": "object", + "properties": { + "chatMessageId": { + "description": "Id of the latest chat message read by the user.", + "type": "string", + "example": "1592435762364" + } + } + }, + "ChatMessagePriority": { + "description": "The chat message priority.", + "enum": [ + "Normal", + "High" + ], + "type": "string", + "x-ms-enum": { + "name": "ChatMessagePriority", + "modelAsString": true + } + }, + "SendChatMessageRequest": { + "description": "Details of the message to send.", + "required": [ + "content" + ], + "type": "object", + "properties": { + "priority": { + "$ref": "#/definitions/ChatMessagePriority" + }, + "content": { + "description": "Chat message content.", + "type": "string", + "example": "Come one guys, lets go for lunch together." + }, + "senderDisplayName": { + "description": "The display name of the chat message sender. This property is used to populate sender name for push notifications.", + "type": "string", + "example": "Bob Admin" + } + } + }, + "SendChatMessageResult": { + "description": "Result of the send message operation.", + "type": "object", + "properties": { + "id": { + "description": "A server-generated message id.", + "type": "string", + "readOnly": true, + "example": "123456789" + } + } + }, + "ChatMessage": { + "type": "object", + "properties": { + "id": { + "description": "The id of the chat message. This id is server generated.", + "type": "string", + "readOnly": true, + "example": "123456789" + }, + "type": { + "description": "Type of the chat message.\r\n \r\nPossible values:\r\n - Text\r\n - ThreadActivity/TopicUpdate\r\n - ThreadActivity/AddMember\r\n - ThreadActivity/DeleteMember", + "type": "string", + "example": "Text" + }, + "priority": { + "$ref": "#/definitions/ChatMessagePriority" + }, + "version": { + "description": "Version of the chat message.", + "type": "string", + "readOnly": true + }, + "content": { + "description": "Content of the chat message.", + "type": "string", + "example": "Come one guys, lets go for lunch together." + }, + "senderDisplayName": { + "description": "The display name of the chat message sender. This property is used to populate sender name for push notifications.", + "type": "string", + "example": "Jane" + }, + "createdOn": { + "format": "date-time", + "description": "The timestamp when the chat message arrived at the server. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "readOnly": true, + "example": "2020-10-30T10:50:50Z" + }, + "senderId": { + "description": "The id of the chat message sender.", + "type": "string", + "readOnly": true, + "example": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + }, + "deletedOn": { + "format": "date-time", + "description": "The timestamp when the chat message was deleted. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + }, + "editedOn": { + "format": "date-time", + "description": "The timestamp when the chat message was edited. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + } + } + }, + "ChatMessagesCollection": { + "description": "Collection of chat messages for a particular chat thread.", + "type": "object", + "properties": { + "value": { + "description": "Collection of chat messages.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatMessage" + }, + "readOnly": true + }, + "nextLink": { + "description": "If there are more chat messages that can be retrieved, the next link will be populated.", + "type": "string", + "readOnly": true + } + } + }, + "UpdateChatMessageRequest": { + "type": "object", + "properties": { + "content": { + "description": "Chat message content.", + "type": "string", + "example": "Let's go for lunch together." + }, + "priority": { + "$ref": "#/definitions/ChatMessagePriority" + } + } + }, + "ChatThreadMember": { + "description": "A member of the chat thread.", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "The id of the chat thread member in the format `8:acs:ResourceId_AcsUserId`.", + "type": "string", + "example": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + }, + "displayName": { + "description": "Display name for the chat thread member.", + "type": "string", + "example": "Bob" + }, + "shareHistoryTime": { + "format": "date-time", + "description": "Time from which the chat history is shared with the member. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "example": "2020-10-30T10:50:50Z" + } + } + }, + "ChatThreadMembersCollection": { + "description": "Collection of thread members belong to a particular thread.", + "type": "object", + "properties": { + "value": { + "description": "Chat thread members.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatThreadMember" + } + }, + "nextLink": { + "description": "If there are more chat threads that can be retrieved, the next link will be populated.", + "type": "string", + "readOnly": true + } + } + }, + "AddChatThreadMembersRequest": { + "description": "Thread members to be added to the thread.", + "required": [ + "members" + ], + "type": "object", + "properties": { + "members": { + "description": "Members to add to a chat thread.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatThreadMember" + } + } + } + }, + "CreateChatThreadRequest": { + "description": "Request payload for creating a chat thread.", + "required": [ + "members", + "topic" + ], + "type": "object", + "properties": { + "topic": { + "description": "The chat thread topic.", + "type": "string", + "example": "Lunch Thread" + }, + "members": { + "description": "Members to be added to the chat thread.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatThreadMember" + } + } + } + }, + "IndividualStatusResponse": { + "type": "object", + "properties": { + "id": { + "description": "Identifies the resource to which the individual status corresponds.", + "type": "string", + "readOnly": true + }, + "statusCode": { + "format": "int32", + "description": "The status code of the resource operation.\r\n \r\nPossible values include:\r\n 200 for a successful update or delete,\r\n 201 for successful creation,\r\n 400 for a malformed input,\r\n 403 for lacking permission to execute the operation,\r\n 404 for resource not found.", + "type": "integer", + "readOnly": true + }, + "message": { + "description": "The message explaining why the operation failed for the resource identified by the key; null if the operation succeeded.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Identifies the type of the resource to which the individual status corresponds.", + "type": "string", + "readOnly": true + } + } + }, + "MultiStatusResponse": { + "type": "object", + "properties": { + "multipleStatus": { + "description": "The list of status information for each resource in the request.", + "type": "array", + "items": { + "$ref": "#/definitions/IndividualStatusResponse" + }, + "readOnly": true + } + } + }, + "ChatThreadInfo": { + "type": "object", + "properties": { + "id": { + "description": "Chat thread id.", + "type": "string", + "readOnly": true, + "example": "19:uni01_uy5ucb66ugp3lrhe7pxso6xx4hsmm3dl6eyjfefv2n6x3rrurpea@thread.v2" + }, + "topic": { + "description": "Chat thread topic.", + "type": "string", + "example": "Lunch Chat thread" + }, + "isDeleted": { + "description": "Flag if a chat thread is soft deleted.", + "type": "boolean", + "example": false + }, + "lastMessageReceivedOn": { + "format": "date-time", + "description": "The timestamp when the last message arrived at the server. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "readOnly": true, + "example": "2020-10-30T10:50:50Z" + } + } + }, + "ChatThreadsInfoCollection": { + "description": "Collection of chat threads.", + "type": "object", + "properties": { + "value": { + "description": "Collection of chat threads.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatThreadInfo" + }, + "readOnly": true + }, + "nextLink": { + "description": "If there are more chat threads that can be retrieved, the next link will be populated.", + "type": "string", + "readOnly": true + } + } + }, + "UpdateChatThreadRequest": { + "type": "object", + "properties": { + "topic": { + "description": "Chat thread topic.", + "type": "string", + "example": "Lunch Thread" + } + } + }, + "ChatThread": { + "type": "object", + "properties": { + "id": { + "description": "Chat thread id.", + "type": "string", + "readOnly": true, + "example": "19:uni01_uy5ucb66ugp3lrhe7pxso6xx4hsmm3dl6eyjfefv2n6x3rrurpea@thread.v2" + }, + "topic": { + "description": "Chat thread topic.", + "type": "string", + "example": "Lunch Chat thread" + }, + "createdOn": { + "format": "date-time", + "description": "The timestamp when the chat thread was created. The timestamp is in ISO8601 format: `yyyy-MM-ddTHH:mm:ssZ`.", + "type": "string", + "readOnly": true, + "example": "2020-10-30T10:50:50Z" + }, + "createdBy": { + "description": "Id of the chat thread owner.", + "type": "string", + "readOnly": true, + "example": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + }, + "members": { + "description": "Chat thread members.", + "type": "array", + "items": { + "$ref": "#/definitions/ChatThreadMember" + } + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "in": "query", + "name": "api-version", + "description": "Version of API to invoke.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Endpoint": { + "in": "path", + "name": "endpoint", + "description": "The endpoint of the Azure Communication resource.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "Authorization": { + "type": "apiKey", + "name": "Authorization", + "in": "header", + "description": "An ACS (Azure Communication Services) user access token." + } + }, + "security": [ + { + "Authorization": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Conversations_ListChatReadReceipts.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Conversations_ListChatReadReceipts.json new file mode 100644 index 000000000000..44d3ad9bd31e --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Conversations_ListChatReadReceipts.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-09-21-preview2", + "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "senderId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "chatMessageId": "1591137790240", + "readOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "senderId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c00a", + "chatMessageId": "1591768249318", + "readOn": "2020-06-06T05:55:41.6460000Z" + } + ], + "nextLink": null + } + }, + "401": { + "body": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + }, + "403": { + "body": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + }, + "429": { + "body": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + }, + "503": { + "body": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Conversations_SendChatReadReceipt.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Conversations_SendChatReadReceipt.json new file mode 100644 index 000000000000..45ab2f0680bb --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Conversations_SendChatReadReceipt.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-09-21-preview2", + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "body": { + "chatMessageId": "1591137790240" + } + }, + "responses": { + "201": {}, + "401": { + "body": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + }, + "403": { + "body": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + }, + "429": { + "body": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + }, + "503": { + "body": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_DeleteChatMessage.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_DeleteChatMessage.json new file mode 100644 index 000000000000..00551b5f9d65 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_DeleteChatMessage.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-09-21-preview2", + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "chatMessageId": "1591768249318" + }, + "responses": { + "204": {}, + "401": { + "body": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + }, + "403": { + "body": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + }, + "429": { + "body": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + }, + "503": { + "body": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_GetChatMessage.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_GetChatMessage.json new file mode 100644 index 000000000000..70d7dacb2aac --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_GetChatMessage.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-09-21-preview2", + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "chatMessageId": "1591768249318" + }, + "responses": { + "200": { + "body": { + "id": "1591768249318", + "type": "Text", + "version": "1599016601134", + "priority": "Normal", + "content": "Let's head out for lunch in 15 minutes.", + "senderDisplayName": "Jane", + "createdOn": "2020-06-10T05:50:49.3180000Z", + "senderId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + } + }, + "401": { + "body": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + }, + "403": { + "body": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + }, + "429": { + "body": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + }, + "503": { + "body": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_ListChatMessagesWithPageSize.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_ListChatMessagesWithPageSize.json new file mode 100644 index 000000000000..0323cbabc954 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_ListChatMessagesWithPageSize.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-09-21-preview2", + "chatThreadId": "19:453dafb77b26481ea2e73bcada0324af@thread.v2", + "maxPageSize": 5 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "1593107077690", + "type": "Text", + "priority": "Normal", + "version": "1593107077683", + "content": "So where should we get lunch from today?", + "senderDisplayName": "Jane", + "createdOn": "2020-06-25T17:44:37.6830000Z", + "senderId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + }, + { + "id": "1593107077683", + "type": "Text", + "priority": "Normal", + "version": "1593107077683", + "content": "Let's use this chat to decide what to get for lunch today.", + "senderDisplayName": "Jane", + "createdOn": "2020-06-25T17:44:37.6830000Z", + "senderId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + }, + { + "id": "1593107046498", + "type": "Text", + "priority": "Normal", + "version": "1593107046498", + "content": "Good morning everyone!", + "senderDisplayName": "Jane", + "createdOn": "2020-06-25T17:44:06.4980000Z", + "senderId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b" + }, + { + "id": "1593106976785", + "type": "ThreadActivity/TopicUpdate", + "priority": "Normal", + "version": "1593106976785", + "content": "15931069767858:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10bLunch", + "createdOn": "2020-06-25T17:42:56.7850000Z", + "senderId": "19:453dafb77b26481ea2e73bcada0324af@thread.v2" + }, + { + "id": "1593106976753", + "type": "ThreadActivity/AddMember", + "priority": "Normal", + "version": "1593106976753", + "content": "15931069767538:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b15931069765668:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b8:acs:29d8ac59-6011-44dc-87c0-1f9f93dbc713_2a711a-6c8ffcdc418:acs:29d8ac59-6011-44dc-87c0-1f9f93dbc713_2a711a-6c8ffcdc418:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", + "createdOn": "2020-06-25T17:42:56.7530000Z", + "senderId": "19:453dafb77b26481ea2e73bcada0324af@thread.v2" + } + ], + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/messages?syncState=3e4700000031393a756e6930315f7a626e68336e74326466756666657a6333736f7837646f67377766686b36793571653272776c6e66686c68647a69726968647071407468726561642e763201451fe6e77201000004357fea72010000&startTime=0&maxPageSize=5&api-version=2020-09-21-preview2" + } + }, + "401": { + "body": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + }, + "403": { + "body": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + }, + "429": { + "body": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + }, + "503": { + "body": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_SendChatMessage.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_SendChatMessage.json new file mode 100644 index 000000000000..df0395bea381 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_SendChatMessage.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-09-21-preview2", + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "body": { + "priority": "Normal", + "content": "Let's head out for lunch in 15 minutes.", + "senderDisplayName": "Jane" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://contoso.westus.communications.azure.com/chat/threads/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/messages/1593072104708" + }, + "body": { + "id": "1593072104708" + } + }, + "401": { + "body": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + }, + "403": { + "body": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + }, + "429": { + "body": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + }, + "503": { + "body": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_SendTypingNotification.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_SendTypingNotification.json new file mode 100644 index 000000000000..6435d0e29153 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_SendTypingNotification.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "x-skypetoken": "token", + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-09-21-preview2", + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345" + }, + "responses": { + "200": {}, + "401": { + "body": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + }, + "403": { + "body": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + }, + "429": { + "body": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + }, + "503": { + "body": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_UpdateChatMessage.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_UpdateChatMessage.json new file mode 100644 index 000000000000..f77e9c5e8dd9 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Messages_UpdateChatMessage.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-09-21-preview2", + "chatThreadId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "chatMessageId": "1591768249318", + "body": { + "content": "Updated message content" + } + }, + "responses": { + "200": {}, + "401": { + "body": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + }, + "403": { + "body": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + }, + "429": { + "body": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + }, + "503": { + "body": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/ThreadMembers_AddChatThreadMembers.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/ThreadMembers_AddChatThreadMembers.json new file mode 100644 index 000000000000..17cc78cfb022 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/ThreadMembers_AddChatThreadMembers.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-09-21-preview2", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", + "body": { + "members": [ + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "displayName": "Alex", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "displayName": "Peter", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", + "displayName": "Rama", + "shareHistoryTime": "2020-06-06T05:55:41Z" + } + ] + } + }, + "responses": { + "207": { + "multipleStatus": [ + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "statusCode": 403, + "message": "Permissions check failed" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "statusCode": 201 + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", + "statusCode": 201 + } + ] + }, + "401": { + "body": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + }, + "403": { + "body": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + }, + "429": { + "body": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + }, + "503": { + "body": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/ThreadMembers_ListChatThreadMembers.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/ThreadMembers_ListChatThreadMembers.json new file mode 100644 index 000000000000..2f7522e9e0a1 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/ThreadMembers_ListChatThreadMembers.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-09-21-preview2", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "displayName": "Jane", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "displayName": "Alex", + "shareHistoryTime": "2020-06-06T05:55:41Z" + } + ], + "nextLink": null + } + }, + "401": { + "body": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + }, + "403": { + "body": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + }, + "429": { + "body": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + }, + "503": { + "body": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/ThreadMembers_RemoveChatThreadMember.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/ThreadMembers_RemoveChatThreadMember.json new file mode 100644 index 000000000000..e4f34c5ab80d --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/ThreadMembers_RemoveChatThreadMember.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-09-21-preview2", + "chatThreadId": "19:f2167429acf6482880c6b7790a9086c1@thread.v2", + "chatMemberId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a" + }, + "responses": { + "204": {}, + "401": { + "body": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + }, + "403": { + "body": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + }, + "429": { + "body": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + }, + "503": { + "body": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Threads_CreateChatThread.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Threads_CreateChatThread.json new file mode 100644 index 000000000000..f2e8c4bb469c --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Threads_CreateChatThread.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-09-21-preview2", + "body": { + "topic": "Lunch", + "members": [ + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "displayName": "Jane" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "displayName": "Alex" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", + "displayName": "Bob" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "displayName": "Peter" + } + ] + } + }, + "responses": { + "207": { + "headers": { + "Location": "https://contoso.westus.communications.azure.com/chat/threads/19%3Auni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" + }, + "body": { + "multipleStatus": [ + { + "id": "19:b355e41860604e7dacd072d586f47818@thread.v2", + "statusCode": 201 + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "statusCode": 201 + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "statusCode": 201 + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c", + "statusCode": 201 + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "statusCode": 403, + "message": "Permissions check failed" + } + ] + } + }, + "401": { + "body": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + }, + "403": { + "body": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + }, + "429": { + "body": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + }, + "503": { + "body": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Threads_DeleteChatThread.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Threads_DeleteChatThread.json new file mode 100644 index 000000000000..8d2b13efb17a --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Threads_DeleteChatThread.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-09-21-preview2", + "chatThreadId": "19:9525281ac1f947fc884bcee1a9f983c2@thread.v2" + }, + "responses": { + "204": {}, + "401": { + "body": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + }, + "403": { + "body": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + }, + "429": { + "body": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + }, + "503": { + "body": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Threads_GetChatThread.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Threads_GetChatThread.json new file mode 100644 index 000000000000..2bcaff7565cb --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Threads_GetChatThread.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-09-21-preview2", + "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2" + }, + "responses": { + "200": { + "body": { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Lunch", + "createdOn": "2020-06-06T05:55:41.6460000Z", + "createdBy": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "members": [ + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a", + "shareHistoryTime": "2020-06-06T05:55:41Z" + }, + { + "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b", + "shareHistoryTime": "2020-06-06T05:55:41Z" + } + ] + } + }, + "401": { + "body": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + }, + "403": { + "body": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + }, + "429": { + "body": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + }, + "503": { + "body": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Threads_ListChatThreadsWithPageSize.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Threads_ListChatThreadsWithPageSize.json new file mode 100644 index 000000000000..07a5dc602c3d --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Threads_ListChatThreadsWithPageSize.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-09-21-preview2", + "maxmaxPageSize": 5 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "topic": "Chat with Samantha", + "isDeleted": false, + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:a0dfe5fc10e04a7f8d8a64d455f4196d@thread.v2", + "topic": "Presentation Brainstorming", + "isDeleted": false, + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:uni01_n242d2bzammtwxiib7pbjtozeevjqzavzn654ku3dajocexfo2na@thread.v2", + "topic": "Chat with Alex", + "isDeleted": false, + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:0062022a28be4e0983734f7e45cd8566@thread.v2", + "topic": "Lunch", + "isDeleted": false, + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + }, + { + "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpe@thread.v2", + "topic": "Chat with Bob", + "isDeleted": false, + "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z" + } + ], + "nextLink": "https://contoso.westus.communications.azure.com/chat/threads?syncState=W3sic3RhcnQiOiIyMDIwLTA2LTIzVDIzOjMyOjQ3LjMwNSswMDowMCIsImVuZCI6IjIwMjAtMDYtMjVUMDY6NTY6MjMuNjk2KzAwOjAwIn0seyJzdGFydCI6IjE5NzAtMDEtMDFUMDA6MDA6MDArMDA6MDAiLCJlbmQiOiIxOTcwLTAxLTAxVDAwOjAwOjAwKzAwOjAwIn1d&api-version=2020-09-21-preview2&maxmaxPageSize=5" + } + }, + "401": { + "body": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + }, + "403": { + "body": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + }, + "429": { + "body": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + }, + "503": { + "body": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Threads_UpdateChatThreadTopic.json b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Threads_UpdateChatThreadTopic.json new file mode 100644 index 000000000000..fc22cf010c46 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/examples/Threads_UpdateChatThreadTopic.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "endpoint": "https://contoso.westus.communications.azure.com", + "api-version": "2020-09-21-preview2", + "chatThreadId": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2", + "body": { + "topic": "Updated Thread Topic" + } + }, + "responses": { + "200": {}, + "401": { + "body": { + "code": "Unauthorized", + "message": "Request is not authorized." + } + }, + "403": { + "body": { + "code": "Forbidden", + "message": "User is not allowed to perform specified action." + } + }, + "429": { + "body": { + "code": "TooManyRequests", + "message": "Rate limit exceeded." + } + }, + "503": { + "body": { + "code": "ServiceUnavailable", + "message": "The server is currently unable to handle the request." + } + } + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesIdentity/preview/2020-07-20-preview2/CommunicationIdentity.json b/specification/communication/data-plane/Microsoft.CommunicationServicesIdentity/preview/2020-07-20-preview2/CommunicationIdentity.json new file mode 100644 index 000000000000..c87ad2bfe5c3 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesIdentity/preview/2020-07-20-preview2/CommunicationIdentity.json @@ -0,0 +1,264 @@ +{ + "swagger": "2.0", + "info": { + "title": "CommunicationIdentityClient", + "description": "Azure Communication Identity Service", + "contact": { + "email": "acsdevexdisc@microsoft.com" + }, + "version": "2020-07-20-preview2" + }, + "paths": { + "/identities": { + "post": { + "tags": [ + "Identity" + ], + "summary": "Create a new identity.", + "operationId": "CommunicationIdentity_Create", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "api-version", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK - Returns the created identity.", + "schema": { + "$ref": "#/definitions/CommunicationIdentity" + } + } + }, + "x-ms-examples": { + "Create Identity": { + "$ref": "./examples/CreateIdentity.json" + } + } + } + }, + "/identities/{id}": { + "delete": { + "tags": [ + "Identity" + ], + "summary": "Delete the identity, revoke all tokens of the identity and delete all associated data.", + "operationId": "CommunicationIdentity_Delete", + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Identifier of the identity to be deleted.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "Success" + } + }, + "x-ms-examples": { + "Delete Identity": { + "$ref": "./examples/DeleteIdentity.json" + } + } + }, + "patch": { + "tags": [ + "Identity" + ], + "summary": "Update an Identity.", + "operationId": "CommunicationIdentity_Update", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Identifier of the identity.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "body", + "description": "The properties of the identity to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CommunicationIdentityUpdateRequest" + } + } + ], + "responses": { + "204": { + "description": "Success" + } + }, + "x-ms-examples": { + "Update Identity": { + "$ref": "./examples/UpdateIdentity.json" + } + } + } + }, + "/identities/{id}/token": { + "post": { + "tags": [ + "Token" + ], + "summary": "Generate a new token for an identity.", + "operationId": "CommunicationIdentity_IssueToken", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Identifier of the identity to issue token for.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "api-version", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "body", + "description": "Requesting scopes for the new token.", + "required": true, + "schema": { + "$ref": "#/definitions/CommunicationTokenRequest" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CommunicationIdentityToken" + } + } + }, + "x-ms-examples": { + "Issue Token": { + "$ref": "./examples/IssueToken.json" + } + } + } + } + }, + "definitions": { + "CommunicationIdentity": { + "description": "A communication identity.", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "Identifier of the identity.", + "type": "string" + } + } + }, + "CommunicationIdentityUpdateRequest": { + "type": "object", + "properties": { + "tokensValidFrom": { + "format": "date-time", + "description": "All tokens that are issued prior to this time will be revoked.", + "type": "string" + } + } + }, + "CommunicationTokenRequest": { + "required": [ + "scopes" + ], + "type": "object", + "properties": { + "scopes": { + "description": "List of scopes attached to the token.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "CommunicationIdentityToken": { + "required": [ + "expiresOn", + "id", + "token" + ], + "type": "object", + "properties": { + "id": { + "description": "Identifier of the identity owning the token.", + "type": "string" + }, + "token": { + "description": "The token issued for the identity.", + "type": "string" + }, + "expiresOn": { + "format": "date-time", + "description": "The expiry time of the token.", + "type": "string" + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "description": "Auth and Identity endpoint", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + ] + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesIdentity/preview/2020-07-20-preview2/examples/CreateIdentity.json b/specification/communication/data-plane/Microsoft.CommunicationServicesIdentity/preview/2020-07-20-preview2/examples/CreateIdentity.json new file mode 100644 index 000000000000..a7a69a592539 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesIdentity/preview/2020-07-20-preview2/examples/CreateIdentity.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-07-20-preview2", + "content-type": "application/json", + "endpoint": "https://contoso.communication.azure.com/identities" + }, + "responses": { + "200": { + "body": { + "id": "8:acs:2dee53b4-368b-45b4-ab52-8493fb117652_00000005-14a2-493b-8a72-5a3a0d000081" + } + } + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesIdentity/preview/2020-07-20-preview2/examples/DeleteIdentity.json b/specification/communication/data-plane/Microsoft.CommunicationServicesIdentity/preview/2020-07-20-preview2/examples/DeleteIdentity.json new file mode 100644 index 000000000000..1a7eec13edb8 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesIdentity/preview/2020-07-20-preview2/examples/DeleteIdentity.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2020-07-20-preview2", + "content-type": "application/json", + "id": "8:acs:2dee53b4-368b-45b4-ab52-8493fb117652_00000005-14a2-493b-8a72-5a3a0d000081", + "endpoint": "https://contoso.communication.azure.com/identities" + }, + "responses": { + "204": {} + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesIdentity/preview/2020-07-20-preview2/examples/IssueToken.json b/specification/communication/data-plane/Microsoft.CommunicationServicesIdentity/preview/2020-07-20-preview2/examples/IssueToken.json new file mode 100644 index 000000000000..b63e6b9c2264 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesIdentity/preview/2020-07-20-preview2/examples/IssueToken.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-07-20-preview2", + "content-type": "application/merge-patch+json", + "id": "8:acs:2dee53b4-368b-45b4-ab52-8493fb117652_00000005-14a2-493b-8a72-5a3a0d000081", + "body": { + "scopes": [ + "chat" + ] + }, + "endpoint": "https://contoso.communication.azure.com/identities/" + }, + "responses": { + "200": { + "body": { + "id": "8:acs:2dee53b4-368b-45b4-ab52-8493fb117652_00000005-14a2-493b-8a72-5a3a0d000081", + "token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjEwMl9pbnQiLCJ0eXAiOiJKV1QifQ.eyJza3lwZWlkIjoiYWNzOjJkZWU1M2I0LTM2OGItNDViNC1hYjUyLTg0OTNmYjExNzY1Ml8wMDAwMDAwNS0xNGIwLWIwM2QtY2NjYy1iYWExZTEzYzAwMDEiLCJzY3AiOjE3OTIsImNzaSI6IjE1OTk2ODc1NzkiLCJpYXQiOjE1OTk2ODc1NzksImV4cCI6MTU5OTc3Mzk3OSwiYWNzU2NvcGUiOiJjaGF0IiwicmVzb3VyY2VJZCI6IjJkZWU1M2I0LTM2OGItNDViNC1hYjUyLTg0OTNmYjExNzY1MiJ9.S8Pryk7MVe0L8_KcTOjsGaU_6FXmcupVS8X73kJ2FW1CAotyJZb0YUoft_iXkbnTpJ3XK01SyhaXHcT48tXTsi1NcvyUqDk9u4rVKZkheA2F4ddLKYckO-RBw4mCHxlwsuiALNesR0MruhgiOSE1F0h_djDn6oKewSkyfd1FTWVqReeY1oIY4U0yi7_B8u3zNPiEFlv-Aqe4y1ISqi0009lt2u3EApjQ6pOIP8Jk9HAqbINwi2_lN5VAxUgK1XqvMBsiBmiB7fEfh-dNxB9tgH-tTGZQfRSprkjg6_KBVdYY7DTSr80J7Qez4JjoHwQ22DYKF8mleuFOysbTlLD0AA", + "expiresOn": "2020-09-10T21:39:39.3244584+00:00" + } + } + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesIdentity/preview/2020-07-20-preview2/examples/UpdateIdentity.json b/specification/communication/data-plane/Microsoft.CommunicationServicesIdentity/preview/2020-07-20-preview2/examples/UpdateIdentity.json new file mode 100644 index 000000000000..c6ee654739d9 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesIdentity/preview/2020-07-20-preview2/examples/UpdateIdentity.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-07-20-preview2", + "content-type": "application/merge-patch+json", + "id": "8:acs:2dee53b4-368b-45b4-ab52-8493fb117652_00000005-14a2-493b-8a72-5a3a0d000081", + "endpoint": "https://contoso.communication.azure.com/identities/", + "body": { + "tokensValidFrom": "2017-04-17T05:04:18.070Z" + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesSms/preview/2020-07-20-preview1/communicationservicessms.json b/specification/communication/data-plane/Microsoft.CommunicationServicesSms/preview/2020-07-20-preview1/communicationservicessms.json new file mode 100644 index 000000000000..0d989bdbeee6 --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesSms/preview/2020-07-20-preview1/communicationservicessms.json @@ -0,0 +1,145 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Communication SMS Service", + "description": "Azure Communication SMS Service", + "contact": { + "email": "acsdevexdisc@microsoft.com" + }, + "version": "2020-07-20-preview1" + }, + "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": { + "/sms": { + "post": { + "tags": [ + "Sms" + ], + "summary": "Sends a SMS message from a phone number that belongs to the authenticated account.", + "operationId": "Sms_Send", + "x-ms-examples": { + "SuccessfulSend": { + "$ref": "./examples/send.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "SendMessageRequest", + "description": "Represents the body of the send message request.", + "required": true, + "schema": { + "$ref": "#/definitions/SendMessageRequest" + } + }, + { + "name": "api-version", + "in": "query", + "description": "Version of API to invoke.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "SMS message is successfully scheduled for sending.", + "schema": { + "$ref": "#/definitions/SendSmsResponse" + } + } + } + } + } + }, + "definitions": { + "SendSmsOptions": { + "description": "Optional configuration for sending SMS messages", + "type": "object", + "properties": { + "enableDeliveryReport": { + "description": "Enable this flag to receive a delivery report for this message on the Azure Resource EventGrid", + "type": "boolean" + } + } + }, + "SendMessageRequest": { + "description": "Represents the properties of a send message request.", + "required": [ + "message", + "to", + "from" + ], + "type": "object", + "properties": { + "from": { + "description": "The sender's phone number in E.164 format that is owned by the authenticated account.", + "type": "string" + }, + "to": { + "description": "The recipients' phone number in E.164 format. In this version, only one recipient in the list is supported.", + "maxLength": 1, + "minLength": 1, + "type": "array", + "items": { + "type": "string" + } + }, + "message": { + "description": "The contents of the message that will be sent to the recipient. The allowable content is defined by RFC 5724.", + "maxLength": 2048, + "minLength": 0, + "type": "string" + }, + "sendSmsOptions": { + "$ref": "#/definitions/SendSmsOptions" + } + } + }, + "SendSmsResponse": { + "description": "Response for a successful send Sms request.", + "type": "object", + "properties": { + "messageId": { + "description": "The identifier of the outgoing SMS message", + "type": "string" + } + } + } + }, + "parameters": { + "Endpoint": { + "in": "path", + "name": "endpoint", + "description": "The endpoint of the Azure Communication resource.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + } +} diff --git a/specification/communication/data-plane/Microsoft.CommunicationServicesSms/preview/2020-07-20-preview1/examples/send.json b/specification/communication/data-plane/Microsoft.CommunicationServicesSms/preview/2020-07-20-preview1/examples/send.json new file mode 100644 index 000000000000..306feda3416f --- /dev/null +++ b/specification/communication/data-plane/Microsoft.CommunicationServicesSms/preview/2020-07-20-preview1/examples/send.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "SendMessageRequest": { + "from": "+18001110000", + "to": [ + "+18002220000" + ], + "message": "Hello world!", + "sendSmsOptions": { + "enableDeliveryReport": true + } + }, + "api-version": "2020-07-20-preview1", + "endpoint": "https://contoso.communication.azure.com/" + }, + "responses": { + "200": { + "body": { + "messageId": "Outgoing_20200610203725bfd4ba70-70bf-4f77-925d-c0bdb5161bb3" + } + } + } +} diff --git a/specification/communication/data-plane/readme.csharp.md b/specification/communication/data-plane/readme.csharp.md new file mode 100644 index 000000000000..2efd3715cdc3 --- /dev/null +++ b/specification/communication/data-plane/readme.csharp.md @@ -0,0 +1,15 @@ +## C + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.CommunicationServices + output-folder: $(csharp-sdks-folder)/communicationservices/management/Microsoft.CommunicationServices/GeneratedProtocol +``` diff --git a/specification/communication/data-plane/readme.md b/specification/communication/data-plane/readme.md new file mode 100644 index 000000000000..e4d7480f69cd --- /dev/null +++ b/specification/communication/data-plane/readme.md @@ -0,0 +1,91 @@ +# communicationservices + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for communicationservices. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the communicationservices. + +```yaml +openapi-type: data-plane +tag: package-2020-07-20-preview1 +``` + +### Tag: package-2020-07-20-preview1 + +These settings apply only when `--tag=package-2020-07-20-preview1` is specified on the command line. + +```yaml $(tag) == 'package-2020-07-20-preview1' +input-file: + - Microsoft.CommunicationServicesSms/preview/2020-07-20-preview1/communicationservicessms.json +title: + Azure Communication Services +``` + +```yaml +openapi-type: data-plane +tag: package-2020-09-21-preview2 +``` + +### Tag: package-2020-09-21-preview2 + +These settings apply only when `--tag=package-2020-09-21-preview2` is specified on the command line. + +```yaml $(tag) == 'package-2020-09-21-preview2' +input-file: + - Microsoft.CommunicationServicesChat/preview/2020-09-21-preview2/communicationserviceschat.json +title: + Azure Communication Services +``` + +### Tag: package-2020-07-20-preview2 + +These settings apply only when `--tag=package-2020-07-20-preview2` is specified on the command line. + +```yaml $(tag) == 'package-2020-07-20-preview2' +input-file: + - Microsoft.CommunicationServicesIdentity/preview/2020-07-20-preview2/CommunicationIdentity.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Ruby + +See configuration in [readme.ruby.md](./readme.ruby.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) diff --git a/specification/communication/data-plane/readme.python.md b/specification/communication/data-plane/readme.python.md new file mode 100644 index 000000000000..f7f55ff2159b --- /dev/null +++ b/specification/communication/data-plane/readme.python.md @@ -0,0 +1,21 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +```yaml $(python) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: Microsoft.CommunicationServices + package-name: communicationservices + package-version: 2020-04-16-privatepreview + clear-output-folder: true +``` + +```yaml $(python) +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt/communicationservices +``` diff --git a/specification/communication/data-plane/readme.ruby.md b/specification/communication/data-plane/readme.ruby.md new file mode 100644 index 000000000000..f521ab44dbf5 --- /dev/null +++ b/specification/communication/data-plane/readme.ruby.md @@ -0,0 +1,19 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +```yaml +package-name: azure_mgmt_communicationservices +package-version: 2020-04-16-privatepreview +azure-arm: true +``` + +### Tag: package-2020-04-16-privatepreview and ruby + +These settings apply only when `--tag=package-2020-04-16-privatepreview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2020-04-16-privatepreview' && $(ruby) +namespace: Microsoft.CommunicationServices +output-folder: $(ruby-sdks-folder)/communicationservices +``` diff --git a/specification/communication/data-plane/readme.typescript.md b/specification/communication/data-plane/readme.typescript.md new file mode 100644 index 000000000000..be9f877fd1c2 --- /dev/null +++ b/specification/communication/data-plane/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +```yaml $(typescript) +typescript: + azure-arm: true + package-name: "communicationservices" + output-folder: "$(typescript-sdks-folder)/packages/communicationservices" + payload-flattening-threshold: 1 + generate-metadata: true +``` From 02aa7ac3e1c3e7649a6b8aad0a9de635cdd8f62a Mon Sep 17 00:00:00 2001 From: Lei Ni <7233663+leni-msft@users.noreply.github.com> Date: Tue, 22 Sep 2020 12:27:52 +0800 Subject: [PATCH 104/164] Remove deprecated all-api-versions in readme.md (#10863) * run multiapi * Remove deprecated all-api-versions * Manual remove --- .../resource-manager/readme.md | 24 - .../addons/resource-manager/readme.md | 25 - .../readme.azureresourceschema.md | 14 +- .../resource-manager/readme.md | 24 - .../advisor/resource-manager/readme.md | 27 - .../readme.azureresourceschema.md | 12 + .../resource-manager/readme.md | 32 - .../resource-manager/readme.md | 27 - .../apimanagement/resource-manager/readme.md | 227 ----- .../resource-manager/readme.md | 27 - .../resource-manager/readme.md | 48 - .../appplatform/resource-manager/readme.md | 24 - .../attestation/resource-manager/readme.md | 24 - .../authorization/resource-manager/readme.md | 35 - .../automanage/resource-manager/readme.md | 23 - .../automation/resource-manager/readme.md | 57 -- .../azure-kusto/resource-manager/readme.md | 31 - .../resource-manager/readme.md | 26 - .../readme.azureresourceschema.md | 12 + .../azuredata/resource-manager/readme.md | 23 - .../azurestack/resource-manager/readme.md | 27 - .../azurestackhci/resource-manager/readme.md | 24 - .../readme.azureresourceschema.md | 24 + .../batch/resource-manager/readme.md | 32 - .../batchai/resource-manager/readme.md | 26 - .../billing/resource-manager/readme.md | 30 - .../blockchain/resource-manager/readme.md | 24 - .../blueprint/resource-manager/readme.md | 28 - .../botservice/resource-manager/readme.md | 25 - specification/cdn/resource-manager/readme.md | 36 - .../changeanalysis/resource-manager/readme.md | 24 - .../cloudshell/resource-manager/readme.md | 24 - .../resource-manager/readme.md | 25 - .../commerce/resource-manager/readme.md | 24 - .../readme.azureresourceschema.md | 13 + .../compute/resource-manager/readme.md | 66 -- .../consumption/resource-manager/readme.md | 38 - .../resource-manager/readme.md | 31 - .../resource-manager/readme.md | 33 - .../readme.azureresourceschema.md | 12 + .../resource-manager/readme.md | 49 - .../cosmos-db/resource-manager/readme.md | 40 - .../readme.azureresourceschema.md | 1 + .../resource-manager/readme.md | 33 - specification/cpim/resource-manager/readme.md | 24 - .../resource-manager/readme.md | 25 - .../resource-manager/readme.md | 24 - .../resource-manager/readme.md | 24 - .../databox/resource-manager/readme.md | 26 - .../databoxedge/resource-manager/readme.md | 26 - .../databricks/resource-manager/readme.md | 24 - .../datacatalog/resource-manager/readme.md | 24 - .../readme.azureresourceschema.md | 7 + .../datafactory/resource-manager/readme.md | 25 - .../resource-manager/readme.md | 25 - .../datalake-store/resource-manager/readme.md | 25 - .../datamigration/resource-manager/readme.md | 126 --- .../datashare/resource-manager/readme.md | 24 - .../resource-manager/readme.md | 25 - .../resource-manager/readme.md | 26 - .../readme.azureresourceschema.md | 24 + .../resource-manager/readme.md | 26 - .../devops/resource-manager/readme.md | 24 - .../devspaces/resource-manager/readme.md | 24 - .../devtestlabs/resource-manager/readme.md | 26 - .../readme.azureresourceschema.md | 12 + .../digitaltwins/resource-manager/readme.md | 25 - specification/dnc/resource-manager/readme.md | 24 - specification/dns/resource-manager/readme.md | 29 - .../domainservices/resource-manager/readme.md | 28 - .../resource-manager/readme.md | 24 - .../eventgrid/resource-manager/readme.md | 33 - .../eventhub/resource-manager/readme.md | 41 - .../frontdoor/resource-manager/readme.md | 42 - .../resource-manager/readme.md | 27 - .../hanaonazure/resource-manager/readme.md | 25 - .../resource-manager/readme.md | 23 - .../hdinsight/resource-manager/readme.md | 38 - .../readme.azureresourceschema.md | 12 + .../healthcareapis/resource-manager/readme.md | 24 - .../hybridcompute/resource-manager/readme.md | 29 - .../resource-manager/readme.md | 25 - .../resource-manager/readme.md | 23 - .../hybridnetwork/resource-manager/readme.md | 29 - .../imagebuilder/resource-manager/readme.md | 26 - .../intune/resource-manager/readme.md | 25 - .../iotcentral/resource-manager/readme.md | 25 - .../readme.azureresourceschema.md | 12 + .../iothub/resource-manager/readme.md | 36 - .../iotspaces/resource-manager/readme.md | 24 - .../keyvault/resource-manager/readme.md | 35 - .../resource-manager/readme.md | 23 - .../labservices/resource-manager/readme.md | 24 - .../logic/resource-manager/readme.md | 28 - .../resource-manager/readme.md | 27 - .../resource-manager/readme.md | 25 - .../resource-manager/readme.md | 24 - .../resource-manager/readme.md | 36 - .../maintenance/resource-manager/readme.md | 25 - .../managednetwork/resource-manager/readme.md | 22 - .../resource-manager/readme.md | 27 - .../resource-manager/readme.md | 30 - .../resource-manager/readme.md | 24 - specification/maps/resource-manager/readme.md | 25 - .../mariadb/resource-manager/readme.md | 34 - .../marketplace/resource-manager/readme.md | 24 - .../resource-manager/readme.md | 24 - .../mediaservices/resource-manager/readme.md | 61 -- .../migrate/resource-manager/readme.md | 26 - .../resource-manager/readme.md | 24 - .../mixedreality/resource-manager/readme.md | 31 - .../monitor/resource-manager/readme.md | 65 -- specification/msi/resource-manager/readme.md | 25 - .../mysql/resource-manager/readme.md | 36 - .../netapp/resource-manager/readme.md | 31 - .../readme.azureresourceschema.md | 1 + .../network/resource-manager/readme.md | 945 ------------------ .../resource-manager/readme.md | 26 - .../resource-manager/readme.md | 68 -- .../resource-manager/readme.md | 24 - .../peering/resource-manager/readme.md | 26 - .../policyinsights/resource-manager/readme.md | 33 - .../readme.azureresourceschema.md | 14 + .../portal/resource-manager/readme.md | 26 - .../postgresql/resource-manager/readme.md | 32 - .../resource-manager/readme.md | 24 - .../resource-manager/readme.md | 24 - .../readme.azureresourceschema.md | 27 + .../privatedns/resource-manager/readme.md | 24 - .../resource-manager/readme.md | 27 - .../resource-manager/readme.md | 32 - .../resource-manager/readme.md | 26 - .../resource-manager/readme.md | 24 - .../redis/resource-manager/readme.md | 28 - .../regionmove/resource-manager/readme.md | 18 - .../relay/resource-manager/readme.md | 29 - .../reservations/resource-manager/readme.md | 27 - .../resourcegraph/resource-manager/readme.md | 27 - .../resourcehealth/resource-manager/readme.md | 27 - .../readme.azureresourceschema.md | 24 + .../resources/resource-manager/readme.md | 79 -- .../scheduler/resource-manager/readme.md | 26 - .../search/resource-manager/readme.md | 29 - .../security/resource-manager/readme.md | 80 -- .../resource-manager/readme.md | 25 - .../serialconsole/resource-manager/readme.md | 24 - .../service-map/resource-manager/readme.md | 24 - .../readme.azureresourceschema.md | 8 +- .../servicebus/resource-manager/readme.md | 42 - .../servicefabric/resource-manager/readme.md | 39 - .../resource-manager/readme.md | 25 - .../signalr/resource-manager/readme.md | 27 - .../softwareplan/resource-manager/readme.md | 25 - .../readme.azureresourceschema.md | 19 +- specification/sql/resource-manager/readme.md | 233 ----- .../resource-manager/readme.md | 24 - .../resource-manager/readme.md | 24 - .../storage/resource-manager/readme.md | 52 - .../storagecache/resource-manager/readme.md | 26 - .../resource-manager/readme.md | 25 - .../storagesync/resource-manager/readme.md | 31 - .../resource-manager/readme.md | 24 - .../readme.azureresourceschema.md | 31 + .../resource-manager/readme.md | 28 - .../subscription/resource-manager/readme.md | 32 - .../support/resource-manager/readme.md | 25 - .../synapse/resource-manager/readme.md | 35 - .../resource-manager/readme.md | 27 - .../trafficmanager/resource-manager/readme.md | 30 - .../visualstudio/resource-manager/readme.md | 24 - .../vmware/resource-manager/readme.md | 25 - .../resource-manager/readme.md | 24 - specification/web/resource-manager/readme.md | 93 -- .../windowsesu/resource-manager/readme.md | 24 - .../windowsiot/resource-manager/readme.md | 25 - .../resource-manager/readme.md | 24 - 176 files changed, 272 insertions(+), 6121 deletions(-) create mode 100644 specification/baremetalinfrastructure/resource-manager/readme.azureresourceschema.md create mode 100644 specification/powerplatform/resource-manager/readme.azureresourceschema.md diff --git a/specification/EnterpriseKnowledgeGraph/resource-manager/readme.md b/specification/EnterpriseKnowledgeGraph/resource-manager/readme.md index 5e86715c9ebe..f829ac9dfbb7 100644 --- a/specification/EnterpriseKnowledgeGraph/resource-manager/readme.md +++ b/specification/EnterpriseKnowledgeGraph/resource-manager/readme.md @@ -98,27 +98,3 @@ csharp: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/EnterpriseKnowledgeGraphSwagger.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/addons/resource-manager/readme.md b/specification/addons/resource-manager/readme.md index 190417253f1c..324507aa8113 100644 --- a/specification/addons/resource-manager/readme.md +++ b/specification/addons/resource-manager/readme.md @@ -197,28 +197,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Addons/preview/2018-03-01/addons-swagger.json - - $(this-folder)/Microsoft.Addons/preview/2017-05-15/Addons.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/adhybridhealthservice/resource-manager/readme.azureresourceschema.md b/specification/adhybridhealthservice/resource-manager/readme.azureresourceschema.md index 2ed4e21a2173..1160a311964b 100644 --- a/specification/adhybridhealthservice/resource-manager/readme.azureresourceschema.md +++ b/specification/adhybridhealthservice/resource-manager/readme.azureresourceschema.md @@ -5,8 +5,20 @@ These settings apply only when `--azureresourceschema` is specified on the comma ### AzureResourceSchema multi-api ``` yaml $(azureresourceschema) && $(multiapi) -batch: [] +batch: + - tag: schema-adhybridhealthservice-2014-01-01 ``` Please also specify `--azureresourceschema-folder=`. + +### Tag: schema-adhybridhealthservice-2014-01-01 and azureresourceschema + +``` yaml $(tag) == 'schema-adhybridhealthservice-2014-01-01' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.ADHybridHealthService\stable\2014-01-01\ADHybridHealthService.json + +``` diff --git a/specification/adhybridhealthservice/resource-manager/readme.md b/specification/adhybridhealthservice/resource-manager/readme.md index 88e9f3b4d518..33c75ef311d4 100644 --- a/specification/adhybridhealthservice/resource-manager/readme.md +++ b/specification/adhybridhealthservice/resource-manager/readme.md @@ -101,27 +101,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.ADHybridHealthService\stable\2014-01-01\ADHybridHealthService.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/advisor/resource-manager/readme.md b/specification/advisor/resource-manager/readme.md index c3f9f016496e..a686c40128f2 100644 --- a/specification/advisor/resource-manager/readme.md +++ b/specification/advisor/resource-manager/readme.md @@ -152,30 +152,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Advisor/preview/2020-07-01-preview/advisor.json - - $(this-folder)/Microsoft.Advisor/stable/2020-01-01/advisor.json - - $(this-folder)/Microsoft.Advisor/stable/2017-04-19/advisor.json - - $(this-folder)/Microsoft.Advisor/stable/2017-03-31/advisor.json - - $(this-folder)/Microsoft.Advisor/preview/2016-07-12-preview/advisor.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/alertsmanagement/resource-manager/readme.azureresourceschema.md b/specification/alertsmanagement/resource-manager/readme.azureresourceschema.md index 87dbe102b007..7e310183b24c 100644 --- a/specification/alertsmanagement/resource-manager/readme.azureresourceschema.md +++ b/specification/alertsmanagement/resource-manager/readme.azureresourceschema.md @@ -6,6 +6,7 @@ These settings apply only when `--azureresourceschema` is specified on the comma ``` yaml $(azureresourceschema) && $(multiapi) batch: + - tag: schema-alertsmanagement-2020-08-04-preview - tag: schema-alertsmanagement-2019-06-01 - tag: schema-alertsmanagement-2019-05-05-preview - tag: schema-alertsmanagement-2019-03-01 @@ -16,6 +17,17 @@ batch: Please also specify `--azureresourceschema-folder=`. +### Tag: schema-alertsmanagement-2020-08-04-preview and azureresourceschema + +``` yaml $(tag) == 'schema-alertsmanagement-2020-08-04-preview' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.AlertsManagement/preview/2020-08-04-preview/AlertsManagement.json + +``` + ### Tag: schema-alertsmanagement-2019-06-01 and azureresourceschema ``` yaml $(tag) == 'schema-alertsmanagement-2019-06-01' && $(azureresourceschema) diff --git a/specification/alertsmanagement/resource-manager/readme.md b/specification/alertsmanagement/resource-manager/readme.md index 211952f9f39f..4c1754e7b365 100644 --- a/specification/alertsmanagement/resource-manager/readme.md +++ b/specification/alertsmanagement/resource-manager/readme.md @@ -190,35 +190,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.AlertsManagement/preview/2019-05-05-preview/ActionRules.json - - $(this-folder)/Microsoft.AlertsManagement/preview/2019-05-05-preview/AlertsManagement.json - - $(this-folder)/Microsoft.AlertsManagement/preview/2019-05-05-preview/SmartGroups.json - - $(this-folder)/Microsoft.AlertsManagement/stable/2019-06-01/SmartDetectorAlertRulesApi.json - - $(this-folder)/Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json - - $(this-folder)/Microsoft.AlertsManagement/stable/2019-03-01/SmartDetectorAlertRulesApi.json - - $(this-folder)/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json - - $(this-folder)/Microsoft.AlertsManagement/preview/2018-05-05-preview/AlertsManagement.json - - $(this-folder)/Microsoft.AlertsManagement/preview/2020-08-04-preview/AlertsManagement.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/analysisservices/resource-manager/readme.md b/specification/analysisservices/resource-manager/readme.md index c65ff0f0a6f8..1e60c46b1f69 100644 --- a/specification/analysisservices/resource-manager/readme.md +++ b/specification/analysisservices/resource-manager/readme.md @@ -190,30 +190,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.AnalysisServices/stable/2017-08-01/analysisservices.json - - $(this-folder)/Microsoft.AnalysisServices/preview/2017-08-01-beta/analysisservices.json - - $(this-folder)/Microsoft.AnalysisServices/stable/2017-07-14/analysisservices.json - - $(this-folder)/Microsoft.AnalysisServices/stable/2016-05-16/analysisservices.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/apimanagement/resource-manager/readme.md b/specification/apimanagement/resource-manager/readme.md index 96ff6b9c8221..623baea81b75 100644 --- a/specification/apimanagement/resource-manager/readme.md +++ b/specification/apimanagement/resource-manager/readme.md @@ -380,230 +380,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimanagement.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimapis.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimapisByTags.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimapiversionsets.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimauthorizationservers.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimbackends.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimcaches.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimcertificates.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimcontenttypes.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimdeployment.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimdiagnostics.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimemailtemplates.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimgateways.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimgroups.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimidentityprovider.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimissues.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimloggers.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimnamedvalues.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimnetworkstatus.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimnotifications.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimopenidconnectproviders.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimpolicies.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimpolicydescriptions.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimportalsettings.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimproducts.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimproductsByTags.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimquotas.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimregions.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimreports.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimsubscriptions.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimtagresources.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimtags.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimtenant.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/apimusers.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-12-01/definitions.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimanagement.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimapis.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimapisByTags.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimapiversionsets.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimauthorizationservers.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimbackends.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimcaches.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimcertificates.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimdeployment.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimdiagnostics.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimemailtemplates.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimgateways.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimgroups.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimidentityprovider.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimissues.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimloggers.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimnetworkstatus.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimnotifications.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimopenidconnectproviders.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimpolicies.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimpolicydescriptions.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimportalsettings.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimproducts.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimproductsByTags.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimnamedvalues.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimquotas.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimregions.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimreports.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimsubscriptions.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimtagresources.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimtags.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimtenant.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/apimusers.json - - $(this-folder)/Microsoft.ApiManagement/preview/2019-12-01-preview/definitions.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimanagement.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimapis.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimapisByTags.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimapiversionsets.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimauthorizationservers.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimbackends.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimcaches.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimcertificates.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimdeployment.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimdiagnostics.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimemailtemplates.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimgroups.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimidentityprovider.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimissues.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimloggers.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimnetworkstatus.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimnotifications.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimopenidconnectproviders.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimpolicies.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimpolicysnippets.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimportalsettings.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimproducts.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimproductsByTags.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimproperties.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimquotas.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimregions.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimreports.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimsubscriptions.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimtagresources.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimtags.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimtenant.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/apimusers.json - - $(this-folder)/Microsoft.ApiManagement/stable/2019-01-01/definitions.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimanagement.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapisByTags.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimauthorizationservers.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimbackends.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimcaches.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimcertificates.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdeployment.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdiagnostics.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimemailtemplates.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimgroups.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimidentityprovider.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimissues.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimloggers.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimnotifications.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimnetworkstatus.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimopenidconnectproviders.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimpolicies.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimpolicysnippets.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimportalsettings.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimproducts.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimproductsByTags.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimproperties.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimquotas.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimregions.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimreports.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimsubscriptions.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtagresources.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtags.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtenant.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimusers.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapiversionsets.json - - $(this-folder)/Microsoft.ApiManagement/preview/2018-06-01-preview/definitions.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimanagement.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimapis.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimauthorizationservers.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimbackends.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimcertificates.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimdeployment.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimdiagnostics.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimemailtemplate.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimgroups.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimidentityprovider.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimloggers.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimnotifications.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimnetworkstatus.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimopenidconnectproviders.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimportalsettings.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimproducts.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimproperties.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimquotas.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimreports.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimsubscriptions.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimtagresources.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimtags.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimtenant.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimusers.json - - $(this-folder)/Microsoft.ApiManagement/stable/2018-01-01/apimversionsets.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimanagement.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimauthorizationservers.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimbackends.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimcertificates.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimdeployment.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimdiagnostics.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimemailtemplate.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimgroups.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimidentityprovider.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimloggers.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimnotifications.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimnetworkstatus.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimopenidconnectproviders.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimportalsettings.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimproducts.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimproperties.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimquotas.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimreports.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimsubscriptions.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimtenant.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimusers.json - - $(this-folder)/Microsoft.ApiManagement/stable/2017-03-01/apimversionsets.json - - $(this-folder)/Microsoft.ApiManagement/stable/2016-10-10/apimanagement.json - - $(this-folder)/Microsoft.ApiManagement/stable/2016-10-10/apimapis.json - - $(this-folder)/Microsoft.ApiManagement/stable/2016-10-10/apimauthorizationservers.json - - $(this-folder)/Microsoft.ApiManagement/stable/2016-10-10/apimbackends.json - - $(this-folder)/Microsoft.ApiManagement/stable/2016-10-10/apimcertificates.json - - $(this-folder)/Microsoft.ApiManagement/stable/2016-10-10/apimdeployment.json - - $(this-folder)/Microsoft.ApiManagement/stable/2016-10-10/apimgroups.json - - $(this-folder)/Microsoft.ApiManagement/stable/2016-10-10/apimidentityprovider.json - - $(this-folder)/Microsoft.ApiManagement/stable/2016-10-10/apimloggers.json - - $(this-folder)/Microsoft.ApiManagement/stable/2016-10-10/apimnetworkstatus.json - - $(this-folder)/Microsoft.ApiManagement/stable/2016-10-10/apimopenidconnectproviders.json - - $(this-folder)/Microsoft.ApiManagement/stable/2016-10-10/apimproducts.json - - $(this-folder)/Microsoft.ApiManagement/stable/2016-10-10/apimproperties.json - - $(this-folder)/Microsoft.ApiManagement/stable/2016-10-10/apimquotas.json - - $(this-folder)/Microsoft.ApiManagement/stable/2016-10-10/apimreports.json - - $(this-folder)/Microsoft.ApiManagement/stable/2016-10-10/apimsubscriptions.json - - $(this-folder)/Microsoft.ApiManagement/stable/2016-10-10/apimtenant.json - - $(this-folder)/Microsoft.ApiManagement/stable/2016-10-10/apimusers.json - - $(this-folder)/Microsoft.ApiManagement/stable/2016-07-07/apimanagement.json - - $(this-folder)/Microsoft.ApiManagement/stable/2016-07-07/apimdeployment.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/appconfiguration/resource-manager/readme.md b/specification/appconfiguration/resource-manager/readme.md index 8b0a55eef85c..8f59f70c2a43 100644 --- a/specification/appconfiguration/resource-manager/readme.md +++ b/specification/appconfiguration/resource-manager/readme.md @@ -136,30 +136,3 @@ directive: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.AppConfiguration/stable/2020-06-01/appconfiguration.json - - $(this-folder)/Microsoft.AppConfiguration/preview/2019-11-01-preview/appconfiguration.json - - $(this-folder)/Microsoft.AppConfiguration/preview/2019-02-01-preview/appconfiguration.json - - $(this-folder)/Microsoft.AppConfiguration/stable/2019-10-01/appconfiguration.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/applicationinsights/resource-manager/readme.md b/specification/applicationinsights/resource-manager/readme.md index 1a530b904a3c..5c0ad5cb963a 100644 --- a/specification/applicationinsights/resource-manager/readme.md +++ b/specification/applicationinsights/resource-manager/readme.md @@ -352,51 +352,3 @@ input-file: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Insights/preview/2020-06-02-preview/livetoken_API.json - - $(this-folder)/Microsoft.Insights/stable/2015-05-01/aiOperations_API.json - - $(this-folder)/Microsoft.Insights/stable/2015-05-01/componentAnnotations_API.json - - $(this-folder)/Microsoft.Insights/stable/2015-05-01/componentApiKeys_API.json - - $(this-folder)/Microsoft.Insights/stable/2015-05-01/componentContinuousExport_API.json - - $(this-folder)/Microsoft.Insights/stable/2015-05-01/componentFeaturesAndPricing_API.json - - $(this-folder)/Microsoft.Insights/stable/2015-05-01/componentProactiveDetection_API.json - - $(this-folder)/Microsoft.Insights/stable/2015-05-01/componentWorkItemConfigs_API.json - - $(this-folder)/Microsoft.Insights/stable/2015-05-01/favorites_API.json - - $(this-folder)/Microsoft.Insights/stable/2015-05-01/webTestLocations_API.json - - $(this-folder)/Microsoft.Insights/stable/2015-05-01/webTests_API.json - - $(this-folder)/Microsoft.Insights/stable/2015-05-01/analyticsItems_API.json - - $(this-folder)/Microsoft.Insights/stable/2015-05-01/workbooks_API.json - - $(this-folder)/Microsoft.Insights/stable/2015-05-01/myworkbooks_API.json - - $(this-folder)/Microsoft.Insights/preview/2018-05-01-preview/components_API.json - - $(this-folder)/Microsoft.Insights/preview/2020-03-01-preview/componentLinkedStorageAccounts_API.json - - $(this-folder)/Microsoft.Insights/preview/2020-02-10-preview/WebTestResults_API.json - - $(this-folder)/Microsoft.Insights/stable/2015-05-01/components_API.json - - $(this-folder)/Microsoft.Insights/preview/2017-10-01/eaSubscriptionMigration_API.json - - $(this-folder)/Microsoft.Insights/preview/2017-10-01/componentFeaturesAndPricing_API.json - - $(this-folder)/Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json - - $(this-folder)/Microsoft.Insights/preview/2019-10-17-preview/workbookTemplates_API.json - - $(this-folder)/Microsoft.Insights/preview/2018-05-01-preview/componentProactiveDetection_API.json - - $(this-folder)/Microsoft.Insights/preview/2019-09-01-preview/QueryPackQueries_API.json - - $(this-folder)/Microsoft.Insights/preview/2019-09-01-preview/QueryPacks_API.json - - $(this-folder)/Microsoft.Insights/preview/2020-02-02-preview/components_API.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/appplatform/resource-manager/readme.md b/specification/appplatform/resource-manager/readme.md index 4a9a5a3d95e3..37a91547fa09 100644 --- a/specification/appplatform/resource-manager/readme.md +++ b/specification/appplatform/resource-manager/readme.md @@ -121,27 +121,3 @@ csharp: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.AppPlatform/stable/2020-07-01/appplatform.json - - $(this-folder)/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/attestation/resource-manager/readme.md b/specification/attestation/resource-manager/readme.md index e2509e0c3c46..68adc3fb05b6 100644 --- a/specification/attestation/resource-manager/readme.md +++ b/specification/attestation/resource-manager/readme.md @@ -87,27 +87,3 @@ See configuration in [readme.trenton.md](./readme.trenton.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/authorization/resource-manager/readme.md b/specification/authorization/resource-manager/readme.md index dc05c9392f9c..056f804e8de3 100644 --- a/specification/authorization/resource-manager/readme.md +++ b/specification/authorization/resource-manager/readme.md @@ -244,38 +244,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Authorization/preview/2020-04-01-preview/authorization-RoleAssignmentsCalls.json - - $(this-folder)/Microsoft.Authorization/stable/2015-07-01/authorization-RoleDefinitionsCalls.json - - $(this-folder)/Microsoft.Authorization/stable/2015-07-01/authorization-ProviderOperationsCalls.json - - $(this-folder)/Microsoft.Authorization/stable/2015-07-01/authorization-ElevateAccessCalls.json - - $(this-folder)/Microsoft.Authorization/stable/2015-07-01/authorization-RoleAssignmentsCalls.json - - $(this-folder)/Microsoft.Authorization/stable/2015-07-01/authorization-ClassicAdminCalls.json - - $(this-folder)/Microsoft.Authorization/preview/2015-06-01/authorization-ClassicAdminCalls.json - - $(this-folder)/Microsoft.Authorization/preview/2017-10-01-preview/authorization-RoleAssignmentsCalls.json - - $(this-folder)/Microsoft.Authorization/preview/2018-01-01-preview/authorization-ProviderOperationsCalls.json - - $(this-folder)/Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleAssignmentsCalls.json - - $(this-folder)/Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleDefinitionsCalls.json - - $(this-folder)/Microsoft.Authorization/preview/2018-07-01-preview/authorization-DenyAssignmentGetCalls.json - - $(this-folder)/Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleAssignmentsCalls.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/automanage/resource-manager/readme.md b/specification/automanage/resource-manager/readme.md index c6f1780bd6da..a99434672cf5 100644 --- a/specification/automanage/resource-manager/readme.md +++ b/specification/automanage/resource-manager/readme.md @@ -84,26 +84,3 @@ csharp: clear-output-folder: true ``` -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Automanage/preview/2020-06-30-preview/automanage.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/automation/resource-manager/readme.md b/specification/automation/resource-manager/readme.md index 1232c3a3c9d8..673bab83d496 100644 --- a/specification/automation/resource-manager/readme.md +++ b/specification/automation/resource-manager/readme.md @@ -306,60 +306,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Automation/stable/2015-10-31/account.json - - $(this-folder)/Microsoft.Automation/stable/2015-10-31/certificate.json - - $(this-folder)/Microsoft.Automation/stable/2015-10-31/connection.json - - $(this-folder)/Microsoft.Automation/stable/2015-10-31/connectionType.json - - $(this-folder)/Microsoft.Automation/stable/2015-10-31/credential.json - - $(this-folder)/Microsoft.Automation/stable/2015-10-31/dscCompilationJob.json - - $(this-folder)/Microsoft.Automation/stable/2015-10-31/dscConfiguration.json - - $(this-folder)/Microsoft.Automation/stable/2015-10-31/dscNode.json - - $(this-folder)/Microsoft.Automation/stable/2015-10-31/dscNodeConfiguration.json - - $(this-folder)/Microsoft.Automation/stable/2015-10-31/hybridRunbookWorkerGroup.json - - $(this-folder)/Microsoft.Automation/stable/2015-10-31/job.json - - $(this-folder)/Microsoft.Automation/stable/2015-10-31/jobSchedule.json - - $(this-folder)/Microsoft.Automation/stable/2015-10-31/linkedWorkspace.json - - $(this-folder)/Microsoft.Automation/stable/2015-10-31/module.json - - $(this-folder)/Microsoft.Automation/stable/2015-10-31/runbook.json - - $(this-folder)/Microsoft.Automation/stable/2015-10-31/schedule.json - - $(this-folder)/Microsoft.Automation/stable/2015-10-31/variable.json - - $(this-folder)/Microsoft.Automation/stable/2015-10-31/webhook.json - - $(this-folder)/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json - - $(this-folder)/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationRun.json - - $(this-folder)/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json - - $(this-folder)/Microsoft.Automation/preview/2017-05-15-preview/sourceControl.json - - $(this-folder)/Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJob.json - - $(this-folder)/Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJobStreams.json - - $(this-folder)/Microsoft.Automation/preview/2017-05-15-preview/job.json - - $(this-folder)/Microsoft.Automation/stable/2015-10-31/watcher.json - - $(this-folder)/Microsoft.Automation/stable/2018-01-15/dscNode.json - - $(this-folder)/Microsoft.Automation/stable/2018-01-15/dscCompilationJob.json - - $(this-folder)/Microsoft.Automation/stable/2018-01-15/dscNodeConfiguration.json - - $(this-folder)/Microsoft.Automation/stable/2018-01-15/dscNodeCounts.json - - $(this-folder)/Microsoft.Automation/stable/2018-06-30/runbook.json - - $(this-folder)/Microsoft.Automation/stable/2018-06-30/python2package.json - - $(this-folder)/Microsoft.Automation/preview/2020-01-13-preview/privateEndpointConnection.json - - $(this-folder)/Microsoft.Automation/preview/2020-01-13-preview/privateLinkResources.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/azure-kusto/resource-manager/readme.md b/specification/azure-kusto/resource-manager/readme.md index f33e161ac118..043249c10db0 100644 --- a/specification/azure-kusto/resource-manager/readme.md +++ b/specification/azure-kusto/resource-manager/readme.md @@ -200,37 +200,6 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Kusto/stable/2020-06-14/kusto.json - - $(this-folder)/Microsoft.Kusto/stable/2020-02-15/kusto.json - - $(this-folder)/Microsoft.Kusto/stable/2019-11-09/kusto.json - - $(this-folder)/Microsoft.Kusto/stable/2019-09-07/kusto.json - - $(this-folder)/Microsoft.Kusto/stable/2019-05-15/kusto.json - - $(this-folder)/Microsoft.Kusto/stable/2019-01-21/kusto.json - - $(this-folder)/Microsoft.Kusto/preview/2018-09-07-preview/kusto.json - - $(this-folder)/Microsoft.Kusto/preview/2017-09-07-privatepreview/kusto.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - ## Suppression ``` yaml diff --git a/specification/azureactivedirectory/resource-manager/readme.md b/specification/azureactivedirectory/resource-manager/readme.md index 76d6a582264c..b84ecea4a6f7 100644 --- a/specification/azureactivedirectory/resource-manager/readme.md +++ b/specification/azureactivedirectory/resource-manager/readme.md @@ -124,29 +124,3 @@ See configuration in [readme.csharp.md](./readme.csharp.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Aadiam/preview/2020-07-01-preview/azureADMetrics.json - - $(this-folder)/Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkForAzureAD.json - - $(this-folder)/Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkResources.json - - $(this-folder)/Microsoft.Aadiam/stable/2017-04-01/azureactivedirectory.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/azuredata/resource-manager/readme.azureresourceschema.md b/specification/azuredata/resource-manager/readme.azureresourceschema.md index 9e9e3a071f7d..25ab4f9115e8 100644 --- a/specification/azuredata/resource-manager/readme.azureresourceschema.md +++ b/specification/azuredata/resource-manager/readme.azureresourceschema.md @@ -6,12 +6,24 @@ These settings apply only when `--azureresourceschema` is specified on the comma ``` yaml $(azureresourceschema) && $(multiapi) batch: + - tag: schema-azuredata-2020-09-08-preview - tag: schema-azuredata-2019-07-24-preview ``` Please also specify `--azureresourceschema-folder=`. +### Tag: schema-azuredata-2020-09-08-preview and azureresourceschema + +``` yaml $(tag) == 'schema-azuredata-2020-09-08-preview' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.AzureData/preview/2020-09-08-preview/azuredata.json + +``` + ### Tag: schema-azuredata-2019-07-24-preview and azureresourceschema ``` yaml $(tag) == 'schema-azuredata-2019-07-24-preview' && $(azureresourceschema) diff --git a/specification/azuredata/resource-manager/readme.md b/specification/azuredata/resource-manager/readme.md index be936d04b9ea..c862cca522de 100644 --- a/specification/azuredata/resource-manager/readme.md +++ b/specification/azuredata/resource-manager/readme.md @@ -103,26 +103,3 @@ See configuration in [readme.csharp.md](./readme.csharp.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.AzureData/preview/2019-07-24-preview/azuredata.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` \ No newline at end of file diff --git a/specification/azurestack/resource-manager/readme.md b/specification/azurestack/resource-manager/readme.md index dc231df47dea..34aec4212656 100644 --- a/specification/azurestack/resource-manager/readme.md +++ b/specification/azurestack/resource-manager/readme.md @@ -143,30 +143,3 @@ See configuration in [readme.python.md](./readme.python.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.AzureStack/stable/2017-06-01/AzureStack.json - - $(this-folder)/Microsoft.AzureStack/stable/2017-06-01/Product.json - - $(this-folder)/Microsoft.AzureStack/stable/2017-06-01/Registration.json - - $(this-folder)/Microsoft.AzureStack/stable/2017-06-01/CustomerSubscription.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/azurestackhci/resource-manager/readme.md b/specification/azurestackhci/resource-manager/readme.md index ee213486dda1..fcd244ab9316 100644 --- a/specification/azurestackhci/resource-manager/readme.md +++ b/specification/azurestackhci/resource-manager/readme.md @@ -96,27 +96,3 @@ See configuration in [readme.csharp.md](./readme.csharp.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.AzureStackHCI/preview/2020-03-01-preview/azurestackhci.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/baremetalinfrastructure/resource-manager/readme.azureresourceschema.md b/specification/baremetalinfrastructure/resource-manager/readme.azureresourceschema.md new file mode 100644 index 000000000000..0228f0a806a3 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/readme.azureresourceschema.md @@ -0,0 +1,24 @@ +## AzureResourceSchema + +These settings apply only when `--azureresourceschema` is specified on the command line. + +### AzureResourceSchema multi-api + +``` yaml $(azureresourceschema) && $(multiapi) +batch: + - tag: schema-baremetalinfrastructure-2020-08-06-preview + +``` + +Please also specify `--azureresourceschema-folder=`. + +### Tag: schema-baremetalinfrastructure-2020-08-06-preview and azureresourceschema + +``` yaml $(tag) == 'schema-baremetalinfrastructure-2020-08-06-preview' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.BareMetalInfrastructure/preview/2020-08-06-preview/baremetalinfrastructure.json + +``` diff --git a/specification/batch/resource-manager/readme.md b/specification/batch/resource-manager/readme.md index 4f12e196aab3..8c9580afe937 100644 --- a/specification/batch/resource-manager/readme.md +++ b/specification/batch/resource-manager/readme.md @@ -281,35 +281,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Batch/stable/2020-09-01/BatchManagement.json - - $(this-folder)/Microsoft.Batch/stable/2020-05-01/BatchManagement.json - - $(this-folder)/Microsoft.Batch/stable/2020-03-01/BatchManagement.json - - $(this-folder)/Microsoft.Batch/stable/2019-08-01/BatchManagement.json - - $(this-folder)/Microsoft.Batch/stable/2019-04-01/BatchManagement.json - - $(this-folder)/Microsoft.Batch/stable/2018-12-01/BatchManagement.json - - $(this-folder)/Microsoft.Batch/stable/2017-09-01/BatchManagement.json - - $(this-folder)/Microsoft.Batch/stable/2017-05-01/BatchManagement.json - - $(this-folder)/Microsoft.Batch/stable/2017-01-01/BatchManagement.json - - $(this-folder)/Microsoft.Batch/stable/2015-12-01/BatchManagement.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/batchai/resource-manager/readme.md b/specification/batchai/resource-manager/readme.md index a33a47f14d3b..6c29bae8f5b6 100644 --- a/specification/batchai/resource-manager/readme.md +++ b/specification/batchai/resource-manager/readme.md @@ -190,29 +190,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.BatchAI/preview/2017-09-01-preview/BatchAI.json - - $(this-folder)/Microsoft.BatchAI/stable/2018-03-01/BatchAI.json - - $(this-folder)/Microsoft.BatchAI/stable/2018-05-01/BatchAI.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/billing/resource-manager/readme.md b/specification/billing/resource-manager/readme.md index a28cc4e5784c..133322e3dbd8 100644 --- a/specification/billing/resource-manager/readme.md +++ b/specification/billing/resource-manager/readme.md @@ -238,33 +238,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Billing/stable/2020-05-01/billing.json - - $(this-folder)/Microsoft.Billing/preview/2018-03-01-preview/billingV2.json - - $(this-folder)/Microsoft.Billing/preview/2019-10-01-preview/billing.json - - $(this-folder)/Microsoft.Billing/preview/2018-11-01-preview/billing.json - - $(this-folder)/Microsoft.Billing/preview/2018-03-01-preview/billing.json - - $(this-folder)/Microsoft.Billing/preview/2017-04-24-preview/billing.json - - $(this-folder)/Microsoft.Billing/preview/2017-02-27-preview/billing.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/blockchain/resource-manager/readme.md b/specification/blockchain/resource-manager/readme.md index cab2a3ebe290..ebea104cb0f2 100644 --- a/specification/blockchain/resource-manager/readme.md +++ b/specification/blockchain/resource-manager/readme.md @@ -93,27 +93,3 @@ See configuration in [readme.ruby.md](./readme.ruby.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Blockchain/preview/2018-06-01-preview/blockchain.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/blueprint/resource-manager/readme.md b/specification/blueprint/resource-manager/readme.md index d39803123cf1..e133f1b7ed9f 100644 --- a/specification/blueprint/resource-manager/readme.md +++ b/specification/blueprint/resource-manager/readme.md @@ -138,31 +138,3 @@ directive: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintDefinition.json - - $(this-folder)/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintAssignment.json - - $(this-folder)/Microsoft.Blueprint/preview/2018-11-01-preview/blueprintDefinition.json - - $(this-folder)/Microsoft.Blueprint/preview/2018-11-01-preview/blueprintAssignment.json - - $(this-folder)/Microsoft.Blueprint/preview/2018-11-01-preview/assignmentOperation.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/botservice/resource-manager/readme.md b/specification/botservice/resource-manager/readme.md index ed269859fd07..b94651179da3 100644 --- a/specification/botservice/resource-manager/readme.md +++ b/specification/botservice/resource-manager/readme.md @@ -131,28 +131,3 @@ See readme.python.md file. See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.BotService/stable/2020-06-02/botservice.json - - $(this-folder)/Microsoft.BotService/preview/2018-07-12/botservice.json - - $(this-folder)/Microsoft.BotService/preview/2017-12-01/botservice.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/cdn/resource-manager/readme.md b/specification/cdn/resource-manager/readme.md index a721599aedd4..d7f99a1c0370 100644 --- a/specification/cdn/resource-manager/readme.md +++ b/specification/cdn/resource-manager/readme.md @@ -182,39 +182,3 @@ See configuration in [readme.ruby.md](./readme.ruby.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Cdn/stable/2020-04-15/cdn.json - - $(this-folder)/Microsoft.Cdn/stable/2020-04-15/cdnwebapplicationfirewall.json - - $(this-folder)/Microsoft.Cdn/stable/2019-12-31/cdn.json - - $(this-folder)/Microsoft.Cdn/stable/2019-06-15/cdn.json - - $(this-folder)/Microsoft.Cdn/stable/2019-06-15/cdnwebapplicationfirewall.json - - $(this-folder)/Microsoft.Cdn/preview/2019-06-15-preview/cdn.json - - $(this-folder)/Microsoft.Cdn/preview/2019-06-15-preview/cdnwebapplicationfirewall.json - - $(this-folder)/Microsoft.Cdn/stable/2019-04-15/cdn.json - - $(this-folder)/Microsoft.Cdn/stable/2017-10-12/cdn.json - - $(this-folder)/Microsoft.Cdn/stable/2017-04-02/cdn.json - - $(this-folder)/Microsoft.Cdn/stable/2016-10-02/cdn.json - - $(this-folder)/Microsoft.Cdn/stable/2016-04-02/cdn.json - - $(this-folder)/Microsoft.Cdn/stable/2015-06-01/cdn.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/changeanalysis/resource-manager/readme.md b/specification/changeanalysis/resource-manager/readme.md index 218a3d561e26..d8cc3055ec39 100644 --- a/specification/changeanalysis/resource-manager/readme.md +++ b/specification/changeanalysis/resource-manager/readme.md @@ -121,27 +121,3 @@ directive: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.ChangeAnalysis/preview/2020-04-01-preview/changeanalysis.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/cloudshell/resource-manager/readme.md b/specification/cloudshell/resource-manager/readme.md index 6fb7acdaf933..d1f360640baa 100644 --- a/specification/cloudshell/resource-manager/readme.md +++ b/specification/cloudshell/resource-manager/readme.md @@ -153,27 +153,3 @@ csharp: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Portal/stable/2018-10-01/CloudShell.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/cognitiveservices/resource-manager/readme.md b/specification/cognitiveservices/resource-manager/readme.md index 49f7177b6ab1..6a6be724ecc5 100644 --- a/specification/cognitiveservices/resource-manager/readme.md +++ b/specification/cognitiveservices/resource-manager/readme.md @@ -148,28 +148,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json - - $(this-folder)/Microsoft.CognitiveServices/preview/2016-02-01-preview/cognitiveservices.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/commerce/resource-manager/readme.md b/specification/commerce/resource-manager/readme.md index 4f7967777da7..c8a7045b2f89 100644 --- a/specification/commerce/resource-manager/readme.md +++ b/specification/commerce/resource-manager/readme.md @@ -150,27 +150,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/compute/resource-manager/readme.azureresourceschema.md b/specification/compute/resource-manager/readme.azureresourceschema.md index fe54530ede0c..81b6c3e59c77 100644 --- a/specification/compute/resource-manager/readme.azureresourceschema.md +++ b/specification/compute/resource-manager/readme.azureresourceschema.md @@ -10,6 +10,7 @@ batch: - tag: schema-containerservice-2016-09-30 - tag: schema-containerservice-2016-03-30 - tag: schema-containerservice-2015-11-01-preview + - tag: schema-compute-2020-09-30 - tag: schema-compute-2020-06-30 - tag: schema-compute-2020-06-01 - tag: schema-compute-2020-05-01 @@ -77,6 +78,18 @@ input-file: ``` +### Tag: schema-compute-2020-09-30 and azureresourceschema + +``` yaml $(tag) == 'schema-compute-2020-09-30' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.Compute/preview/2020-09-30/gallery.json + - Microsoft.Compute/preview/2020-09-30/sharedGallery.json + +``` + ### Tag: schema-compute-2020-06-30 and azureresourceschema ``` yaml $(tag) == 'schema-compute-2020-06-30' && $(azureresourceschema) diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md index f3bf70b2dee3..052addaaae0f 100644 --- a/specification/compute/resource-manager/readme.md +++ b/specification/compute/resource-manager/readme.md @@ -873,69 +873,3 @@ input-file: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Compute/preview/2020-09-30/sharedGallery.json - - $(this-folder)/Microsoft.Compute/preview/2020-09-30/gallery.json - - $(this-folder)/Microsoft.Compute/stable/2020-06-01/compute.json - - $(this-folder)/Microsoft.Compute/stable/2020-06-01/runCommands.json - - $(this-folder)/Microsoft.Compute/stable/2019-04-01/skus.json - - $(this-folder)/Microsoft.Compute/stable/2020-06-30/disk.json - - $(this-folder)/Microsoft.Compute/stable/2019-12-01/gallery.json - - $(this-folder)/Microsoft.ContainerService/stable/2017-01-31/containerService.json - - $(this-folder)/Microsoft.Compute/stable/2020-05-01/disk.json - - $(this-folder)/Microsoft.Compute/stable/2019-12-01/compute.json - - $(this-folder)/Microsoft.Compute/stable/2019-12-01/runCommands.json - - $(this-folder)/Microsoft.Compute/stable/2019-11-01/disk.json - - $(this-folder)/Microsoft.Compute/stable/2019-07-01/compute.json - - $(this-folder)/Microsoft.Compute/stable/2019-07-01/runCommands.json - - $(this-folder)/Microsoft.Compute/stable/2019-07-01/gallery.json - - $(this-folder)/Microsoft.Compute/stable/2019-07-01/disk.json - - $(this-folder)/Microsoft.Compute/stable/2019-03-01/compute.json - - $(this-folder)/Microsoft.Compute/stable/2019-03-01/runCommands.json - - $(this-folder)/Microsoft.Compute/stable/2019-03-01/disk.json - - $(this-folder)/Microsoft.Compute/stable/2019-03-01/gallery.json - - $(this-folder)/Microsoft.Compute/stable/2018-10-01/compute.json - - $(this-folder)/Microsoft.Compute/stable/2018-10-01/runCommands.json - - $(this-folder)/Microsoft.Compute/stable/2017-09-01/skus.json - - $(this-folder)/Microsoft.Compute/stable/2018-09-30/disk.json - - $(this-folder)/Microsoft.Compute/stable/2018-06-01/gallery.json - - $(this-folder)/Microsoft.Compute/stable/2018-06-01/disk.json - - $(this-folder)/Microsoft.Compute/stable/2018-06-01/compute.json - - $(this-folder)/Microsoft.Compute/stable/2018-06-01/runCommands.json - - $(this-folder)/Microsoft.Compute/stable/2018-04-01/compute.json - - $(this-folder)/Microsoft.Compute/stable/2018-04-01/runCommands.json - - $(this-folder)/Microsoft.Compute/stable/2018-04-01/disk.json - - $(this-folder)/Microsoft.Compute/stable/2017-12-01/compute.json - - $(this-folder)/Microsoft.Compute/stable/2017-12-01/runCommands.json - - $(this-folder)/Microsoft.Compute/stable/2017-03-30/disk.json - - $(this-folder)/Microsoft.Compute/stable/2017-03-30/compute.json - - $(this-folder)/Microsoft.Compute/stable/2017-03-30/runCommands.json - - $(this-folder)/Microsoft.ContainerService/stable/2016-09-30/containerService.json - - $(this-folder)/Microsoft.Compute/preview/2016-04-30-preview/compute.json - - $(this-folder)/Microsoft.Compute/preview/2016-04-30-preview/disk.json - - $(this-folder)/Microsoft.Compute/stable/2016-03-30/compute.json - - $(this-folder)/Microsoft.ContainerService/stable/2016-03-30/containerService.json - - $(this-folder)/Microsoft.ContainerService/preview/2015-11-01-preview/containerService.json - - $(this-folder)/Microsoft.Compute/stable/2015-06-15/compute.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/consumption/resource-manager/readme.md b/specification/consumption/resource-manager/readme.md index b909544080e9..575e341b41c9 100644 --- a/specification/consumption/resource-manager/readme.md +++ b/specification/consumption/resource-manager/readme.md @@ -411,41 +411,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Consumption/stable/2019-10-01/consumption.json - - $(this-folder)/Microsoft.Consumption/stable/2019-06-01/consumption.json - - $(this-folder)/Microsoft.Consumption/stable/2019-05-01/consumption.json - - $(this-folder)/Microsoft.Consumption/preview/2019-05-01-preview/consumption.json - - $(this-folder)/Microsoft.Consumption/preview/2019-04-01-preview/consumption.json - - $(this-folder)/Microsoft.Consumption/preview/2018-11-01-preview/consumption.json - - $(this-folder)/Microsoft.Consumption/stable/2019-01-01/consumption.json - - $(this-folder)/Microsoft.Consumption/stable/2017-11-30/consumption.json - - $(this-folder)/Microsoft.Consumption/stable/2018-01-31/consumption.json - - $(this-folder)/Microsoft.Consumption/stable/2018-03-31/consumption.json - - $(this-folder)/Microsoft.Consumption/stable/2018-05-31/consumption.json - - $(this-folder)/Microsoft.Consumption/stable/2018-06-30/consumption.json - - $(this-folder)/Microsoft.Consumption/stable/2018-08-31/consumption.json - - $(this-folder)/Microsoft.Consumption/stable/2018-10-01/consumption.json - - $(this-folder)/Microsoft.Consumption/preview/2017-04-24-preview/consumption.json - - $(this-folder)/Microsoft.Consumption/preview/2017-12-30-preview/consumption.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/containerinstance/resource-manager/readme.md b/specification/containerinstance/resource-manager/readme.md index 6eca258b4fb5..f2c0f633cb1a 100644 --- a/specification/containerinstance/resource-manager/readme.md +++ b/specification/containerinstance/resource-manager/readme.md @@ -178,34 +178,3 @@ See configuration in [readme.typescript.md](./readme.typescript.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.ContainerInstance/stable/2019-12-01/containerInstance.json - - $(this-folder)/Microsoft.ContainerInstance/stable/2018-10-01/containerInstance.json - - $(this-folder)/Microsoft.ContainerInstance/stable/2018-09-01/containerInstance.json - - $(this-folder)/Microsoft.ContainerInstance/stable/2018-06-01/containerInstance.json - - $(this-folder)/Microsoft.ContainerInstance/stable/2018-04-01/containerInstance.json - - $(this-folder)/Microsoft.ContainerInstance/preview/2018-02-01-preview/containerInstance.json - - $(this-folder)/Microsoft.ContainerInstance/preview/2017-12-01-preview/containerInstance.json - - $(this-folder)/Microsoft.ContainerInstance/preview/2017-10-01-preview/containerInstance.json - - $(this-folder)/Microsoft.ContainerInstance/preview/2017-08-01-preview/containerInstance.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/containerregistry/resource-manager/readme.md b/specification/containerregistry/resource-manager/readme.md index ac6dd32aba11..7b1c94e51a3c 100644 --- a/specification/containerregistry/resource-manager/readme.md +++ b/specification/containerregistry/resource-manager/readme.md @@ -216,36 +216,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.ContainerRegistry/preview/2019-12-01-preview/containerregistry.json - - $(this-folder)/Microsoft.ContainerRegistry/preview/2019-06-01-preview/containerregistry_build.json - - $(this-folder)/Microsoft.ContainerRegistry/preview/2019-05-01-preview/containerregistry_scopemap.json - - $(this-folder)/Microsoft.ContainerRegistry/stable/2019-05-01/containerregistry.json - - $(this-folder)/Microsoft.ContainerRegistry/stable/2019-04-01/containerregistry_build.json - - $(this-folder)/Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json - - $(this-folder)/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json - - $(this-folder)/Microsoft.ContainerRegistry/preview/2018-02-01-preview/containerregistry_build.json - - $(this-folder)/Microsoft.ContainerRegistry/preview/2017-06-01-preview/containerregistry.json - - $(this-folder)/Microsoft.ContainerRegistry/stable/2017-03-01/containerregistry.json - - $(this-folder)/Microsoft.ContainerRegistry/preview/2016-06-27-preview/containerregistry.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/containerservice/resource-manager/readme.azureresourceschema.md b/specification/containerservice/resource-manager/readme.azureresourceschema.md index 90ab94bce32e..757d9d5dd16f 100644 --- a/specification/containerservice/resource-manager/readme.azureresourceschema.md +++ b/specification/containerservice/resource-manager/readme.azureresourceschema.md @@ -6,6 +6,7 @@ These settings apply only when `--azureresourceschema` is specified on the comma ``` yaml $(azureresourceschema) && $(multiapi) batch: + - tag: schema-containerservice-2020-09-01 - tag: schema-containerservice-2020-07-01 - tag: schema-containerservice-2020-06-01 - tag: schema-containerservice-2020-04-01 @@ -35,6 +36,17 @@ batch: Please also specify `--azureresourceschema-folder=`. +### Tag: schema-containerservice-2020-09-01 and azureresourceschema + +``` yaml $(tag) == 'schema-containerservice-2020-09-01' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.ContainerService/stable/2020-09-01/managedClusters.json + +``` + ### Tag: schema-containerservice-2020-07-01 and azureresourceschema ``` yaml $(tag) == 'schema-containerservice-2020-07-01' && $(azureresourceschema) diff --git a/specification/containerservice/resource-manager/readme.md b/specification/containerservice/resource-manager/readme.md index 0422a527f0db..b24570f6bfd1 100644 --- a/specification/containerservice/resource-manager/readme.md +++ b/specification/containerservice/resource-manager/readme.md @@ -602,52 +602,3 @@ directive: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json - - $(this-folder)/Microsoft.ContainerService/stable/2017-07-01/containerService.json - - $(this-folder)/Microsoft.ContainerService/stable/2019-08-01/location.json - - $(this-folder)/Microsoft.ContainerService/stable/2020-07-01/managedClusters.json - - $(this-folder)/Microsoft.ContainerService/stable/2020-06-01/managedClusters.json - - $(this-folder)/Microsoft.ContainerService/stable/2020-04-01/managedClusters.json - - $(this-folder)/Microsoft.ContainerService/stable/2020-03-01/managedClusters.json - - $(this-folder)/Microsoft.ContainerService/stable/2020-02-01/managedClusters.json - - $(this-folder)/Microsoft.ContainerService/stable/2020-01-01/managedClusters.json - - $(this-folder)/Microsoft.ContainerService/stable/2019-11-01/managedClusters.json - - $(this-folder)/Microsoft.ContainerService/preview/2019-10-27-preview/openShiftManagedClusters.json - - $(this-folder)/Microsoft.ContainerService/preview/2019-09-30/openShiftManagedClusters.json - - $(this-folder)/Microsoft.ContainerService/stable/2019-08-01/managedClusters.json - - $(this-folder)/Microsoft.ContainerService/stable/2019-10-01/managedClusters.json - - $(this-folder)/Microsoft.ContainerService/stable/2019-06-01/location.json - - $(this-folder)/Microsoft.ContainerService/stable/2019-06-01/managedClusters.json - - $(this-folder)/Microsoft.ContainerService/stable/2019-04-01/managedClusters.json - - $(this-folder)/Microsoft.ContainerService/stable/2019-04-01/location.json - - $(this-folder)/Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json - - $(this-folder)/Microsoft.ContainerService/stable/2019-02-01/managedClusters.json - - $(this-folder)/Microsoft.ContainerService/stable/2017-09-30/location.json - - $(this-folder)/Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json - - $(this-folder)/Microsoft.ContainerService/stable/2018-03-31/managedClusters.json - - $(this-folder)/Microsoft.ContainerService/stable/2017-08-31/managedClusters.json - - $(this-folder)/Microsoft.ContainerService/stable/2017-01-31/containerService.json - - $(this-folder)/Microsoft.ContainerService/stable/2016-09-30/containerService.json - - $(this-folder)/Microsoft.ContainerService/stable/2016-03-30/containerService.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/cosmos-db/resource-manager/readme.md b/specification/cosmos-db/resource-manager/readme.md index 0ca282c6da93..7adb905df487 100644 --- a/specification/cosmos-db/resource-manager/readme.md +++ b/specification/cosmos-db/resource-manager/readme.md @@ -273,43 +273,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json - - $(this-folder)/Microsoft.DocumentDB/preview/2020-06-01-preview/notebook.json - - $(this-folder)/Microsoft.DocumentDB/preview/2019-08-01-preview/privateLinkResources.json - - $(this-folder)/Microsoft.DocumentDB/preview/2019-08-01-preview/privateEndpointConnection.json - - $(this-folder)/Microsoft.DocumentDB/stable/2020-04-01/cosmos-db.json - - $(this-folder)/Microsoft.DocumentDB/stable/2020-04-01/notebook.json - - $(this-folder)/Microsoft.DocumentDB/stable/2020-03-01/cosmos-db.json - - $(this-folder)/Microsoft.DocumentDB/stable/2020-03-01/notebook.json - - $(this-folder)/Microsoft.DocumentDB/stable/2019-12-12/cosmos-db.json - - $(this-folder)/Microsoft.DocumentDB/stable/2019-12-12/notebook.json - - $(this-folder)/Microsoft.DocumentDB/stable/2019-08-01/cosmos-db.json - - $(this-folder)/Microsoft.DocumentDB/stable/2019-08-01/notebook.json - - $(this-folder)/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json - - $(this-folder)/Microsoft.DocumentDB/stable/2014-04-01/cosmos-db.json - - $(this-folder)/Microsoft.DocumentDB/stable/2015-11-06/cosmos-db.json - - $(this-folder)/Microsoft.DocumentDB/stable/2016-03-19/cosmos-db.json - - $(this-folder)/Microsoft.DocumentDB/stable/2016-03-31/cosmos-db.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/cost-management/resource-manager/readme.azureresourceschema.md b/specification/cost-management/resource-manager/readme.azureresourceschema.md index 87d877890c0c..c684505db1d6 100644 --- a/specification/cost-management/resource-manager/readme.azureresourceschema.md +++ b/specification/cost-management/resource-manager/readme.azureresourceschema.md @@ -52,6 +52,7 @@ output-folder: $(azureresourceschema-folder)/schemas # all the input files in this apiVersion input-file: - Microsoft.CostManagement/stable/2019-11-01/costmanagement.json + - Microsoft.CostManagement/stable/2019-11-01/costmanagement.exports.json ``` diff --git a/specification/cost-management/resource-manager/readme.md b/specification/cost-management/resource-manager/readme.md index 505a99a338c0..b8127660918f 100644 --- a/specification/cost-management/resource-manager/readme.md +++ b/specification/cost-management/resource-manager/readme.md @@ -344,36 +344,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.CostManagement/stable/2020-06-01/costmanagement.json - - $(this-folder)/Microsoft.CostManagement/preview/2020-03-01-preview/costallocation.json - - $(this-folder)/Microsoft.CostManagement/stable/2019-11-01/costmanagement.json - - $(this-folder)/Microsoft.CostManagement/stable/2019-10-01/costmanagement.json - - $(this-folder)/Microsoft.CostManagement/stable/2019-09-01/costmanagement.json - - $(this-folder)/Microsoft.CostManagement/preview/2019-04-01-preview/costmanagement.json - - $(this-folder)/Microsoft.CostManagement/stable/2019-01-01/costmanagement.json - - $(this-folder)/Microsoft.CostManagement/preview/2019-03-01-preview/costmanagement.json - - $(this-folder)/Microsoft.CostManagement/stable/2018-05-31/costmanagement.json - - $(this-folder)/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json - - $(this-folder)/Microsoft.CostManagement/preview/2018-12-01-preview/costmanagement.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/cpim/resource-manager/readme.md b/specification/cpim/resource-manager/readme.md index 4396ccf1b2c9..acc5245c5750 100644 --- a/specification/cpim/resource-manager/readme.md +++ b/specification/cpim/resource-manager/readme.md @@ -85,27 +85,3 @@ See configuration in [readme.csharp.md](./readme.csharp.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/cpim.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/customer-insights/resource-manager/readme.md b/specification/customer-insights/resource-manager/readme.md index f22cbd59665a..c75b5444e49c 100644 --- a/specification/customer-insights/resource-manager/readme.md +++ b/specification/customer-insights/resource-manager/readme.md @@ -147,28 +147,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.CustomerInsights/stable/2017-04-26/customer-insights.json - - $(this-folder)/Microsoft.CustomerInsights/stable/2017-01-01/customer-insights.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/customerlockbox/resource-manager/readme.md b/specification/customerlockbox/resource-manager/readme.md index f41a46ae1ca1..0b8ea5704f95 100644 --- a/specification/customerlockbox/resource-manager/readme.md +++ b/specification/customerlockbox/resource-manager/readme.md @@ -85,27 +85,3 @@ See configuration in [readme.csharp.md](./readme.csharp.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.CustomerLockbox/preview/2018-02-28-preview/customerlockbox.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/customproviders/resource-manager/readme.md b/specification/customproviders/resource-manager/readme.md index 3a50bc05cf6e..0574110e0f4b 100644 --- a/specification/customproviders/resource-manager/readme.md +++ b/specification/customproviders/resource-manager/readme.md @@ -97,30 +97,6 @@ See configuration in [readme.trenton.md](./readme.trenton.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.CustomProviders/preview/2018-09-01-preview/customproviders.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - ## cli These settings apply only when `--cli` is specified on the command line. diff --git a/specification/databox/resource-manager/readme.md b/specification/databox/resource-manager/readme.md index 043ce94162c9..019369a3cc14 100644 --- a/specification/databox/resource-manager/readme.md +++ b/specification/databox/resource-manager/readme.md @@ -177,29 +177,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.DataBox/stable/2020-04-01/databox.json - - $(this-folder)/Microsoft.DataBox/stable/2019-09-01/databox.json - - $(this-folder)/Microsoft.DataBox/stable/2018-01-01/databox.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/databoxedge/resource-manager/readme.md b/specification/databoxedge/resource-manager/readme.md index effc04cc665c..94ad3a2423d2 100644 --- a/specification/databoxedge/resource-manager/readme.md +++ b/specification/databoxedge/resource-manager/readme.md @@ -199,29 +199,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.DataBoxEdge/preview/2020-05-01-preview/databoxedge.json - - $(this-folder)/Microsoft.DataBoxEdge/stable/2019-08-01/databoxedge.json - - $(this-folder)/Microsoft.DataBoxEdge/stable/2019-07-01/databoxedge.json - - $(this-folder)/Microsoft.DataBoxEdge/stable/2019-03-01/databoxedge.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/databricks/resource-manager/readme.md b/specification/databricks/resource-manager/readme.md index 5dd1d2e62ce0..bcbfa7452f8f 100644 --- a/specification/databricks/resource-manager/readme.md +++ b/specification/databricks/resource-manager/readme.md @@ -90,27 +90,3 @@ See configuration in [readme.python.md](./readme.python.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Databricks/stable/2018-04-01/databricks.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/datacatalog/resource-manager/readme.md b/specification/datacatalog/resource-manager/readme.md index d8141c0ee469..8a2adf1fe7df 100644 --- a/specification/datacatalog/resource-manager/readme.md +++ b/specification/datacatalog/resource-manager/readme.md @@ -141,27 +141,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.DataCatalog/stable/2016-03-30/datacatalog.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/datafactory/resource-manager/readme.azureresourceschema.md b/specification/datafactory/resource-manager/readme.azureresourceschema.md index d73c49adc290..76766e48c563 100644 --- a/specification/datafactory/resource-manager/readme.azureresourceschema.md +++ b/specification/datafactory/resource-manager/readme.azureresourceschema.md @@ -21,6 +21,13 @@ output-folder: $(azureresourceschema-folder)/schemas # all the input files in this apiVersion input-file: - Microsoft.DataFactory/stable/2018-06-01/datafactory.json + - Microsoft.DataFactory/stable/2018-06-01/entityTypes/DataFlow.json + - Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json + - Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json + - Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json + - Microsoft.DataFactory/stable/2018-06-01/entityTypes/ManagedPrivateEndpoint.json + - Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json + - Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json ``` diff --git a/specification/datafactory/resource-manager/readme.md b/specification/datafactory/resource-manager/readme.md index 764f413e92bb..eb66b97b8020 100644 --- a/specification/datafactory/resource-manager/readme.md +++ b/specification/datafactory/resource-manager/readme.md @@ -207,28 +207,3 @@ directive: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.DataFactory/stable/2018-06-01/datafactory.json - - $(this-folder)/Microsoft.DataFactory/preview/2017-09-01-preview/datafactory.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/datalake-analytics/resource-manager/readme.md b/specification/datalake-analytics/resource-manager/readme.md index 13dc4c7c3e79..1059c9049078 100644 --- a/specification/datalake-analytics/resource-manager/readme.md +++ b/specification/datalake-analytics/resource-manager/readme.md @@ -175,28 +175,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.DataLakeAnalytics/stable/2016-11-01/account.json - - $(this-folder)/Microsoft.DataLakeAnalytics/preview/2015-10-01-preview/account.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/datalake-store/resource-manager/readme.md b/specification/datalake-store/resource-manager/readme.md index 82889495064d..be664c9fa1da 100644 --- a/specification/datalake-store/resource-manager/readme.md +++ b/specification/datalake-store/resource-manager/readme.md @@ -187,28 +187,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.DataLakeStore/stable/2016-11-01/account.json - - $(this-folder)/Microsoft.DataLakeStore/preview/2015-10-01-preview/account.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/datamigration/resource-manager/readme.md b/specification/datamigration/resource-manager/readme.md index 8874cc7a8f43..5050fb4c3c00 100644 --- a/specification/datamigration/resource-manager/readme.md +++ b/specification/datamigration/resource-manager/readme.md @@ -223,129 +223,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/datamigration.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/Commands.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/Common.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourceMySqlTask.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourcePostgreSqlSyncTask.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourceSqlServerTask.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetAzureDbForMySqlTask.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetAzureDbForPostgreSqlSyncTask.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlDbTask.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlMITask.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlMiSyncTask.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlSqlDbSyncTask.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/GetTdeCertificatesSqlTask.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/GetUserTablesSqlSyncTask.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/GetUserTablesSqlTask.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateMySqlAzureDbForMySqlSyncTask.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlDbSyncTask.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlDbTask.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlMITask.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlMiSyncTask.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/Projects.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/Services.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/Tasks.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/TasksCommon.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrationValidation.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/ValidateMigrationInputSqlServerSqlMITask.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/ValidateMigrationInputSqlServerSqlMiSyncTask.json - - $(this-folder)/Microsoft.DataMigration/stable/2018-04-19/definitions/ValidateSyncMigrationInputSqlServerTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/datamigration.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Commands.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Common.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToSourceMySqlTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToSourceSqlServerTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToSourcePostgreSqlSyncTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToTargetAzureDbForMySqlTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToTargetSqlDbTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToTargetSqlMiSyncTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToTargetSqlMITask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToTargetSqlSqlDbSyncTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToTargetAzureDbForPostgreSqlSyncTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/GetUserTablesSqlSyncTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/GetUserTablesSqlTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSchemaSqlServerSqlDbTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateMySqlAzureDbForMySqlSyncTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSqlServerSqlDbSyncTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSqlServerSqlDbTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSqlServerSqlMiSyncTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSqlServerSqlMITask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSsisTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrationValidation.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MongoDbTasks.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/GetTdeCertificatesSqlTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/OracleAzureDbPostgreSqlSyncTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Projects.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ServiceFeatureOCITask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Services.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ServiceTasks.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Tasks.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/TasksCommon.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ValidateMigrationInputSqlServerSqlMITask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ValidateSyncMigrationInputSqlServerTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ValidateMigrationInputSqlServerSqlMiSyncTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-31-preview/datamigration.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/Common.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ConnectToSourceSqlServerTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ConnectToTargetSqlDbTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ConnectToTargetSqlMITask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/GetUserTablesSqlTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/MigrateSqlServerSqlDbTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/MigrateSqlServerSqlMITask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/Projects.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/Services.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/Tasks.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/TasksCommon.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/MigrationValidation.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ValidateMigrationInputSqlServerSqlMITask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-15-preview/datamigration.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/Common.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/ConnectToSourceSqlServerTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/ConnectToTargetSqlDbTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/ConnectToTargetSqlMITask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/GetUserTablesSqlTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/MigrateSqlServerSqlDbTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/MigrateSqlServerSqlMITask.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/Projects.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/Services.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/Tasks.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/TasksCommon.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/MigrationValidation.json - - $(this-folder)/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/ValidateMigrationInputSqlServerSqlMITask.json - - $(this-folder)/Microsoft.DataMigration/preview/2017-11-15-preview/datamigration.json - - $(this-folder)/Microsoft.DataMigration/preview/2017-11-15-preview/definitions/Common.json - - $(this-folder)/Microsoft.DataMigration/preview/2017-11-15-preview/definitions/ConnectToSourceSqlServerTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2017-11-15-preview/definitions/ConnectToTargetSqlDbTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2017-11-15-preview/definitions/GetUserTablesSqlTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2017-11-15-preview/definitions/MigrateSqlServerSqlDbTask.json - - $(this-folder)/Microsoft.DataMigration/preview/2017-11-15-preview/definitions/Projects.json - - $(this-folder)/Microsoft.DataMigration/preview/2017-11-15-preview/definitions/Services.json - - $(this-folder)/Microsoft.DataMigration/preview/2017-11-15-preview/definitions/Tasks.json - - $(this-folder)/Microsoft.DataMigration/preview/2017-11-15-preview/definitions/TasksCommon.json - - $(this-folder)/Microsoft.DataMigration/preview/2017-11-15-preview/definitions/MigrationValidation.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/datashare/resource-manager/readme.md b/specification/datashare/resource-manager/readme.md index 89da194dadc3..ff2f8a2b3183 100644 --- a/specification/datashare/resource-manager/readme.md +++ b/specification/datashare/resource-manager/readme.md @@ -120,27 +120,3 @@ See configuration in [readme.go.md](./readme.go.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.DataShare/preview/2018-11-01-preview/DataShare.json - - $(this-folder)/Microsoft.DataShare/stable/2019-11-01/DataShare.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/deploymentmanager/resource-manager/readme.md b/specification/deploymentmanager/resource-manager/readme.md index 4e01b0264c83..7e56fa895663 100644 --- a/specification/deploymentmanager/resource-manager/readme.md +++ b/specification/deploymentmanager/resource-manager/readme.md @@ -206,28 +206,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.DeploymentManager/preview/2019-11-01-preview/deploymentmanager.json - - $(this-folder)/Microsoft.DeploymentManager/preview/2018-09-01-preview/deploymentmanager.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/desktopvirtualization/resource-manager/readme.md b/specification/desktopvirtualization/resource-manager/readme.md index 5d79f0a477dc..7096c08a98df 100644 --- a/specification/desktopvirtualization/resource-manager/readme.md +++ b/specification/desktopvirtualization/resource-manager/readme.md @@ -112,29 +112,3 @@ See configuration in [readme.ruby.md](./readme.ruby.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json - - $(this-folder)/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json - - $(this-folder)/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/deviceprovisioningservices/resource-manager/readme.azureresourceschema.md b/specification/deviceprovisioningservices/resource-manager/readme.azureresourceschema.md index 6e5d5657731e..307ea4b09f20 100644 --- a/specification/deviceprovisioningservices/resource-manager/readme.azureresourceschema.md +++ b/specification/deviceprovisioningservices/resource-manager/readme.azureresourceschema.md @@ -6,6 +6,8 @@ These settings apply only when `--azureresourceschema` is specified on the comma ``` yaml $(azureresourceschema) && $(multiapi) batch: + - tag: schema-devices-2020-09-01-preview + - tag: schema-devices-2020-03-01 - tag: schema-devices-2020-01-01 - tag: schema-devices-2018-01-22 - tag: schema-devices-2017-11-15 @@ -15,6 +17,28 @@ batch: Please also specify `--azureresourceschema-folder=`. +### Tag: schema-devices-2020-09-01-preview and azureresourceschema + +``` yaml $(tag) == 'schema-devices-2020-09-01-preview' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.Devices/preview/2020-09-01-preview/iotdps.json + +``` + +### Tag: schema-devices-2020-03-01 and azureresourceschema + +``` yaml $(tag) == 'schema-devices-2020-03-01' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.Devices/stable/2020-03-01/iotdps.json + +``` + ### Tag: schema-devices-2020-01-01 and azureresourceschema ``` yaml $(tag) == 'schema-devices-2020-01-01' && $(azureresourceschema) diff --git a/specification/deviceprovisioningservices/resource-manager/readme.md b/specification/deviceprovisioningservices/resource-manager/readme.md index 02fbc7964bbe..1c2ab28cd471 100644 --- a/specification/deviceprovisioningservices/resource-manager/readme.md +++ b/specification/deviceprovisioningservices/resource-manager/readme.md @@ -218,29 +218,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Devices/preview/2017-08-21-preview/iotdps.json - - $(this-folder)/Microsoft.Devices/stable/2017-11-15/iotdps.json - - $(this-folder)/Microsoft.Devices/stable/2018-01-22/iotdps.json - - $(this-folder)/Microsoft.Devices/stable/2020-01-01/iotdps.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/devops/resource-manager/readme.md b/specification/devops/resource-manager/readme.md index 619f05952d10..cc8c568e45df 100644 --- a/specification/devops/resource-manager/readme.md +++ b/specification/devops/resource-manager/readme.md @@ -88,30 +88,6 @@ See configuration in [readme.csharp.md](./readme.csharp.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.DevOps/preview/2019-07-01-preview/devops.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - ## trenton These settings apply only when `--trenton` is specified on the command line. diff --git a/specification/devspaces/resource-manager/readme.md b/specification/devspaces/resource-manager/readme.md index 35a8bf01c518..6444496e7006 100644 --- a/specification/devspaces/resource-manager/readme.md +++ b/specification/devspaces/resource-manager/readme.md @@ -118,30 +118,6 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.DevSpaces/stable/2019-04-01/devspaces.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - ## Suppression ``` yaml directive: diff --git a/specification/devtestlabs/resource-manager/readme.md b/specification/devtestlabs/resource-manager/readme.md index c125824d8e57..48c43e2caf60 100644 --- a/specification/devtestlabs/resource-manager/readme.md +++ b/specification/devtestlabs/resource-manager/readme.md @@ -137,29 +137,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.DevTestLab/stable/2018-09-15/DTL.json - - $(this-folder)/Microsoft.DevTestLab/stable/2016-05-15/DTL.json - - $(this-folder)/Microsoft.DevTestLab/preview/2015-05-21-preview/DTL.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/digitaltwins/resource-manager/readme.azureresourceschema.md b/specification/digitaltwins/resource-manager/readme.azureresourceschema.md index 32aca0b9a388..851a70ff5ed9 100644 --- a/specification/digitaltwins/resource-manager/readme.azureresourceschema.md +++ b/specification/digitaltwins/resource-manager/readme.azureresourceschema.md @@ -6,12 +6,24 @@ These settings apply only when `--azureresourceschema` is specified on the comma ``` yaml $(azureresourceschema) && $(multiapi) batch: + - tag: schema-digitaltwins-2020-10-31 - tag: schema-digitaltwins-2020-03-01-preview ``` Please also specify `--azureresourceschema-folder=`. +### Tag: schema-digitaltwins-2020-10-31 and azureresourceschema + +``` yaml $(tag) == 'schema-digitaltwins-2020-10-31' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json + +``` + ### Tag: schema-digitaltwins-2020-03-01-preview and azureresourceschema ``` yaml $(tag) == 'schema-digitaltwins-2020-03-01-preview' && $(azureresourceschema) diff --git a/specification/digitaltwins/resource-manager/readme.md b/specification/digitaltwins/resource-manager/readme.md index 456d45dee6c9..9b4edd43b37d 100644 --- a/specification/digitaltwins/resource-manager/readme.md +++ b/specification/digitaltwins/resource-manager/readme.md @@ -100,31 +100,6 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json - - $(this-folder)/Microsoft.DigitalTwins/preview/2020-03-01-preview/digitaltwins.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - ## Suppression ``` yaml diff --git a/specification/dnc/resource-manager/readme.md b/specification/dnc/resource-manager/readme.md index 15b1f9550c12..6b1b089bee9f 100644 --- a/specification/dnc/resource-manager/readme.md +++ b/specification/dnc/resource-manager/readme.md @@ -115,27 +115,3 @@ See configuration in [readme.python.md](./readme.python.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/DelegatedNetwork.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/dns/resource-manager/readme.md b/specification/dns/resource-manager/readme.md index ff5240e3224f..5d8de0645a02 100644 --- a/specification/dns/resource-manager/readme.md +++ b/specification/dns/resource-manager/readme.md @@ -231,32 +231,3 @@ input-file: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Network/stable/2018-05-01/dns.json - - $(this-folder)/Microsoft.Network/preview/2018-03-01-preview/dns.json - - $(this-folder)/Microsoft.Network/stable/2017-10-01/dns.json - - $(this-folder)/Microsoft.Network/stable/2017-09-01/dns.json - - $(this-folder)/Microsoft.Network/stable/2016-04-01/dns.json - - $(this-folder)/Microsoft.Network/preview/2015-05-04-preview/dns.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/domainservices/resource-manager/readme.md b/specification/domainservices/resource-manager/readme.md index 02f34c0c5577..a9d111ac2021 100644 --- a/specification/domainservices/resource-manager/readme.md +++ b/specification/domainservices/resource-manager/readme.md @@ -158,31 +158,3 @@ generate-interface: true -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.AAD/stable/2020-01-01/domainservices.json - - $(this-folder)/Microsoft.AAD/stable/2020-01-01/oucontainer.json - - $(this-folder)/Microsoft.AAD/stable/2017-06-01/domainservices.json - - $(this-folder)/Microsoft.AAD/stable/2017-06-01/oucontainer.json - - $(this-folder)/Microsoft.AAD/stable/2017-01-01/domainservices.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/engagementfabric/resource-manager/readme.md b/specification/engagementfabric/resource-manager/readme.md index 887f9e1a092f..c34f5beb220e 100644 --- a/specification/engagementfabric/resource-manager/readme.md +++ b/specification/engagementfabric/resource-manager/readme.md @@ -131,27 +131,3 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-engagementfabric See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.EngagementFabric/preview/2018-09-01/EngagementFabric.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/eventgrid/resource-manager/readme.md b/specification/eventgrid/resource-manager/readme.md index e35224739683..1ba6e68d7af4 100644 --- a/specification/eventgrid/resource-manager/readme.md +++ b/specification/eventgrid/resource-manager/readme.md @@ -205,36 +205,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.EventGrid/stable/2020-06-01/EventGrid.json - - $(this-folder)/Microsoft.EventGrid/preview/2020-04-01-preview/EventGrid.json - - $(this-folder)/Microsoft.EventGrid/preview/2020-01-01-preview/EventGrid.json - - $(this-folder)/Microsoft.EventGrid/stable/2019-06-01/EventGrid.json - - $(this-folder)/Microsoft.EventGrid/preview/2019-02-01-preview/EventGrid.json - - $(this-folder)/Microsoft.EventGrid/stable/2019-01-01/EventGrid.json - - $(this-folder)/Microsoft.EventGrid/preview/2018-09-15-preview/EventGrid.json - - $(this-folder)/Microsoft.EventGrid/preview/2018-05-01-preview/EventGrid.json - - $(this-folder)/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json - - $(this-folder)/Microsoft.EventGrid/preview/2017-09-15-preview/EventGrid.json - - $(this-folder)/Microsoft.EventGrid/preview/2017-06-15-preview/EventGrid.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/eventhub/resource-manager/readme.md b/specification/eventhub/resource-manager/readme.md index b717c083c289..1e0cfd30b013 100644 --- a/specification/eventhub/resource-manager/readme.md +++ b/specification/eventhub/resource-manager/readme.md @@ -157,44 +157,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.EventHub/stable/2017-04-01/AuthorizationRules.json - - $(this-folder)/Microsoft.EventHub/stable/2017-04-01/CheckNameAvailability.json - - $(this-folder)/Microsoft.EventHub/stable/2017-04-01/consumergroups.json - - $(this-folder)/Microsoft.EventHub/stable/2017-04-01/disasterRecoveryConfigs.json - - $(this-folder)/Microsoft.EventHub/stable/2017-04-01/eventhubs.json - - $(this-folder)/Microsoft.EventHub/stable/2017-04-01/namespaces.json - - $(this-folder)/Microsoft.EventHub/stable/2017-04-01/networkRuleSets.json - - $(this-folder)/Microsoft.EventHub/stable/2017-04-01/operations.json - - $(this-folder)/Microsoft.EventHub/stable/2017-04-01/sku.json - - $(this-folder)/Microsoft.EventHub/stable/2015-08-01/EventHub.json - - $(this-folder)/Microsoft.EventHub/stable/2014-09-01/EventHub.json - - $(this-folder)/Microsoft.EventHub/preview/2018-01-01-preview/AvailableClusterRegions-preview.json - - $(this-folder)/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json - - $(this-folder)/Microsoft.EventHub/preview/2018-01-01-preview/ipfilterrules-preview.json - - $(this-folder)/Microsoft.EventHub/preview/2018-01-01-preview/namespaces-preview.json - - $(this-folder)/Microsoft.EventHub/preview/2018-01-01-preview/quotaConfiguration-preview.json - - $(this-folder)/Microsoft.EventHub/preview/2018-01-01-preview/virtualnetworkrules-preview.json - - $(this-folder)/Microsoft.EventHub/preview/2018-01-01-preview/networkrulessets-preview.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/frontdoor/resource-manager/readme.md b/specification/frontdoor/resource-manager/readme.md index ce0e0051fb2b..f7f90e9f4fcf 100644 --- a/specification/frontdoor/resource-manager/readme.md +++ b/specification/frontdoor/resource-manager/readme.md @@ -264,45 +264,3 @@ directive: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Network/stable/2020-05-01/network.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/networkexperiment.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/frontdoor.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/webapplicationfirewall.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/network.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/frontdoor.json - - $(this-folder)/Microsoft.Network/stable/2020-01-01/network.json - - $(this-folder)/Microsoft.Network/stable/2020-01-01/frontdoor.json - - $(this-folder)/Microsoft.Network/stable/2019-10-01/webapplicationfirewall.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/network.json - - $(this-folder)/Microsoft.Network/stable/2019-05-01/frontdoor.json - - $(this-folder)/Microsoft.Network/stable/2019-05-01/network.json - - $(this-folder)/Microsoft.Network/stable/2019-03-01/webapplicationfirewall.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/frontdoor.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/network.json - - $(this-folder)/Microsoft.Network/preview/2018-08-01-preview/frontdoor.json - - $(this-folder)/Microsoft.Network/preview/2018-08-01-preview/network.json - - $(this-folder)/Microsoft.Network/preview/2019-03-01-preview/webapplicationfirewall.json - - $(this-folder)/Microsoft.Network/preview/2018-08-01-preview/webapplicationfirewall.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/guestconfiguration/resource-manager/readme.md b/specification/guestconfiguration/resource-manager/readme.md index 8fba3db7e828..a114e01a1f17 100644 --- a/specification/guestconfiguration/resource-manager/readme.md +++ b/specification/guestconfiguration/resource-manager/readme.md @@ -137,30 +137,3 @@ csharp: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json - - $(this-folder)/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json - - $(this-folder)/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json - - $(this-folder)/Microsoft.GuestConfiguration/preview/2018-01-20-preview/guestconfiguration.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/hanaonazure/resource-manager/readme.md b/specification/hanaonazure/resource-manager/readme.md index 60358b1842ef..eb1b84774518 100644 --- a/specification/hanaonazure/resource-manager/readme.md +++ b/specification/hanaonazure/resource-manager/readme.md @@ -116,28 +116,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json - - $(this-folder)/Microsoft.HanaOnAzure/preview/2020-02-07-preview/hanaonazure.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/hardwaresecuritymodules/resource-manager/readme.md b/specification/hardwaresecuritymodules/resource-manager/readme.md index bb675df38663..422e0f3f94bf 100644 --- a/specification/hardwaresecuritymodules/resource-manager/readme.md +++ b/specification/hardwaresecuritymodules/resource-manager/readme.md @@ -45,29 +45,6 @@ input-file: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.HardwareSecurityModules/preview/2018-10-31-preview/dedicatedhsm.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` # Code Generation diff --git a/specification/hdinsight/resource-manager/readme.md b/specification/hdinsight/resource-manager/readme.md index e1b948548a41..53114925c2bd 100644 --- a/specification/hdinsight/resource-manager/readme.md +++ b/specification/hdinsight/resource-manager/readme.md @@ -215,41 +215,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json - - $(this-folder)/Microsoft.HDInsight/stable/2018-06-01-preview/applications.json - - $(this-folder)/Microsoft.HDInsight/stable/2018-06-01-preview/locations.json - - $(this-folder)/Microsoft.HDInsight/stable/2018-06-01-preview/configurations.json - - $(this-folder)/Microsoft.HDInsight/stable/2018-06-01-preview/extensions.json - - $(this-folder)/Microsoft.HDInsight/stable/2018-06-01-preview/scriptActions.json - - $(this-folder)/Microsoft.HDInsight/stable/2018-06-01-preview/operations.json - - $(this-folder)/Microsoft.HDInsight/stable/2018-06-01-preview/virtualMachines.json - - $(this-folder)/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json - - $(this-folder)/Microsoft.HDInsight/preview/2015-03-01-preview/applications.json - - $(this-folder)/Microsoft.HDInsight/preview/2015-03-01-preview/locations.json - - $(this-folder)/Microsoft.HDInsight/preview/2015-03-01-preview/configurations.json - - $(this-folder)/Microsoft.HDInsight/preview/2015-03-01-preview/extensions.json - - $(this-folder)/Microsoft.HDInsight/preview/2015-03-01-preview/scriptActions.json - - $(this-folder)/Microsoft.HDInsight/preview/2015-03-01-preview/operations.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/healthcareapis/resource-manager/readme.azureresourceschema.md b/specification/healthcareapis/resource-manager/readme.azureresourceschema.md index 79acdb91e0c6..42e1803f9586 100644 --- a/specification/healthcareapis/resource-manager/readme.azureresourceschema.md +++ b/specification/healthcareapis/resource-manager/readme.azureresourceschema.md @@ -6,6 +6,7 @@ These settings apply only when `--azureresourceschema` is specified on the comma ``` yaml $(azureresourceschema) && $(multiapi) batch: + - tag: schema-healthcareapis-2020-03-15 - tag: schema-healthcareapis-2019-09-16 - tag: schema-healthcareapis-2018-08-20-preview @@ -13,6 +14,17 @@ batch: Please also specify `--azureresourceschema-folder=`. +### Tag: schema-healthcareapis-2020-03-15 and azureresourceschema + +``` yaml $(tag) == 'schema-healthcareapis-2020-03-15' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.HealthcareApis/stable/2020-03-15/healthcare-apis.json + +``` + ### Tag: schema-healthcareapis-2019-09-16 and azureresourceschema ``` yaml $(tag) == 'schema-healthcareapis-2019-09-16' && $(azureresourceschema) diff --git a/specification/healthcareapis/resource-manager/readme.md b/specification/healthcareapis/resource-manager/readme.md index 6b873de67d45..43f34c10e10f 100644 --- a/specification/healthcareapis/resource-manager/readme.md +++ b/specification/healthcareapis/resource-manager/readme.md @@ -159,27 +159,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.HealthcareApis/stable/2019-09-16/healthcare-apis.json - - $(this-folder)/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/hybridcompute/resource-manager/readme.md b/specification/hybridcompute/resource-manager/readme.md index 6f44b7cef442..894728ac0028 100644 --- a/specification/hybridcompute/resource-manager/readme.md +++ b/specification/hybridcompute/resource-manager/readme.md @@ -144,32 +144,3 @@ See configuration in [readme.ruby.md](./readme.ruby.md) See configuration in [readme.typescript](./readme.typescript.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json - - $(this-folder)/Microsoft.HybridCompute/preview/2020-08-15-preview/privateLinkScopes.json - - $(this-folder)/Microsoft.HybridCompute/preview/2019-03-18/HybridCompute.json - - $(this-folder)/Microsoft.HybridCompute/preview/2019-08-02/HybridCompute.json - - $(this-folder)/Microsoft.HybridCompute/stable/2019-12-12/HybridCompute.json - - $(this-folder)/Microsoft.HybridCompute/preview/2020-07-30-preview/HybridCompute.json - - $(this-folder)/Microsoft.HybridCompute/stable/2020-08-02/HybridCompute.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/hybriddatamanager/resource-manager/readme.md b/specification/hybriddatamanager/resource-manager/readme.md index 0184fef60e98..d692511784d7 100644 --- a/specification/hybriddatamanager/resource-manager/readme.md +++ b/specification/hybriddatamanager/resource-manager/readme.md @@ -157,28 +157,3 @@ python: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.HybridData/stable/2019-06-01/hybriddata.json - - $(this-folder)/Microsoft.HybridData/stable/2016-06-01/hybriddata.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/hybridkubernetes/resource-manager/readme.md b/specification/hybridkubernetes/resource-manager/readme.md index 096f12a29479..67c0b6f1e6a0 100644 --- a/specification/hybridkubernetes/resource-manager/readme.md +++ b/specification/hybridkubernetes/resource-manager/readme.md @@ -86,26 +86,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/privatepreview/2019-09-01-privatepreview/somefile.json -``` \ No newline at end of file diff --git a/specification/hybridnetwork/resource-manager/readme.md b/specification/hybridnetwork/resource-manager/readme.md index f8bbe17ef2e9..0db26ee67c23 100644 --- a/specification/hybridnetwork/resource-manager/readme.md +++ b/specification/hybridnetwork/resource-manager/readme.md @@ -88,32 +88,3 @@ See configuration in [readme.csharp.md](./readme.csharp.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.HybridNetwork/preview/2020-01-01-preview/common.json - - $(this-folder)/Microsoft.HybridNetwork/preview/2020-01-01-preview/virtualNetworkFunction.json - - $(this-folder)/Microsoft.HybridNetwork/preview/2020-01-01-preview/device.json - - $(this-folder)/Microsoft.HybridNetwork/preview/2020-01-01-preview/operations.json - - $(this-folder)/Microsoft.HybridNetwork/preview/2020-01-01-preview/vendor.json - - $(this-folder)/Microsoft.HybridNetwork/preview/2020-01-01-preview/virtualNetworkFunctionVendors.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/imagebuilder/resource-manager/readme.md b/specification/imagebuilder/resource-manager/readme.md index 641e8d1fe520..1f98ca32f769 100644 --- a/specification/imagebuilder/resource-manager/readme.md +++ b/specification/imagebuilder/resource-manager/readme.md @@ -172,29 +172,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.VirtualMachineImages/stable/2020-02-14/imagebuilder.json - - $(this-folder)/Microsoft.VirtualMachineImages/preview/2019-05-01-preview/imagebuilder.json - - $(this-folder)/Microsoft.VirtualMachineImages/preview/2018-02-01-preview/imagebuilder.json - - $(this-folder)/Microsoft.VirtualMachineImages/preview/2019-02-01-preview/imagebuilder.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/intune/resource-manager/readme.md b/specification/intune/resource-manager/readme.md index c6f9f0bfadba..5c25fc391ffc 100644 --- a/specification/intune/resource-manager/readme.md +++ b/specification/intune/resource-manager/readme.md @@ -94,28 +94,3 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-intune See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Intune/preview/2015-01-14-preview/intune.json - - $(this-folder)/Microsoft.Intune/preview/2015-01-14-privatepreview/intune.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/iotcentral/resource-manager/readme.md b/specification/iotcentral/resource-manager/readme.md index 87d8636674e5..7870e12dbded 100644 --- a/specification/iotcentral/resource-manager/readme.md +++ b/specification/iotcentral/resource-manager/readme.md @@ -138,28 +138,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json - - $(this-folder)/Microsoft.IoTCentral/preview/2017-07-01-privatepreview/iotcentral.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/iothub/resource-manager/readme.azureresourceschema.md b/specification/iothub/resource-manager/readme.azureresourceschema.md index 53f6e9287e78..384ec99b61f0 100644 --- a/specification/iothub/resource-manager/readme.azureresourceschema.md +++ b/specification/iothub/resource-manager/readme.azureresourceschema.md @@ -6,6 +6,7 @@ These settings apply only when `--azureresourceschema` is specified on the comma ``` yaml $(azureresourceschema) && $(multiapi) batch: + - tag: schema-devices-2020-08-01 - tag: schema-devices-2020-07-10-preview - tag: schema-devices-2020-06-15 - tag: schema-devices-2020-04-01 @@ -25,6 +26,17 @@ batch: Please also specify `--azureresourceschema-folder=`. +### Tag: schema-devices-2020-08-01 and azureresourceschema + +``` yaml $(tag) == 'schema-devices-2020-08-01' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.Devices/stable/2020-08-01/iothub.json + +``` + ### Tag: schema-devices-2020-07-10-preview and azureresourceschema ``` yaml $(tag) == 'schema-devices-2020-07-10-preview' && $(azureresourceschema) diff --git a/specification/iothub/resource-manager/readme.md b/specification/iothub/resource-manager/readme.md index 8f6dcc1feef9..229f06971727 100644 --- a/specification/iothub/resource-manager/readme.md +++ b/specification/iothub/resource-manager/readme.md @@ -217,39 +217,3 @@ See configuration in [readme.java.md](./readme.go.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Devices/preview/2020-07-10-preview/iothub.json - - $(this-folder)/Microsoft.Devices/stable/2020-06-15/iothub.json - - $(this-folder)/Microsoft.Devices/stable/2020-04-01/iothub.json - - $(this-folder)/Microsoft.Devices/stable/2020-03-01/iothub.json - - $(this-folder)/Microsoft.Devices/stable/2019-11-04/iothub.json - - $(this-folder)/Microsoft.Devices/preview/2019-07-01-preview/iothub.json - - $(this-folder)/Microsoft.Devices/stable/2019-03-22/iothub.json - - $(this-folder)/Microsoft.Devices/preview/2019-03-22-preview/iothub.json - - $(this-folder)/Microsoft.Devices/preview/2018-12-01-preview/iothub.json - - $(this-folder)/Microsoft.Devices/stable/2018-04-01/iothub.json - - $(this-folder)/Microsoft.Devices/stable/2018-01-22/iothub.json - - $(this-folder)/Microsoft.Devices/stable/2017-07-01/iothub.json - - $(this-folder)/Microsoft.Devices/stable/2017-01-19/iothub.json - - $(this-folder)/Microsoft.Devices/stable/2016-02-03/iothub.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/iotspaces/resource-manager/readme.md b/specification/iotspaces/resource-manager/readme.md index 11823aea46d4..49a0a68b3682 100644 --- a/specification/iotspaces/resource-manager/readme.md +++ b/specification/iotspaces/resource-manager/readme.md @@ -101,27 +101,3 @@ See configuration in [readme.go.md](./readme.go.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.IoTSpaces/preview/2017-10-01-preview/iotspaces.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/keyvault/resource-manager/readme.md b/specification/keyvault/resource-manager/readme.md index 0fec867b1a2c..ae51d5470d93 100644 --- a/specification/keyvault/resource-manager/readme.md +++ b/specification/keyvault/resource-manager/readme.md @@ -151,38 +151,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.KeyVault/stable/2019-09-01/keyvault.json - - $(this-folder)/Microsoft.KeyVault/stable/2019-09-01/providers.json - - $(this-folder)/Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json - - $(this-folder)/Microsoft.KeyVault/preview/2020-04-01-preview/keyvault.json - - $(this-folder)/Microsoft.KeyVault/preview/2020-04-01-preview/providers.json - - $(this-folder)/Microsoft.KeyVault/preview/2020-04-01-preview/secrets.json - - $(this-folder)/Microsoft.KeyVault/preview/2018-02-14-preview/keyvault.json - - $(this-folder)/Microsoft.KeyVault/preview/2018-02-14-preview/providers.json - - $(this-folder)/Microsoft.KeyVault/stable/2018-02-14/keyvault.json - - $(this-folder)/Microsoft.KeyVault/stable/2018-02-14/providers.json - - $(this-folder)/Microsoft.KeyVault/stable/2016-10-01/keyvault.json - - $(this-folder)/Microsoft.KeyVault/stable/2016-10-01/providers.json - - $(this-folder)/Microsoft.KeyVault/stable/2015-06-01/keyvault.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/kubernetesconfiguration/resource-manager/readme.md b/specification/kubernetesconfiguration/resource-manager/readme.md index 0c8018090c07..b4f77c2a7a2f 100644 --- a/specification/kubernetesconfiguration/resource-manager/readme.md +++ b/specification/kubernetesconfiguration/resource-manager/readme.md @@ -85,26 +85,3 @@ See configuration in [readme.csharp.md](./readme.csharp.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.KubernetesConfiguration/preview/2019-11-01-preview/kubernetesconfiguration.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` \ No newline at end of file diff --git a/specification/labservices/resource-manager/readme.md b/specification/labservices/resource-manager/readme.md index efe9d284406e..5e3ead954e9b 100644 --- a/specification/labservices/resource-manager/readme.md +++ b/specification/labservices/resource-manager/readme.md @@ -151,27 +151,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.LabServices/stable/2018-10-15/ML.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/logic/resource-manager/readme.md b/specification/logic/resource-manager/readme.md index dc05370df8a7..b6a7b4699e33 100644 --- a/specification/logic/resource-manager/readme.md +++ b/specification/logic/resource-manager/readme.md @@ -252,34 +252,6 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Logic/stable/2019-05-01/logic.json - - $(this-folder)/Microsoft.Logic/preview/2018-07-01-preview/logic.json - - $(this-folder)/Microsoft.Logic/stable/2016-06-01/logic.json - - $(this-folder)/Microsoft.Logic/preview/2015-08-01-preview/logic.json - - $(this-folder)/Microsoft.Logic/preview/2015-02-01-preview/logic.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - ## trenton These settings apply only when `--trenton` is specified on the command line. diff --git a/specification/machinelearning/resource-manager/readme.md b/specification/machinelearning/resource-manager/readme.md index fbfc02d26cde..bf21f829d033 100644 --- a/specification/machinelearning/resource-manager/readme.md +++ b/specification/machinelearning/resource-manager/readme.md @@ -258,30 +258,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.MachineLearning/stable/2017-01-01/webservices.json - - $(this-folder)/Microsoft.MachineLearning/preview/2016-05-01-preview/commitmentPlans.json - - $(this-folder)/Microsoft.MachineLearning/stable/2016-04-01/workspaces.json - - $(this-folder)/Microsoft.MachineLearning/stable/2019-10-01/workspaces.json - - $(this-folder)/Microsoft.MachineLearning/preview/2016-05-01-preview/webservices.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/machinelearningcompute/resource-manager/readme.md b/specification/machinelearningcompute/resource-manager/readme.md index fa43887fee44..1a5e302eeb77 100644 --- a/specification/machinelearningcompute/resource-manager/readme.md +++ b/specification/machinelearningcompute/resource-manager/readme.md @@ -131,28 +131,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.MachineLearningCompute/preview/2017-08-01-preview/machineLearningCompute.json - - $(this-folder)/Microsoft.MachineLearningCompute/preview/2017-06-01-preview/machineLearningCompute.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/machinelearningexperimentation/resource-manager/readme.md b/specification/machinelearningexperimentation/resource-manager/readme.md index 3f22d68551cb..49d88e3711b6 100644 --- a/specification/machinelearningexperimentation/resource-manager/readme.md +++ b/specification/machinelearningexperimentation/resource-manager/readme.md @@ -118,27 +118,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.MachineLearningExperimentation/preview/2017-05-01-preview/machineLearningExperimentation.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/machinelearningservices/resource-manager/readme.md b/specification/machinelearningservices/resource-manager/readme.md index b966a1de34be..af746a0266f1 100644 --- a/specification/machinelearningservices/resource-manager/readme.md +++ b/specification/machinelearningservices/resource-manager/readme.md @@ -387,39 +387,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.MachineLearningServices/stable/2020-06-01/machineLearningServices.json - - $(this-folder)/Microsoft.MachineLearningServices/preview/2020-05-15-preview/machineLearningServices.json - - $(this-folder)/Microsoft.MachineLearningServices/stable/2020-04-01/machineLearningServices.json - - $(this-folder)/Microsoft.MachineLearningServices/stable/2020-03-01/machineLearningServices.json - - $(this-folder)/Microsoft.MachineLearningServices/stable/2020-01-01/machineLearningServices.json - - $(this-folder)/Microsoft.MachineLearningServices/stable/2019-11-01/machineLearningServices.json - - $(this-folder)/Microsoft.MachineLearningServices/stable/2019-06-01/machineLearningServices.json - - $(this-folder)/Microsoft.MachineLearningServices/stable/2019-05-01/machineLearningServices.json - - $(this-folder)/Microsoft.MachineLearningServices/stable/2018-11-19/machineLearningServices.json - - $(this-folder)/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json - - $(this-folder)/Microsoft.MachineLearningServices/preview/2020-05-01-preview/machineLearningServices.json - - $(this-folder)/Microsoft.MachineLearningServices/preview/2020-04-01-preview/machineLearningServices.json - - $(this-folder)/Microsoft.MachineLearningServices/preview/2020-02-18-preview/machineLearningServices.json - - $(this-folder)/Microsoft.MachineLearningServices/preview/2018-03-01-preview/machineLearningServices.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/maintenance/resource-manager/readme.md b/specification/maintenance/resource-manager/readme.md index a92762d027f6..b1646525c92b 100644 --- a/specification/maintenance/resource-manager/readme.md +++ b/specification/maintenance/resource-manager/readme.md @@ -109,28 +109,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Maintenance/preview/2020-07-01-preview/Maintenance.json - - $(this-folder)/Microsoft.Maintenance/stable/2020-04-01/Maintenance.json - - $(this-folder)/Microsoft.Maintenance/preview/2018-06-01-preview/Maintenance.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/managednetwork/resource-manager/readme.md b/specification/managednetwork/resource-manager/readme.md index f0284d03e6a1..c7aba395d3be 100644 --- a/specification/managednetwork/resource-manager/readme.md +++ b/specification/managednetwork/resource-manager/readme.md @@ -80,25 +80,3 @@ See configuration in [readme.cli.md](./readme.cli.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.ManagedNetwork/preview/2019-06-01-preview/managedNetwork.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/managedservices/resource-manager/readme.md b/specification/managedservices/resource-manager/readme.md index a85ba96d422c..2f2b6ced062b 100644 --- a/specification/managedservices/resource-manager/readme.md +++ b/specification/managedservices/resource-manager/readme.md @@ -121,30 +121,3 @@ See configuration in [readme.go.md](./readme.go.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json - - $(this-folder)/Microsoft.ManagedServices/stable/2019-09-01/managedservices.json - - $(this-folder)/Microsoft.ManagedServices/stable/2019-06-01/managedservices.json - - $(this-folder)/Microsoft.ManagedServices/preview/2019-04-01-preview/managedservices.json - - $(this-folder)/Microsoft.ManagedServices/preview/2018-06-01-preview/managedservices.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/managementgroups/resource-manager/readme.md b/specification/managementgroups/resource-manager/readme.md index 13eda9a91e65..2b9de18f0e63 100644 --- a/specification/managementgroups/resource-manager/readme.md +++ b/specification/managementgroups/resource-manager/readme.md @@ -274,33 +274,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Management/stable/2020-05-01/management.json - - $(this-folder)/Microsoft.Management/stable/2020-02-01/management.json - - $(this-folder)/Microsoft.Management/stable/2019-11-01/management.json - - $(this-folder)/Microsoft.Management/preview/2018-03-01-preview/management.json - - $(this-folder)/Microsoft.Management/preview/2018-01-01-preview/management.json - - $(this-folder)/Microsoft.Management/preview/2017-11-01-preview/management.json - - $(this-folder)/Microsoft.Management/preview/2017-08-31-preview/management.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/managementpartner/resource-manager/readme.md b/specification/managementpartner/resource-manager/readme.md index ae1a91879032..1ee6437e3a9b 100644 --- a/specification/managementpartner/resource-manager/readme.md +++ b/specification/managementpartner/resource-manager/readme.md @@ -103,27 +103,3 @@ See configuration in [readme.go.md](./readme.go.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.ManagementPartner/preview/2018-02-01/ManagementPartner.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/maps/resource-manager/readme.md b/specification/maps/resource-manager/readme.md index ea8338cf46f7..028f371de0f1 100644 --- a/specification/maps/resource-manager/readme.md +++ b/specification/maps/resource-manager/readme.md @@ -230,28 +230,3 @@ directive: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Maps/preview/2020-02-01-preview/maps-management.json - - $(this-folder)/Microsoft.Maps/stable/2017-01-01-preview/maps-management.json - - $(this-folder)/Microsoft.Maps/stable/2018-05-01/maps-management.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/mariadb/resource-manager/readme.md b/specification/mariadb/resource-manager/readme.md index 61fc6d377c47..ae97bb54f0c3 100644 --- a/specification/mariadb/resource-manager/readme.md +++ b/specification/mariadb/resource-manager/readme.md @@ -177,37 +177,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.DBforMariaDB/preview/2018-06-01-preview/mariadb.json - - $(this-folder)/Microsoft.DBforMariaDB/stable/2018-06-01/mariadb.json - - $(this-folder)/Microsoft.DBforMariaDB/stable/2018-06-01/QueryPerformanceInsights.json - - $(this-folder)/Microsoft.DBforMariaDB/stable/2018-06-01/PerformanceRecommendations.json - - $(this-folder)/Microsoft.DBforMariaDB/stable/2018-06-01/PrivateEndpointConnections.json - - $(this-folder)/Microsoft.DBforMariaDB/stable/2018-06-01/PrivateLinkResources.json - - $(this-folder)/Microsoft.DBforMariaDB/stable/2018-06-01/ServerSecurityAlertPolicies.json - - $(this-folder)/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/mariadb.json - - $(this-folder)/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json - - $(this-folder)/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/PrivateLinkResources.json - - $(this-folder)/Microsoft.DBforMariaDB/preview/2020-01-01-privatepreview/DataEncryptionKeys.json - - $(this-folder)/Microsoft.DBforMariaDB/stable/2020-01-01/Servers.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/marketplace/resource-manager/readme.md b/specification/marketplace/resource-manager/readme.md index b860e660ea71..ee69458b990f 100644 --- a/specification/marketplace/resource-manager/readme.md +++ b/specification/marketplace/resource-manager/readme.md @@ -83,27 +83,3 @@ csharp: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Marketplace/stable/2019-12-01/Marketplace.json - - $(this-folder)/Microsoft.Marketplace/stable/2020-01-01/Marketplace.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/marketplaceordering/resource-manager/readme.md b/specification/marketplaceordering/resource-manager/readme.md index 862ab1178325..8b9d60577378 100644 --- a/specification/marketplaceordering/resource-manager/readme.md +++ b/specification/marketplaceordering/resource-manager/readme.md @@ -201,27 +201,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.MarketplaceOrdering/stable/2015-06-01/Agreements.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/mediaservices/resource-manager/readme.md b/specification/mediaservices/resource-manager/readme.md index 8f1b6a467699..034130b45ce3 100644 --- a/specification/mediaservices/resource-manager/readme.md +++ b/specification/mediaservices/resource-manager/readme.md @@ -333,64 +333,3 @@ directive: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Media/stable/2020-05-01/AccountFilters.json - - $(this-folder)/Microsoft.Media/stable/2020-05-01/Accounts.json - - $(this-folder)/Microsoft.Media/stable/2020-05-01/AssetsAndAssetFilters.json - - $(this-folder)/Microsoft.Media/stable/2020-05-01/ContentKeyPolicies.json - - $(this-folder)/Microsoft.Media/stable/2020-05-01/Encoding.json - - $(this-folder)/Microsoft.Media/stable/2020-05-01/StreamingPoliciesAndStreamingLocators.json - - $(this-folder)/Microsoft.Media/stable/2020-05-01/streamingservice.json - - $(this-folder)/Microsoft.Media/stable/2020-05-01/Common.json - - $(this-folder)/Microsoft.Media/stable/2018-07-01/AccountFilters.json - - $(this-folder)/Microsoft.Media/stable/2018-07-01/Accounts.json - - $(this-folder)/Microsoft.Media/stable/2018-07-01/AssetsAndAssetFilters.json - - $(this-folder)/Microsoft.Media/stable/2018-07-01/ContentKeyPolicies.json - - $(this-folder)/Microsoft.Media/stable/2018-07-01/Encoding.json - - $(this-folder)/Microsoft.Media/preview/2020-02-01-preview/MediaGraphs.json - - $(this-folder)/Microsoft.Media/stable/2018-07-01/StreamingPoliciesAndStreamingLocators.json - - $(this-folder)/Microsoft.Media/stable/2018-07-01/streamingservice.json - - $(this-folder)/Microsoft.Media/preview/2019-09-01-preview/MediaGraphs.json - - $(this-folder)/Microsoft.Media/preview/2019-05-01-preview/AccountFilters.json - - $(this-folder)/Microsoft.Media/preview/2019-05-01-preview/Accounts.json - - $(this-folder)/Microsoft.Media/preview/2019-05-01-preview/AssetsAndAssetFilters.json - - $(this-folder)/Microsoft.Media/preview/2019-05-01-preview/Common.json - - $(this-folder)/Microsoft.Media/preview/2019-05-01-preview/ContentKeyPolicies.json - - $(this-folder)/Microsoft.Media/preview/2019-05-01-preview/Encoding.json - - $(this-folder)/Microsoft.Media/preview/2019-05-01-preview/StreamingPoliciesAndStreamingLocators.json - - $(this-folder)/Microsoft.Media/preview/2019-05-01-preview/streamingservice.json - - $(this-folder)/Microsoft.Media/stable/2018-07-01/Common.json - - $(this-folder)/Microsoft.Media/stable/2015-10-01/media.json - - $(this-folder)/Microsoft.Media/preview/2018-03-30-preview/Accounts.json - - $(this-folder)/Microsoft.Media/preview/2018-03-30-preview/Assets.json - - $(this-folder)/Microsoft.Media/preview/2018-03-30-preview/ContentKeyPolicies.json - - $(this-folder)/Microsoft.Media/preview/2018-03-30-preview/Encoding.json - - $(this-folder)/Microsoft.Media/preview/2018-03-30-preview/StreamingPoliciesAndStreamingLocators.json - - $(this-folder)/Microsoft.Media/preview/2018-03-30-preview/streamingservice.json - - $(this-folder)/Microsoft.Media/preview/2018-06-01-preview/Accounts.json - - $(this-folder)/Microsoft.Media/preview/2018-06-01-preview/Assets.json - - $(this-folder)/Microsoft.Media/preview/2018-06-01-preview/ContentKeyPolicies.json - - $(this-folder)/Microsoft.Media/preview/2018-06-01-preview/Encoding.json - - $(this-folder)/Microsoft.Media/preview/2018-06-01-preview/StreamingPoliciesAndStreamingLocators.json - - $(this-folder)/Microsoft.Media/preview/2018-06-01-preview/streamingservice.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/migrate/resource-manager/readme.md b/specification/migrate/resource-manager/readme.md index 87e47b198f28..bb38ec4e0480 100644 --- a/specification/migrate/resource-manager/readme.md +++ b/specification/migrate/resource-manager/readme.md @@ -134,29 +134,3 @@ See configuration in [readme.go.md](./readme.go.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.OffAzure/stable/2020-07-07/migrate.json - - $(this-folder)/Microsoft.Migrate/stable/2018-02-02/migrate.json - - $(this-folder)/Microsoft.Migrate/stable/2019-10-01/migrate.json - - $(this-folder)/Microsoft.OffAzure/stable/2020-01-01/migrate.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/migrateprojects/resource-manager/readme.md b/specification/migrateprojects/resource-manager/readme.md index 79ca82ca7085..3b4299f2cf5d 100644 --- a/specification/migrateprojects/resource-manager/readme.md +++ b/specification/migrateprojects/resource-manager/readme.md @@ -105,27 +105,3 @@ output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-09-01-pr See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Migrate/preview/2018-09-01-preview/migrate.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/mixedreality/resource-manager/readme.md b/specification/mixedreality/resource-manager/readme.md index 100d68142ecd..eec4de896ddd 100644 --- a/specification/mixedreality/resource-manager/readme.md +++ b/specification/mixedreality/resource-manager/readme.md @@ -153,34 +153,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.MixedReality/stable/2020-05-01/proxy.json - - $(this-folder)/Microsoft.MixedReality/stable/2020-05-01/spatial-anchors.json - - $(this-folder)/Microsoft.MixedReality/preview/2020-04-06-preview/remote-rendering.json - - $(this-folder)/Microsoft.MixedReality/preview/2020-04-06-preview/proxy.json - - $(this-folder)/Microsoft.MixedReality/preview/2019-12-02-preview/proxy.json - - $(this-folder)/Microsoft.MixedReality/preview/2019-12-02-preview/remote-rendering.json - - $(this-folder)/Microsoft.MixedReality/preview/2019-12-02-preview/spatial-anchors.json - - $(this-folder)/Microsoft.MixedReality/preview/2019-02-28-preview/mixedreality.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/monitor/resource-manager/readme.md b/specification/monitor/resource-manager/readme.md index f923df3f8a90..77df0e2c6e18 100644 --- a/specification/monitor/resource-manager/readme.md +++ b/specification/monitor/resource-manager/readme.md @@ -633,68 +633,3 @@ input-file: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Insights/preview/2020-05-01-preview/scheduledQueryRule_API.json - - $(this-folder)/Microsoft.Insights/preview/2020-01-01-preview/managementGroupDiagnosticSettings_API.json - - $(this-folder)/Microsoft.Insights/stable/2015-04-01/autoscale_API.json - - $(this-folder)/Microsoft.Insights/stable/2015-04-01/operations_API.json - - $(this-folder)/Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json - - $(this-folder)/Microsoft.Insights/stable/2016-03-01/alertRules_API.json - - $(this-folder)/Microsoft.Insights/stable/2016-03-01/logProfiles_API.json - - $(this-folder)/Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json - - $(this-folder)/Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json - - $(this-folder)/Microsoft.Insights/stable/2019-06-01/actionGroups_API.json - - $(this-folder)/Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json - - $(this-folder)/Microsoft.Insights/stable/2015-04-01/activityLogs_API.json - - $(this-folder)/Microsoft.Insights/stable/2015-04-01/eventCategories_API.json - - $(this-folder)/Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json - - $(this-folder)/Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json - - $(this-folder)/Microsoft.Insights/stable/2018-01-01/metrics_API.json - - $(this-folder)/Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json - - $(this-folder)/Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json - - $(this-folder)/Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json - - $(this-folder)/Microsoft.Insights/stable/2018-03-01/metricAlert_API.json - - $(this-folder)/Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json - - $(this-folder)/Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json - - $(this-folder)/Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json - - $(this-folder)/Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json - - $(this-folder)/Microsoft.Insights/preview/2017-05-01-preview/subscriptionDiagnosticsSettings_API.json - - $(this-folder)/Microsoft.Insights/stable/2019-03-01/actionGroups_API.json - - $(this-folder)/Microsoft.Insights/stable/2018-09-01/actionGroups_API.json - - $(this-folder)/Microsoft.Insights/stable/2018-03-01/actionGroups_API.json - - $(this-folder)/Microsoft.Insights/stable/2017-04-01/actionGroups_API.json - - $(this-folder)/Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json - - $(this-folder)/Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json - - $(this-folder)/Microsoft.Insights/preview/2019-11-01-preview/dataCollectionRuleAssociations_API.json - - $(this-folder)/Microsoft.Insights/preview/2019-11-01-preview/dataCollectionRules_API.json - - $(this-folder)/Microsoft.Insights/stable/2018-09-01/baseline_API.json - - $(this-folder)/Microsoft.Insights/stable/2018-09-01/calculateBaseline_API.json - - $(this-folder)/Microsoft.Insights/preview/2018-06-01-preview/guestDiagnosticSettingsAssociation_API.json - - $(this-folder)/Microsoft.Insights/preview/2018-06-01-preview/guestDiagnosticSettings_API.json - - $(this-folder)/Microsoft.Insights/preview/2017-03-01-preview/activityLogAlerts_API.json - - $(this-folder)/Microsoft.Insights/stable/2016-09-01/metrics_API.json - - $(this-folder)/Microsoft.Insights/stable/2016-09-01/serviceDiagnosticsSettings_API.json - - $(this-folder)/Microsoft.Insights/stable/2016-03-01/metricDefinitions_API.json - - $(this-folder)/Microsoft.Insights/stable/2015-07-01/serviceDiagnosticsSettings_API.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/msi/resource-manager/readme.md b/specification/msi/resource-manager/readme.md index b28f0e3f39cb..5a9b8cdbc7ef 100644 --- a/specification/msi/resource-manager/readme.md +++ b/specification/msi/resource-manager/readme.md @@ -150,28 +150,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.ManagedIdentity/stable/2018-11-30/ManagedIdentity.json - - $(this-folder)/Microsoft.ManagedIdentity/preview/2015-08-31-preview/ManagedIdentity.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/mysql/resource-manager/readme.md b/specification/mysql/resource-manager/readme.md index f7a9793c57bf..f9385b4bab5a 100644 --- a/specification/mysql/resource-manager/readme.md +++ b/specification/mysql/resource-manager/readme.md @@ -181,39 +181,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.DBforMySQL/preview/2017-12-01-preview/mysql.json - - $(this-folder)/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json - - $(this-folder)/Microsoft.DBforMySQL/stable/2017-12-01/ServerSecurityAlertPolicies.json - - $(this-folder)/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/mysql.json - - $(this-folder)/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json - - $(this-folder)/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/PrivateLinkResources.json - - $(this-folder)/Microsoft.DBforMySQL/stable/2018-06-01/QueryPerformanceInsights.json - - $(this-folder)/Microsoft.DBforMySQL/stable/2018-06-01/PerformanceRecommendations.json - - $(this-folder)/Microsoft.DBforMySQL/stable/2018-06-01/PrivateEndpointConnections.json - - $(this-folder)/Microsoft.DBforMySQL/stable/2018-06-01/PrivateLinkResources.json - - $(this-folder)/Microsoft.DBforMySQL/preview/2020-01-01-privatepreview/DataEncryptionKeys.json - - $(this-folder)/Microsoft.DBforMySQL/stable/2020-01-01/DataEncryptionKeys.json - - $(this-folder)/Microsoft.DBforMySQL/stable/2020-01-01/Servers.json - - $(this-folder)/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/netapp/resource-manager/readme.md b/specification/netapp/resource-manager/readme.md index 51a0709b1b27..86dd674a8790 100644 --- a/specification/netapp/resource-manager/readme.md +++ b/specification/netapp/resource-manager/readme.md @@ -160,29 +160,6 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.NetApp/stable/2020-06-01/netapp.json - - $(this-folder)/Microsoft.NetApp/stable/2020-02-01/netapp.json - - $(this-folder)/Microsoft.NetApp/stable/2019-11-01/netapp.json - - $(this-folder)/Microsoft.NetApp/stable/2019-10-01/netapp.json - - $(this-folder)/Microsoft.NetApp/stable/2019-08-01/netapp.json - - $(this-folder)/Microsoft.NetApp/stable/2019-07-01/netapp.json - - $(this-folder)/Microsoft.NetApp/stable/2019-06-01/netapp.json - - $(this-folder)/Microsoft.NetApp/stable/2019-05-01/netapp.json - - $(this-folder)/Microsoft.NetApp/preview/2017-08-15/netapp.json - -``` ## trenton These settings apply only when `--trenton` is specified on the command line. @@ -198,11 +175,3 @@ trenton: clear_output_folder: false ``` -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/network/resource-manager/readme.azureresourceschema.md b/specification/network/resource-manager/readme.azureresourceschema.md index 9b05f08c959c..6664e4a46a7b 100644 --- a/specification/network/resource-manager/readme.azureresourceschema.md +++ b/specification/network/resource-manager/readme.azureresourceschema.md @@ -152,6 +152,7 @@ input-file: - Microsoft.Network/stable/2020-05-01/virtualWan.json - Microsoft.Network/stable/2020-05-01/vmssNetworkInterface.json - Microsoft.Network/stable/2020-05-01/vmssPublicIpAddress.json + - Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json ``` diff --git a/specification/network/resource-manager/readme.md b/specification/network/resource-manager/readme.md index 5211d0e3ddac..f0097e2c0d0e 100644 --- a/specification/network/resource-manager/readme.md +++ b/specification/network/resource-manager/readme.md @@ -1685,948 +1685,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Network/stable/2020-06-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/availableDelegations.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/availableServiceAliases.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/azureFirewall.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/azureFirewallFqdnTag.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/bastionHost.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/customIpPrefix.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/ddosCustomPolicy.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/ddosProtectionPlan.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/dscpConfiguration.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/expressRouteCrossConnection.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/expressRoutePort.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/firewallPolicy.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/ipAllocation.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/ipGroups.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/natGateway.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/network.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/networkProfile.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/networkVirtualAppliance.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/privateEndpoint.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/privateLinkService.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/publicIpPrefix.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/securityPartnerProvider.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/serviceEndpointPolicy.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/serviceTags.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/virtualNetworkTap.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/virtualRouter.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/virtualWan.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2020-06-01/webapplicationfirewall.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/availableDelegations.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/availableServiceAliases.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/azureFirewall.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/azureFirewallFqdnTag.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/bastionHost.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/ddosCustomPolicy.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/ddosProtectionPlan.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/expressRouteCrossConnection.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/expressRoutePort.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/firewallPolicy.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/ipAllocation.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/ipGroups.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/natGateway.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/network.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/networkProfile.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/networkVirtualAppliance.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/privateEndpoint.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/privateLinkService.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/publicIpPrefix.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/securityPartnerProvider.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/serviceEndpointPolicy.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/serviceTags.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/virtualNetworkTap.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/virtualRouter.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/virtualWan.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/availableDelegations.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/availableServiceAliases.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/azureFirewall.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/azureFirewallFqdnTag.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/bastionHost.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/ddosCustomPolicy.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/ddosProtectionPlan.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/expressRouteCrossConnection.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/expressRoutePort.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/firewallPolicy.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/ipAllocation.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/ipGroups.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/natGateway.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/network.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/networkProfile.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/networkVirtualAppliance.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/privateEndpoint.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/privateLinkService.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/publicIpPrefix.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/securityPartnerProvider.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/serviceEndpointPolicy.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/serviceTags.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/virtualNetworkTap.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/virtualRouter.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/virtualWan.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2020-04-01/webapplicationfirewall.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/availableDelegations.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/availableServiceAliases.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/azureFirewall.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/azureFirewallFqdnTag.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/bastionHost.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/ddosCustomPolicy.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/ddosProtectionPlan.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/expressRouteCrossConnection.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/expressRoutePort.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/firewallPolicy.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/ipAllocation.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/ipGroups.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/natGateway.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/network.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/networkProfile.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/networkVirtualAppliance.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/privateEndpoint.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/privateLinkService.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/publicIpPrefix.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/securityPartnerProvider.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/serviceEndpointPolicy.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/serviceTags.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/virtualNetworkTap.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/virtualRouter.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/virtualWan.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2020-03-01/webapplicationfirewall.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/availableDelegations.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/availableServiceAliases.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/azureFirewall.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/azureFirewallFqdnTag.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/bastionHost.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/ddosCustomPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/ddosProtectionPlan.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/expressRouteCrossConnection.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/expressRouteGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/expressRoutePort.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/firewallPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/ipGroups.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/natGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/network.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/networkProfile.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/networkVirtualAppliance.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/privateEndpoint.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/privateLinkService.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/publicIpPrefix.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/serviceEndpointPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/serviceTags.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/virtualNetworkTap.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/virtualRouter.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/virtualWan.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2019-12-01/webapplicationfirewall.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/availableDelegations.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/availableServiceAliases.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/azureFirewall.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/azureFirewallFqdnTag.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/bastionHost.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/ddosCustomPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/ddosProtectionPlan.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/expressRouteCrossConnection.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/expressRouteGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/expressRoutePort.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/firewallPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/ipGroups.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/natGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/network.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/networkProfile.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/privateEndpoint.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/privateLinkService.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/publicIpPrefix.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/serviceEndpointPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/serviceTags.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/virtualNetworkTap.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/virtualRouter.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/virtualWan.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2019-11-01/webapplicationfirewall.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/availableDelegations.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/availableServiceAliases.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/azureFirewall.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/azureFirewallFqdnTag.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/bastionHost.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/ddosCustomPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/ddosProtectionPlan.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/expressRouteCrossConnection.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/expressRouteGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/expressRoutePort.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/firewallPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/ipGroups.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/natGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/network.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/networkProfile.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/networkWatcherConnectionMonitorV1.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/privateEndpoint.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/privateLinkService.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/publicIpPrefix.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/serviceEndpointPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/serviceTags.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/virtualNetworkTap.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/virtualRouter.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/virtualWan.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2019-09-01/webapplicationfirewall.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/availableDelegations.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/availableServiceAliases.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/azureFirewall.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/azureFirewallFqdnTag.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/bastionHost.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/ddosCustomPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/ddosProtectionPlan.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/expressRouteCrossConnection.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/expressRouteGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/expressRoutePort.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/firewallPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/natGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/network.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/networkProfile.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/networkWatcherConnectionMonitorV1.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/privateEndpoint.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/privateLinkService.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/publicIpPrefix.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/serviceEndpointPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/serviceTags.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/virtualNetworkTap.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/virtualRouter.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/virtualWan.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2019-08-01/webapplicationfirewall.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/availableDelegations.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/azureFirewall.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/azureFirewallFqdnTag.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/bastionHost.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/ddosCustomPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/ddosProtectionPlan.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/expressRouteCrossConnection.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/expressRouteGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/expressRoutePort.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/firewallPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/natGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/network.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/networkProfile.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/networkWatcherConnectionMonitorV1.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/privateEndpoint.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/privateLinkService.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/publicIpPrefix.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/serviceEndpointPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/serviceTags.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/virtualNetworkTap.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/virtualRouter.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/virtualWan.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2019-07-01/webapplicationfirewall.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/availableDelegations.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/azureFirewall.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/azureFirewallFqdnTag.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/bastionHost.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/ddosCustomPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/ddosProtectionPlan.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/expressRouteCrossConnection.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/expressRouteGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/expressRoutePort.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/firewallPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/natGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/network.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/networkProfile.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/networkWatcherConnectionMonitorV1.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/privateEndpoint.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/privateLinkService.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/publicIpPrefix.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/serviceEndpointPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/serviceTags.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/virtualNetworkTap.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/virtualWan.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2019-06-01/webapplicationfirewall.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/availableDelegations.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/azureFirewall.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/azureFirewallFqdnTag.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/bastionHost.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/ddosCustomPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/ddosProtectionPlan.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/expressRouteCrossConnection.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/expressRouteGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/expressRoutePort.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/privateEndpoint.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/privateLinkService.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/natGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/network.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/networkProfile.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/publicIpPrefix.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/serviceEndpointPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/serviceTags.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/virtualNetworkTap.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/virtualWan.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2019-04-01/webapplicationfirewall.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/availableDelegations.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/azureFirewall.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/azureFirewallFqdnTag.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/ddosCustomPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/ddosProtectionPlan.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/expressRouteCrossConnection.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/expressRouteGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/expressRoutePort.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/interfaceEndpoint.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/natGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/network.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/networkProfile.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/publicIpPrefix.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/serviceEndpointPolicy.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/virtualNetworkTap.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/virtualWan.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2019-02-01/webapplicationfirewall.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/availableDelegations.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/azureFirewall.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/azureFirewallFqdnTag.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/ddosCustomPolicy.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/ddosProtectionPlan.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/expressRouteCrossConnection.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/expressRouteGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/expressRoutePort.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/interfaceEndpoint.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/network.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/networkProfile.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/publicIpPrefix.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/serviceEndpointPolicy.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/virtualNetworkTap.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/virtualWan.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2018-12-01/webapplicationfirewall.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/availableDelegations.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/azureFirewall.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/azureFirewallFqdnTag.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/ddosCustomPolicy.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/ddosProtectionPlan.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/expressRouteCrossConnection.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/expressRouteGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/expressRoutePort.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/interfaceEndpoint.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/network.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/networkProfile.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/publicIpPrefix.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/serviceEndpointPolicy.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/virtualNetworkTap.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/virtualWan.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2018-11-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/availableDelegations.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/azureFirewall.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/azureFirewallFqdnTag.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/ddosProtectionPlan.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/expressRouteCrossConnection.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/expressRouteGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/expressRoutePort.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/interfaceEndpoint.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/network.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/networkProfile.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/publicIpPrefix.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/serviceEndpointPolicy.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/virtualNetworkTap.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/virtualWan.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2018-10-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/availableDelegations.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/azureFirewall.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/azureFirewallFqdnTag.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/ddosProtectionPlan.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/expressRouteCrossConnection.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/expressRouteGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/expressRoutePort.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/interfaceEndpoint.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/network.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/networkProfile.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/publicIpPrefix.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/serviceEndpointPolicy.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/virtualNetworkTap.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/virtualWan.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2018-08-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/azureFirewall.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/ddosProtectionPlan.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/expressRouteCrossConnection.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/network.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/publicIpPrefix.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/virtualWan.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2018-07-01/serviceEndpointPolicy.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/azureFirewall.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/ddosProtectionPlan.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/expressRouteCrossConnection.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/network.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/virtualWan.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2018-06-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/azureFirewall.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/ddosProtectionPlan.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/expressRouteCrossConnection.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/network.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/virtualWan.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2018-04-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/ddosProtectionPlan.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/expressRouteCrossConnection.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/network.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2018-01-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-01-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2018-01-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2018-01-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2018-01-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2018-01-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2018-01-01/network.json - - $(this-folder)/Microsoft.Network/stable/2018-01-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2018-01-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2018-01-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2018-01-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2018-01-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2018-01-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2018-01-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2018-01-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2018-01-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2018-01-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2018-01-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2018-01-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2018-01-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2017-11-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2017-11-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2017-11-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2017-11-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2017-11-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2017-11-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2017-11-01/network.json - - $(this-folder)/Microsoft.Network/stable/2017-11-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2017-11-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2017-11-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2017-11-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2017-11-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2017-11-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2017-11-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2017-11-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2017-11-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2017-11-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2017-11-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2017-11-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2017-11-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2017-10-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2017-10-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2017-10-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2017-10-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2017-10-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2017-10-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2017-10-01/network.json - - $(this-folder)/Microsoft.Network/stable/2017-10-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2017-10-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2017-10-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2017-10-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2017-10-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2017-10-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2017-10-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2017-10-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2017-10-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2017-10-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2017-10-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2017-10-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2017-10-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2017-09-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2017-09-01/applicationSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2017-09-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2017-09-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2017-09-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2017-09-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2017-09-01/network.json - - $(this-folder)/Microsoft.Network/stable/2017-09-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2017-09-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2017-09-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2017-09-01/operation.json - - $(this-folder)/Microsoft.Network/stable/2017-09-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2017-09-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2017-09-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2017-09-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2017-09-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2017-09-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2017-09-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2017-09-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2017-09-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2017-08-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2017-08-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2017-08-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2017-08-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2017-08-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2017-08-01/network.json - - $(this-folder)/Microsoft.Network/stable/2017-08-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2017-08-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2017-08-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2017-08-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2017-08-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2017-08-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2017-08-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2017-08-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2017-08-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2017-08-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2017-08-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2017-08-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2017-06-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2017-06-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2017-06-01/endpointService.json - - $(this-folder)/Microsoft.Network/stable/2017-06-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2017-06-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2017-06-01/network.json - - $(this-folder)/Microsoft.Network/stable/2017-06-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2017-06-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2017-06-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2017-06-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2017-06-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2017-06-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2017-06-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2017-06-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2017-06-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2017-06-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2017-06-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2017-06-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2017-03-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2017-03-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2017-03-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2017-03-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2017-03-01/network.json - - $(this-folder)/Microsoft.Network/stable/2017-03-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2017-03-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2017-03-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2017-03-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2017-03-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2017-03-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2017-03-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2017-03-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2017-03-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2017-03-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2017-03-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2017-03-01/vmssPublicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2016-12-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2016-12-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2016-12-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2016-12-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2016-12-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2016-12-01/network.json - - $(this-folder)/Microsoft.Network/stable/2016-12-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2016-12-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2016-12-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2016-12-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2016-12-01/routeFilter.json - - $(this-folder)/Microsoft.Network/stable/2016-12-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2016-12-01/serviceCommunity.json - - $(this-folder)/Microsoft.Network/stable/2016-12-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2016-12-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2016-12-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2016-09-01/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/stable/2016-09-01/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2016-09-01/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2016-09-01/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2016-09-01/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2016-09-01/network.json - - $(this-folder)/Microsoft.Network/stable/2016-09-01/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2016-09-01/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2016-09-01/networkWatcher.json - - $(this-folder)/Microsoft.Network/stable/2016-09-01/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2016-09-01/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2016-09-01/usage.json - - $(this-folder)/Microsoft.Network/stable/2016-09-01/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2016-09-01/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2016-06-01/network.json - - $(this-folder)/Microsoft.Network/stable/2016-03-30/network.json - - $(this-folder)/Microsoft.Network/stable/2015-06-15/applicationGateway.json - - $(this-folder)/Microsoft.Network/stable/2015-06-15/checkDnsAvailability.json - - $(this-folder)/Microsoft.Network/stable/2015-06-15/expressRouteCircuit.json - - $(this-folder)/Microsoft.Network/stable/2015-06-15/loadBalancer.json - - $(this-folder)/Microsoft.Network/stable/2015-06-15/network.json - - $(this-folder)/Microsoft.Network/stable/2015-06-15/networkInterface.json - - $(this-folder)/Microsoft.Network/stable/2015-06-15/networkSecurityGroup.json - - $(this-folder)/Microsoft.Network/stable/2015-06-15/publicIpAddress.json - - $(this-folder)/Microsoft.Network/stable/2015-06-15/routeTable.json - - $(this-folder)/Microsoft.Network/stable/2015-06-15/usage.json - - $(this-folder)/Microsoft.Network/stable/2015-06-15/virtualNetwork.json - - $(this-folder)/Microsoft.Network/stable/2015-06-15/virtualNetworkGateway.json - - $(this-folder)/Microsoft.Network/stable/2015-06-15/vmssNetworkInterface.json - - $(this-folder)/Microsoft.Network/preview/2015-05-01-preview/network.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/notificationhubs/resource-manager/readme.md b/specification/notificationhubs/resource-manager/readme.md index ca971fb4f0ce..799fd3c01789 100644 --- a/specification/notificationhubs/resource-manager/readme.md +++ b/specification/notificationhubs/resource-manager/readme.md @@ -213,29 +213,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json - - $(this-folder)/Microsoft.NotificationHubs/stable/2016-03-01/notificationhubs.json - - $(this-folder)/Microsoft.NotificationHubs/stable/2014-09-01/notificationhubs.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/operationalinsights/resource-manager/readme.md b/specification/operationalinsights/resource-manager/readme.md index 694b89a767e1..002899d9fe81 100644 --- a/specification/operationalinsights/resource-manager/readme.md +++ b/specification/operationalinsights/resource-manager/readme.md @@ -218,71 +218,3 @@ directive: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.OperationalInsights/preview/2015-11-01-preview/LinkedServices.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2015-11-01-preview/OperationalInsights.json - - $(this-folder)/Microsoft.OperationalInsights/stable/2015-03-20/OperationalInsights.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2019-08-01-preview/Clusters.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2019-08-01-preview/LinkedServices.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2019-08-01-preview/OperationalInsights.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2020-03-01-preview/DataExports.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2020-03-01-preview/DataSources.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2020-03-01-preview/DataCollectorLogs.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2020-03-01-preview/IntelligencePacks.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2020-03-01-preview/LinkedServices.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2020-03-01-preview/LinkedStorageAccounts.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2020-03-01-preview/ManagementGroups.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2020-03-01-preview/Operations.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2020-03-01-preview/OperationStatuses.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2020-03-01-preview/SharedKeys.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2020-03-01-preview/Usages.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2020-03-01-preview/Workspaces.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2020-03-01-preview/Clusters.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2020-03-01-preview/StorageInsightConfigs.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2020-03-01-preview/SavedSearches.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2020-03-01-preview/AvailableServiceTiers.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2020-03-01-preview/Gateways.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2020-03-01-preview/Schema.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2020-03-01-preview/WorkspacePurge.json - - $(this-folder)/Microsoft.OperationalInsights/preview/2020-03-01-preview/Tables.json - - $(this-folder)/Microsoft.OperationalInsights/stable/2020-08-01/DataExports.json - - $(this-folder)/Microsoft.OperationalInsights/stable/2020-08-01/DataSources.json - - $(this-folder)/Microsoft.OperationalInsights/stable/2020-08-01/IntelligencePacks.json - - $(this-folder)/Microsoft.OperationalInsights/stable/2020-08-01/LinkedServices.json - - $(this-folder)/Microsoft.OperationalInsights/stable/2020-08-01/LinkedStorageAccounts.json - - $(this-folder)/Microsoft.OperationalInsights/stable/2020-08-01/ManagementGroups.json - - $(this-folder)/Microsoft.OperationalInsights/stable/2020-08-01/Operations.json - - $(this-folder)/Microsoft.OperationalInsights/stable/2020-08-01/OperationStatuses.json - - $(this-folder)/Microsoft.OperationalInsights/stable/2020-08-01/SharedKeys.json - - $(this-folder)/Microsoft.OperationalInsights/stable/2020-08-01/Usages.json - - $(this-folder)/Microsoft.OperationalInsights/stable/2020-08-01/Workspaces.json - - $(this-folder)/Microsoft.OperationalInsights/stable/2020-08-01/Clusters.json - - $(this-folder)/Microsoft.OperationalInsights/stable/2020-08-01/StorageInsightConfigs.json - - $(this-folder)/Microsoft.OperationalInsights/stable/2020-08-01/SavedSearches.json - - $(this-folder)/Microsoft.OperationalInsights/stable/2020-08-01/AvailableServiceTiers.json - - $(this-folder)/Microsoft.OperationalInsights/stable/2020-08-01/Gateways.json - - $(this-folder)/Microsoft.OperationalInsights/stable/2020-08-01/Schema.json - - $(this-folder)/Microsoft.OperationalInsights/stable/2020-08-01/WorkspacePurge.json - - $(this-folder)/Microsoft.OperationalInsights/stable/2020-08-01/Tables.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/operationsmanagement/resource-manager/readme.md b/specification/operationsmanagement/resource-manager/readme.md index 01dba6923780..f4f947c62ed6 100644 --- a/specification/operationsmanagement/resource-manager/readme.md +++ b/specification/operationsmanagement/resource-manager/readme.md @@ -129,27 +129,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.OperationsManagement/preview/2015-11-01-preview/OperationsManagement.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/peering/resource-manager/readme.md b/specification/peering/resource-manager/readme.md index d615f9f5d5ec..6b7fc65c805f 100644 --- a/specification/peering/resource-manager/readme.md +++ b/specification/peering/resource-manager/readme.md @@ -126,29 +126,3 @@ See configuration in [readme.cli.md](./readme.cli.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Peering/stable/2020-04-01/peering.json - - $(this-folder)/Microsoft.Peering/preview/2020-01-01-preview/peering.json - - $(this-folder)/Microsoft.Peering/preview/2019-09-01-preview/peering.json - - $(this-folder)/Microsoft.Peering/preview/2019-08-01-preview/peering.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -# exclude-file: -#- $(this-folder)/Microsoft.Peering/preview/2019-06-01-preview/peering.json -``` diff --git a/specification/policyinsights/resource-manager/readme.md b/specification/policyinsights/resource-manager/readme.md index c6dcf11c08eb..f347aea242be 100644 --- a/specification/policyinsights/resource-manager/readme.md +++ b/specification/policyinsights/resource-manager/readme.md @@ -241,36 +241,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyTrackedResources.json - - $(this-folder)/Microsoft.PolicyInsights/stable/2019-07-01/remediations.json - - $(this-folder)/Microsoft.PolicyInsights/stable/2019-10-01/policyEvents.json - - $(this-folder)/Microsoft.PolicyInsights/stable/2019-10-01/policyStates.json - - $(this-folder)/Microsoft.PolicyInsights/stable/2019-10-01/policyMetadata.json - - $(this-folder)/Microsoft.PolicyInsights/preview/2018-07-01-preview/remediations.json - - $(this-folder)/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyEvents.json - - $(this-folder)/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyStates.json - - $(this-folder)/Microsoft.PolicyInsights/stable/2018-04-04/policyEvents.json - - $(this-folder)/Microsoft.PolicyInsights/stable/2018-04-04/policyStates.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/portal/resource-manager/readme.azureresourceschema.md b/specification/portal/resource-manager/readme.azureresourceschema.md index 6667c9568420..fffdb3030891 100644 --- a/specification/portal/resource-manager/readme.azureresourceschema.md +++ b/specification/portal/resource-manager/readme.azureresourceschema.md @@ -6,6 +6,7 @@ These settings apply only when `--azureresourceschema` is specified on the comma ``` yaml $(azureresourceschema) && $(multiapi) batch: + - tag: schema-portal-2020-09-01-preview - tag: schema-portal-2019-01-01-preview - tag: schema-portal-2018-10-01-preview - tag: schema-portal-2015-08-01-preview @@ -14,6 +15,18 @@ batch: Please also specify `--azureresourceschema-folder=`. +### Tag: schema-portal-2020-09-01-preview and azureresourceschema + +``` yaml $(tag) == 'schema-portal-2020-09-01-preview' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.Portal/preview/2020-09-01-preview/portal.json + - Microsoft.Portal/preview/2020-09-01-preview/tenantConfiguration.json + +``` + ### Tag: schema-portal-2019-01-01-preview and azureresourceschema ``` yaml $(tag) == 'schema-portal-2019-01-01-preview' && $(azureresourceschema) @@ -22,6 +35,7 @@ output-folder: $(azureresourceschema-folder)/schemas # all the input files in this apiVersion input-file: - Microsoft.Portal/preview/2019-01-01-preview/portal.json + - Microsoft.Portal/preview/2019-01-01-preview/tenantConfiguration.json ``` diff --git a/specification/portal/resource-manager/readme.md b/specification/portal/resource-manager/readme.md index 1feda99144f3..fdcd1c9aa704 100644 --- a/specification/portal/resource-manager/readme.md +++ b/specification/portal/resource-manager/readme.md @@ -120,29 +120,3 @@ See configuration in [readme.nodejs.md](./readme.nodejs.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Portal/preview/2019-01-01-preview/portal.json - - $(this-folder)/Microsoft.Portal/preview/2019-01-01-preview/tenantConfiguration.json - - $(this-folder)/Microsoft.Portal/preview/2018-10-01-preview/portal.json - - $(this-folder)/Microsoft.Portal/preview/2015-08-01-preview/portal.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/postgresql/resource-manager/readme.md b/specification/postgresql/resource-manager/readme.md index 8f4c2a2300e7..583f1c230d97 100644 --- a/specification/postgresql/resource-manager/readme.md +++ b/specification/postgresql/resource-manager/readme.md @@ -174,35 +174,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/postgresql.json - - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2020-01-01-privatepreview/DataEncryptionKeys.json - - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json - - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2017-12-01/ServerSecurityAlertPolicies.json - - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2018-06-01/PrivateEndpointConnections.json - - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2018-06-01/PrivateLinkResources.json - - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2020-01-01/DataEncryptionKeys.json - - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json - - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2018-06-01-privatepreview/PrivateLinkResources.json - - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/powerbidedicated/resource-manager/readme.md b/specification/powerbidedicated/resource-manager/readme.md index ce7861a7f87a..84b2d74562ab 100644 --- a/specification/powerbidedicated/resource-manager/readme.md +++ b/specification/powerbidedicated/resource-manager/readme.md @@ -122,27 +122,3 @@ See configuration in [readme.python.md](./readme.python.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.PowerBIdedicated/stable/2017-10-01/powerbidedicated.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/powerbiembedded/resource-manager/readme.md b/specification/powerbiembedded/resource-manager/readme.md index ec04459cdfa5..58f6019c622f 100644 --- a/specification/powerbiembedded/resource-manager/readme.md +++ b/specification/powerbiembedded/resource-manager/readme.md @@ -120,27 +120,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.PowerBI/stable/2016-01-29/powerbiembedded.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/powerplatform/resource-manager/readme.azureresourceschema.md b/specification/powerplatform/resource-manager/readme.azureresourceschema.md new file mode 100644 index 000000000000..64638bcc3540 --- /dev/null +++ b/specification/powerplatform/resource-manager/readme.azureresourceschema.md @@ -0,0 +1,27 @@ +## AzureResourceSchema + +These settings apply only when `--azureresourceschema` is specified on the command line. + +### AzureResourceSchema multi-api + +``` yaml $(azureresourceschema) && $(multiapi) +batch: + - tag: schema-powerplatform-2020-10-30-preview + +``` + +Please also specify `--azureresourceschema-folder=`. + +### Tag: schema-powerplatform-2020-10-30-preview and azureresourceschema + +``` yaml $(tag) == 'schema-powerplatform-2020-10-30-preview' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.PowerPlatform/preview/2020-10-30-preview/enterprisePolicy.json + - Microsoft.PowerPlatform/preview/2020-10-30-preview/privateEndpointConnection.json + - Microsoft.PowerPlatform/preview/2020-10-30-preview/privateLinkResources.json + - Microsoft.PowerPlatform/preview/2020-10-30-preview/subnetResources.json + +``` diff --git a/specification/privatedns/resource-manager/readme.md b/specification/privatedns/resource-manager/readme.md index 903eec7e021a..8b094cceacfc 100644 --- a/specification/privatedns/resource-manager/readme.md +++ b/specification/privatedns/resource-manager/readme.md @@ -142,27 +142,3 @@ directive: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Network/stable/2018-09-01/privatedns.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/recoveryservices/resource-manager/readme.md b/specification/recoveryservices/resource-manager/readme.md index cc9d01439c78..8beb9220bec3 100644 --- a/specification/recoveryservices/resource-manager/readme.md +++ b/specification/recoveryservices/resource-manager/readme.md @@ -139,30 +139,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.RecoveryServices/stable/2016-06-01/registeredidentities.json - - $(this-folder)/Microsoft.RecoveryServices/stable/2016-06-01/replicationusages.json - - $(this-folder)/Microsoft.RecoveryServices/stable/2016-06-01/vaults.json - - $(this-folder)/Microsoft.RecoveryServices/stable/2016-06-01/vaultusages.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/recoveryservicesbackup/resource-manager/readme.md b/specification/recoveryservicesbackup/resource-manager/readme.md index e52138ea1368..31a1b9b4d5c3 100644 --- a/specification/recoveryservicesbackup/resource-manager/readme.md +++ b/specification/recoveryservicesbackup/resource-manager/readme.md @@ -199,35 +199,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.RecoveryServices/stable/2020-07-01/bms.json - - $(this-folder)/Microsoft.RecoveryServices/stable/2020-02-02/bms.json - - $(this-folder)/Microsoft.RecoveryServices/stable/2019-06-15/bms.json - - $(this-folder)/Microsoft.RecoveryServices/stable/2017-07-01/bms.json - - $(this-folder)/Microsoft.RecoveryServices/stable/2016-12-01/bms.json - - $(this-folder)/Microsoft.RecoveryServices/stable/2016-08-10/operations.json - - $(this-folder)/Microsoft.RecoveryServices/stable/2019-05-13/bms.json - - $(this-folder)/Microsoft.RecoveryServices/stable/2018-12-20/bms.json - - $(this-folder)/Microsoft.RecoveryServices/stable/2016-06-01/recoveryservicesbackup.json - - $(this-folder)/Microsoft.RecoveryServices/stable/2016-06-01/registeredIdentities.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/recoveryservicessiterecovery/resource-manager/readme.md b/specification/recoveryservicessiterecovery/resource-manager/readme.md index 60c7cabd6ef9..4433d2f58926 100644 --- a/specification/recoveryservicessiterecovery/resource-manager/readme.md +++ b/specification/recoveryservicessiterecovery/resource-manager/readme.md @@ -133,29 +133,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.RecoveryServices/stable/2018-07-10/service.json - - $(this-folder)/Microsoft.RecoveryServices/stable/2018-01-10/service.json - - $(this-folder)/Microsoft.RecoveryServices/stable/2016-08-10/service.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/redhatopenshift/resource-manager/readme.md b/specification/redhatopenshift/resource-manager/readme.md index 20385174823d..291be7e51d7c 100644 --- a/specification/redhatopenshift/resource-manager/readme.md +++ b/specification/redhatopenshift/resource-manager/readme.md @@ -70,27 +70,3 @@ See configuration in [readme.python.md](./readme.python.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.RedHatOpenShift/stable/2020-04-30/redhatopenshift.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/redis/resource-manager/readme.md b/specification/redis/resource-manager/readme.md index 613436c70985..305b826967ce 100644 --- a/specification/redis/resource-manager/readme.md +++ b/specification/redis/resource-manager/readme.md @@ -240,31 +240,3 @@ directive: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Cache/preview/2019-07-01/redis.json - - $(this-folder)/Microsoft.Cache/stable/2018-03-01/redis.json - - $(this-folder)/Microsoft.Cache/stable/2017-10-01/redis.json - - $(this-folder)/Microsoft.Cache/stable/2017-02-01/redis.json - - $(this-folder)/Microsoft.Cache/stable/2016-04-01/redis.json - - $(this-folder)/Microsoft.Cache/stable/2015-08-01/redis.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/regionmove/resource-manager/readme.md b/specification/regionmove/resource-manager/readme.md index 66399702cbaf..3cd4a59bfc1b 100644 --- a/specification/regionmove/resource-manager/readme.md +++ b/specification/regionmove/resource-manager/readme.md @@ -87,21 +87,3 @@ See configuration in [readme.csharp.md](./readme.csharp.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. -This block is updated by an automatic script. Edits may be lost! -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json - -``` -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/relay/resource-manager/readme.md b/specification/relay/resource-manager/readme.md index 4c3b20f2e598..79c4ab022296 100644 --- a/specification/relay/resource-manager/readme.md +++ b/specification/relay/resource-manager/readme.md @@ -161,32 +161,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Relay/stable/2017-04-01/relay.json - - $(this-folder)/Microsoft.Relay/stable/2016-07-01/relay.json - - $(this-folder)/Microsoft.Relay/preview/2018-01-01-preview/Namespaces-preview.json - - $(this-folder)/Microsoft.Relay/preview/2018-01-01-preview/NetworkRuleSets-preview.json - - $(this-folder)/Microsoft.Relay/preview/2018-01-01-preview/PrivateEndpointConnection-preview.json - - $(this-folder)/Microsoft.Relay/preview/2018-01-01-preview/PrivateLinkResources-preview.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/reservations/resource-manager/readme.md b/specification/reservations/resource-manager/readme.md index cb647040360f..66a5dd8d25f3 100644 --- a/specification/reservations/resource-manager/readme.md +++ b/specification/reservations/resource-manager/readme.md @@ -138,30 +138,3 @@ See configuration in [readme.go.md](./readme.go.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Capacity/preview/2019-07-19/quota.json - - $(this-folder)/Microsoft.Capacity/preview/2019-04-01/reservations.json - - $(this-folder)/Microsoft.Capacity/preview/2018-06-01/reservations.json - - $(this-folder)/Microsoft.Capacity/stable/2017-11-01/reservations.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/resourcegraph/resource-manager/readme.md b/specification/resourcegraph/resource-manager/readme.md index dcf2839d8782..e0c9a9cb572f 100644 --- a/specification/resourcegraph/resource-manager/readme.md +++ b/specification/resourcegraph/resource-manager/readme.md @@ -136,33 +136,6 @@ directive: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.ResourceGraph/preview/2020-04-01-preview/resourcegraph.json - - $(this-folder)/Microsoft.ResourceGraph/stable/2019-04-01/resourcegraph.json - - $(this-folder)/Microsoft.ResourceGraph/preview/2018-09-01-preview/resourcegraph.json - - $(this-folder)/Microsoft.ResourceGraph/preview/2018-09-01-preview/graphquery.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - ## cli These settings apply only when `--cli` is specified on the command line. diff --git a/specification/resourcehealth/resource-manager/readme.md b/specification/resourcehealth/resource-manager/readme.md index 3982a6e8ec3d..cb06b5ae582d 100644 --- a/specification/resourcehealth/resource-manager/readme.md +++ b/specification/resourcehealth/resource-manager/readme.md @@ -176,30 +176,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json - - $(this-folder)/Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json - - $(this-folder)/Microsoft.ResourceHealth/preview/2018-08-01/ResourceHealth.json - - $(this-folder)/Microsoft.ResourceHealth/stable/2018-07-01/ResourceHealth.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/resources/resource-manager/readme.azureresourceschema.md b/specification/resources/resource-manager/readme.azureresourceschema.md index 184386348e3a..a25e134279c2 100644 --- a/specification/resources/resource-manager/readme.azureresourceschema.md +++ b/specification/resources/resource-manager/readme.azureresourceschema.md @@ -11,6 +11,7 @@ batch: - tag: schema-solutions-2018-06-01 - tag: schema-solutions-2017-09-01 - tag: schema-solutions-2016-09-01-preview + - tag: schema-resources-2020-10-01 - tag: schema-resources-2020-06-01 - tag: schema-resources-2020-01-01 - tag: schema-resources-2019-11-01 @@ -33,6 +34,7 @@ batch: - tag: schema-resources-2016-02-01 - tag: schema-resources-2015-11-01 - tag: schema-features-2015-12-01 + - tag: schema-authorization-2020-07-01-preview - tag: schema-authorization-2020-03-01 - tag: schema-authorization-2019-09-01 - tag: schema-authorization-2019-06-01 @@ -105,6 +107,17 @@ input-file: ``` +### Tag: schema-resources-2020-10-01 and azureresourceschema + +``` yaml $(tag) == 'schema-resources-2020-10-01' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.Resources/stable/2020-10-01/deploymentScripts.json + +``` + ### Tag: schema-resources-2020-06-01 and azureresourceschema ``` yaml $(tag) == 'schema-resources-2020-06-01' && $(azureresourceschema) @@ -349,6 +362,17 @@ input-file: ``` +### Tag: schema-authorization-2020-07-01-preview and azureresourceschema + +``` yaml $(tag) == 'schema-authorization-2020-07-01-preview' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.Authorization/preview/2020-07-01-preview/policyExemptions.json + +``` + ### Tag: schema-authorization-2020-03-01 and azureresourceschema ``` yaml $(tag) == 'schema-authorization-2020-03-01' && $(azureresourceschema) diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md index 1aeb07ca5d22..4a866de90b49 100644 --- a/specification/resources/resource-manager/readme.md +++ b/specification/resources/resource-manager/readme.md @@ -719,82 +719,3 @@ override-info: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Solutions/preview/2020-08-21-preview/managedapplications.json - - $(this-folder)/Microsoft.Resources/stable/2020-06-01/resources.json - - $(this-folder)/Microsoft.Resources/stable/2020-01-01/subscriptions.json - - $(this-folder)/Microsoft.Resources/preview/2019-10-01-preview/deploymentScripts.json - - $(this-folder)/Microsoft.Resources/stable/2020-10-01/deploymentScripts.json - - $(this-folder)/Microsoft.Features/stable/2015-12-01/features.json - - $(this-folder)/Microsoft.Authorization/stable/2016-09-01/locks.json - - $(this-folder)/Microsoft.Authorization/stable/2015-01-01/locks.json - - $(this-folder)/Microsoft.Authorization/preview/2020-07-01-preview/policyExemptions.json - - $(this-folder)/Microsoft.Authorization/stable/2020-03-01/policyAssignments.json - - $(this-folder)/Microsoft.Authorization/stable/2020-03-01/policyDefinitions.json - - $(this-folder)/Microsoft.Authorization/stable/2020-03-01/policySetDefinitions.json - - $(this-folder)/Microsoft.Authorization/stable/2019-09-01/policyAssignments.json - - $(this-folder)/Microsoft.Authorization/stable/2019-09-01/policyDefinitions.json - - $(this-folder)/Microsoft.Authorization/stable/2019-09-01/policySetDefinitions.json - - $(this-folder)/Microsoft.Authorization/stable/2019-06-01/policyAssignments.json - - $(this-folder)/Microsoft.Authorization/stable/2019-06-01/policyDefinitions.json - - $(this-folder)/Microsoft.Authorization/stable/2019-06-01/policySetDefinitions.json - - $(this-folder)/Microsoft.Authorization/stable/2019-01-01/policyAssignments.json - - $(this-folder)/Microsoft.Authorization/stable/2019-01-01/policyDefinitions.json - - $(this-folder)/Microsoft.Authorization/stable/2019-01-01/policySetDefinitions.json - - $(this-folder)/Microsoft.Authorization/stable/2018-05-01/policyAssignments.json - - $(this-folder)/Microsoft.Authorization/stable/2018-05-01/policyDefinitions.json - - $(this-folder)/Microsoft.Authorization/stable/2018-05-01/policySetDefinitions.json - - $(this-folder)/Microsoft.Authorization/stable/2018-03-01/policyAssignments.json - - $(this-folder)/Microsoft.Authorization/stable/2018-03-01/policyDefinitions.json - - $(this-folder)/Microsoft.Authorization/stable/2018-03-01/policySetDefinitions.json - - $(this-folder)/Microsoft.Authorization/preview/2017-06-01-preview/policyAssignments.json - - $(this-folder)/Microsoft.Authorization/preview/2017-06-01-preview/policySetDefinitions.json - - $(this-folder)/Microsoft.Authorization/stable/2016-12-01/policyDefinitions.json - - $(this-folder)/Microsoft.Resources/preview/2019-06-01-preview/templateSpecs.json - - $(this-folder)/Microsoft.Authorization/stable/2016-12-01/policyAssignments.json - - $(this-folder)/Microsoft.Authorization/stable/2016-04-01/policy.json - - $(this-folder)/Microsoft.Authorization/preview/2015-10-01-preview/policy.json - - $(this-folder)/Microsoft.Resources/stable/2019-10-01/resources.json - - $(this-folder)/Microsoft.Resources/stable/2019-08-01/resources.json - - $(this-folder)/Microsoft.Resources/stable/2019-07-01/resources.json - - $(this-folder)/Microsoft.Resources/stable/2019-05-10/resources.json - - $(this-folder)/Microsoft.Resources/stable/2019-05-01/resources.json - - $(this-folder)/Microsoft.Resources/stable/2019-03-01/resources.json - - $(this-folder)/Microsoft.Resources/stable/2018-05-01/resources.json - - $(this-folder)/Microsoft.Resources/stable/2018-02-01/resources.json - - $(this-folder)/Microsoft.Resources/stable/2017-05-10/resources.json - - $(this-folder)/Microsoft.Resources/stable/2016-09-01/resources.json - - $(this-folder)/Microsoft.Resources/stable/2016-07-01/resources.json - - $(this-folder)/Microsoft.Resources/stable/2016-02-01/resources.json - - $(this-folder)/Microsoft.Resources/stable/2015-11-01/resources.json - - $(this-folder)/Microsoft.Resources/stable/2019-11-01/subscriptions.json - - $(this-folder)/Microsoft.Resources/stable/2019-06-01/subscriptions.json - - $(this-folder)/Microsoft.Resources/stable/2018-06-01/subscriptions.json - - $(this-folder)/Microsoft.Resources/stable/2016-06-01/subscriptions.json - - $(this-folder)/Microsoft.Resources/stable/2015-11-01/subscriptions.json - - $(this-folder)/Microsoft.Resources/stable/2016-09-01/links.json - - $(this-folder)/Microsoft.Solutions/stable/2019-07-01/managedapplications.json - - $(this-folder)/Microsoft.Solutions/stable/2018-06-01/managedapplications.json - - $(this-folder)/Microsoft.Solutions/stable/2017-09-01/managedapplications.json - - $(this-folder)/Microsoft.Solutions/preview/2016-09-01-preview/managedapplications.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/scheduler/resource-manager/readme.md b/specification/scheduler/resource-manager/readme.md index b3783dfa1cdf..dd10e44abeea 100644 --- a/specification/scheduler/resource-manager/readme.md +++ b/specification/scheduler/resource-manager/readme.md @@ -195,29 +195,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Scheduler/stable/2016-03-01/scheduler.json - - $(this-folder)/Microsoft.Scheduler/stable/2016-01-01/scheduler.json - - $(this-folder)/Microsoft.Scheduler/preview/2014-08-01-preview/scheduler.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/search/resource-manager/readme.md b/specification/search/resource-manager/readme.md index 4341e33a2fe8..e4e7e9f0ebcc 100644 --- a/specification/search/resource-manager/readme.md +++ b/specification/search/resource-manager/readme.md @@ -207,32 +207,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Search/stable/2020-08-01/search.json - - $(this-folder)/Microsoft.Search/stable/2020-03-13/search.json - - $(this-folder)/Microsoft.Search/stable/2015-08-19/search.json - - $(this-folder)/Microsoft.Search/stable/2015-02-28/search.json - - $(this-folder)/Microsoft.Search/preview/2020-08-01-preview/search.json - - $(this-folder)/Microsoft.Search/preview/2019-10-01-preview/search.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/security/resource-manager/readme.md b/specification/security/resource-manager/readme.md index 175fa216254a..a05992d01aef 100644 --- a/specification/security/resource-manager/readme.md +++ b/specification/security/resource-manager/readme.md @@ -435,83 +435,3 @@ See configuration in [readme.ruby.md](./readme.ruby.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - - -``` yaml $(tag) == 'all-api-versions' /*autogenerated*/ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json - - $(this-folder)/Microsoft.Security/preview/2020-08-06-preview/iotSensors.json - - $(this-folder)/Microsoft.Security/preview/2020-01-01-preview/secureScore.json - - $(this-folder)/Microsoft.Security/preview/2020-01-01-preview/connectors.json - - $(this-folder)/Microsoft.Security/preview/2019-01-01-preview/automations.json - - $(this-folder)/Microsoft.Security/preview/2019-01-01-preview/subAssessments.json - - $(this-folder)/Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json - - $(this-folder)/Microsoft.Security/preview/2017-08-01-preview/pricings.json - - $(this-folder)/Microsoft.Security/preview/2017-08-01-preview/securityContacts.json - - $(this-folder)/Microsoft.Security/preview/2020-01-01-preview/securityContacts.json - - $(this-folder)/Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json - - $(this-folder)/Microsoft.Security/preview/2017-08-01-preview/autoProvisioningSettings.json - - $(this-folder)/Microsoft.Security/preview/2017-08-01-preview/compliances.json - - $(this-folder)/Microsoft.Security/preview/2017-08-01-preview/advancedThreatProtectionSettings.json - - $(this-folder)/Microsoft.Security/preview/2017-08-01-preview/deviceSecurityGroups.json - - $(this-folder)/Microsoft.Security/preview/2017-08-01-preview/settings.json - - $(this-folder)/Microsoft.Security/preview/2017-08-01-preview/informationProtectionPolicies.json - - $(this-folder)/Microsoft.Security/preview/2015-06-01-preview/operations.json - - $(this-folder)/Microsoft.Security/preview/2015-06-01-preview/locations.json - - $(this-folder)/Microsoft.Security/preview/2015-06-01-preview/tasks.json - - $(this-folder)/Microsoft.Security/preview/2015-06-01-preview/alerts.json - - $(this-folder)/Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json - - $(this-folder)/Microsoft.Security/preview/2015-06-01-preview/jitNetworkAccessPolicies.json - - $(this-folder)/Microsoft.Security/preview/2015-06-01-preview/applicationWhitelistings.json - - $(this-folder)/Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json - - $(this-folder)/Microsoft.Security/preview/2015-06-01-preview/topologies.json - - $(this-folder)/Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json - - $(this-folder)/Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json - - $(this-folder)/Microsoft.Security/preview/2019-01-01-preview/alertsSuppressionRules.json - - $(this-folder)/Microsoft.Security/stable/2018-06-01/pricings.json - - $(this-folder)/Microsoft.Security/preview/2017-08-01-preview/iotSecuritySolutions.json - - $(this-folder)/Microsoft.Security/preview/2017-08-01-preview/iotSecuritySolutionAnalytics.json - - $(this-folder)/Microsoft.Security/stable/2017-08-01/complianceResults.json - - $(this-folder)/Microsoft.Security/stable/2019-01-01/settings.json - - $(this-folder)/Microsoft.Security/stable/2019-01-01/advancedThreatProtectionSettings.json - - $(this-folder)/Microsoft.Security/stable/2019-08-01/deviceSecurityGroups.json - - $(this-folder)/Microsoft.Security/stable/2019-08-01/iotSecuritySolutions.json - - $(this-folder)/Microsoft.Security/stable/2019-08-01/iotSecuritySolutionAnalytics.json - - $(this-folder)/Microsoft.Security/stable/2019-08-01/iotAlertTypes.json - - $(this-folder)/Microsoft.Security/stable/2019-08-01/iotAlerts.json - - $(this-folder)/Microsoft.Security/stable/2019-08-01/iotRecommendationTypes.json - - $(this-folder)/Microsoft.Security/stable/2019-08-01/iotRecommendations.json - - $(this-folder)/Microsoft.Security/stable/2020-01-01/serverVulnerabilityAssessments.json - - $(this-folder)/Microsoft.Security/stable/2020-01-01/assessmentMetadata.json - - $(this-folder)/Microsoft.Security/stable/2020-01-01/assessments.json - - $(this-folder)/Microsoft.Security/stable/2020-01-01/applicationWhitelistings.json - - $(this-folder)/Microsoft.Security/stable/2020-01-01/adaptiveNetworkHardenings.json - - $(this-folder)/Microsoft.Security/stable/2020-01-01/allowedConnections.json - - $(this-folder)/Microsoft.Security/stable/2020-01-01/topologies.json - - $(this-folder)/Microsoft.Security/stable/2020-01-01/alerts.json - - $(this-folder)/Microsoft.Security/stable/2020-01-01/jitNetworkAccessPolicies.json - - $(this-folder)/Microsoft.Security/stable/2020-01-01/discoveredSecuritySolutions.json - - $(this-folder)/Microsoft.Security/stable/2020-01-01/securitySolutionsReferenceData.json - - $(this-folder)/Microsoft.Security/stable/2020-01-01/SecuritySolutions.json - - $(this-folder)/Microsoft.Security/stable/2020-01-01/externalSecuritySolutions.json - - $(this-folder)/Microsoft.Security/preview/2019-01-01-preview/assessmentMetadata.json - - $(this-folder)/Microsoft.Security/preview/2019-01-01-preview/assessments.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/securityinsights/resource-manager/readme.md b/specification/securityinsights/resource-manager/readme.md index a0f8dae7ca0e..e9bf77101153 100644 --- a/specification/securityinsights/resource-manager/readme.md +++ b/specification/securityinsights/resource-manager/readme.md @@ -117,28 +117,3 @@ See configuration in [readme.typescript.md](./readme.typescript.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json - - $(this-folder)/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/serialconsole/resource-manager/readme.md b/specification/serialconsole/resource-manager/readme.md index eae19181721c..5d0c5c41e52b 100644 --- a/specification/serialconsole/resource-manager/readme.md +++ b/specification/serialconsole/resource-manager/readme.md @@ -71,27 +71,3 @@ See configuration in [readme.go.md](./readme.go.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.SerialConsole/stable/2018-05-01/serialconsole.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/service-map/resource-manager/readme.md b/specification/service-map/resource-manager/readme.md index 2842243d46fa..9050b2e25e2f 100644 --- a/specification/service-map/resource-manager/readme.md +++ b/specification/service-map/resource-manager/readme.md @@ -117,27 +117,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.OperationalInsights/preview/2015-11-01-preview/arm-service-map.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/servicebus/resource-manager/readme.azureresourceschema.md b/specification/servicebus/resource-manager/readme.azureresourceschema.md index 72a1c9f004ef..232b913f8313 100644 --- a/specification/servicebus/resource-manager/readme.azureresourceschema.md +++ b/specification/servicebus/resource-manager/readme.azureresourceschema.md @@ -42,15 +42,15 @@ input-file: - Microsoft.ServiceBus/stable/2017-04-01/eventhubs.json - Microsoft.ServiceBus/stable/2017-04-01/migrate.json - Microsoft.ServiceBus/stable/2017-04-01/migrationconfigs.json - - Microsoft.ServiceBus/stable/2017-04-01/namespaces.json - - Microsoft.ServiceBus/stable/2017-04-01/networksets.json - - Microsoft.ServiceBus/stable/2017-04-01/operations.json - Microsoft.ServiceBus/stable/2017-04-01/PremiumMessagingRegions.json - Microsoft.ServiceBus/stable/2017-04-01/Queue.json - - Microsoft.ServiceBus/stable/2017-04-01/Rules.json - Microsoft.ServiceBus/stable/2017-04-01/sku.json - Microsoft.ServiceBus/stable/2017-04-01/subscriptions.json - Microsoft.ServiceBus/stable/2017-04-01/topics.json + - Microsoft.ServiceBus/stable/2017-04-01/Rules.json + - Microsoft.ServiceBus/stable/2017-04-01/namespaces.json + - Microsoft.ServiceBus/stable/2017-04-01/networksets.json + - Microsoft.ServiceBus/stable/2017-04-01/operations.json ``` diff --git a/specification/servicebus/resource-manager/readme.md b/specification/servicebus/resource-manager/readme.md index 83e7741ca82d..c9f4f4f4e15c 100644 --- a/specification/servicebus/resource-manager/readme.md +++ b/specification/servicebus/resource-manager/readme.md @@ -172,45 +172,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.ServiceBus/stable/2015-08-01/servicebus.json - - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/AuthorizationRules.json - - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/CheckNameAvailability.json - - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/DisasterRecoveryConfig.json - - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/eventhubs.json - - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/migrate.json - - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/migrationconfigs.json - - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/namespaces.json - - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/networksets.json - - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/operations.json - - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/PremiumMessagingRegions.json - - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/Queue.json - - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/Rules.json - - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/sku.json - - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/subscriptions.json - - $(this-folder)/Microsoft.ServiceBus/stable/2017-04-01/topics.json - - $(this-folder)/Microsoft.ServiceBus/preview/2018-01-01-preview/IPFilterRules-preview.json - - $(this-folder)/Microsoft.ServiceBus/preview/2018-01-01-preview/namespace-preview.json - - $(this-folder)/Microsoft.ServiceBus/preview/2018-01-01-preview/NetworkRuleSet-preview.json - - $(this-folder)/Microsoft.ServiceBus/preview/2018-01-01-preview/VirtualNetworkRules-preview.json -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/servicefabric/resource-manager/readme.md b/specification/servicefabric/resource-manager/readme.md index e24cf39fd1ba..bd3ee3d8b412 100644 --- a/specification/servicefabric/resource-manager/readme.md +++ b/specification/servicefabric/resource-manager/readme.md @@ -212,42 +212,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.ServiceFabric/stable/2020-03-01/cluster.json - - $(this-folder)/Microsoft.ServiceFabric/stable/2020-03-01/application.json - - $(this-folder)/Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json - - $(this-folder)/Microsoft.ServiceFabric/preview/2020-01-01-preview/nodetype.json - - $(this-folder)/Microsoft.ServiceFabric/preview/2019-11-01-preview/cluster.json - - $(this-folder)/Microsoft.ServiceFabric/preview/2019-11-01-preview/application.json - - $(this-folder)/Microsoft.ServiceFabric/preview/2019-06-01-preview/cluster.json - - $(this-folder)/Microsoft.ServiceFabric/preview/2019-06-01-preview/application.json - - $(this-folder)/Microsoft.ServiceFabric/stable/2019-03-01/cluster.json - - $(this-folder)/Microsoft.ServiceFabric/stable/2019-03-01/application.json - - $(this-folder)/Microsoft.ServiceFabric/preview/2019-03-01-preview/cluster.json - - $(this-folder)/Microsoft.ServiceFabric/preview/2019-03-01-preview/application.json - - $(this-folder)/Microsoft.ServiceFabric/stable/2018-02-01/cluster.json - - $(this-folder)/Microsoft.ServiceFabric/preview/2017-07-01-preview/application.json - - $(this-folder)/Microsoft.ServiceFabric/preview/2017-07-01-preview/servicefabric.json - - $(this-folder)/Microsoft.ServiceFabric/stable/2016-09-01/servicefabric.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/servicefabricmesh/resource-manager/readme.md b/specification/servicefabricmesh/resource-manager/readme.md index 581ecfa00519..4112c128faf2 100644 --- a/specification/servicefabricmesh/resource-manager/readme.md +++ b/specification/servicefabricmesh/resource-manager/readme.md @@ -176,28 +176,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json - - $(this-folder)/Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/signalr/resource-manager/readme.md b/specification/signalr/resource-manager/readme.md index c37310f908d6..1c60fa5764f6 100644 --- a/specification/signalr/resource-manager/readme.md +++ b/specification/signalr/resource-manager/readme.md @@ -144,30 +144,3 @@ csharp: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.SignalRService/preview/2020-07-01-preview/signalr.json - - $(this-folder)/Microsoft.SignalRService/stable/2020-05-01/signalr.json - - $(this-folder)/Microsoft.SignalRService/stable/2018-10-01/signalr.json - - $(this-folder)/Microsoft.SignalRService/preview/2018-03-01-preview/signalr.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/softwareplan/resource-manager/readme.md b/specification/softwareplan/resource-manager/readme.md index 632a0a67548b..f6933c2ae568 100644 --- a/specification/softwareplan/resource-manager/readme.md +++ b/specification/softwareplan/resource-manager/readme.md @@ -110,28 +110,3 @@ directive: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.SoftwarePlan/preview/2019-06-01-preview/softwareplan.json - - $(this-folder)/Microsoft.SoftwarePlan/stable/2019-12-01/softwareplan.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/sql/resource-manager/readme.azureresourceschema.md b/specification/sql/resource-manager/readme.azureresourceschema.md index b6beef658200..8f7212bea7af 100644 --- a/specification/sql/resource-manager/readme.azureresourceschema.md +++ b/specification/sql/resource-manager/readme.azureresourceschema.md @@ -6,6 +6,7 @@ These settings apply only when `--azureresourceschema` is specified on the comma ``` yaml $(azureresourceschema) && $(multiapi) batch: + - tag: schema-sql-2020-08-01-preview - tag: schema-sql-2020-02-02-preview - tag: schema-sql-2019-06-01-preview - tag: schema-sql-2018-06-01-preview @@ -19,6 +20,18 @@ batch: Please also specify `--azureresourceschema-folder=`. +### Tag: schema-sql-2020-08-01-preview and azureresourceschema + +``` yaml $(tag) == 'schema-sql-2020-08-01-preview' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - ./Microsoft.Sql/preview/2020-08-01-preview/databases.json + - ./Microsoft.Sql/preview/2020-08-01-preview/elasticPools.json + +``` + ### Tag: schema-sql-2020-02-02-preview and azureresourceschema ``` yaml $(tag) == 'schema-sql-2020-02-02-preview' && $(azureresourceschema) @@ -32,6 +45,7 @@ input-file: - Microsoft.Sql/preview/2020-02-02-preview/managedInstances.json - Microsoft.Sql/preview/2020-02-02-preview/importexport.json - Microsoft.Sql/preview/2020-02-02-preview/ManagedInstanceAzureADOnlyAuthentications.json + - Microsoft.Sql/preview/2020-02-02-preview/ServerTrustGroups.json - ./Microsoft.Sql/preview/2020-02-02-preview/DatabaseSecurityAlertPolicies.json - ./Microsoft.Sql/preview/2020-02-02-preview/ManagedServerSecurityAlertPolicies.json - ./Microsoft.Sql/preview/2020-02-02-preview/ServerSecurityAlertPolicies.json @@ -40,6 +54,7 @@ input-file: - ./Microsoft.Sql/preview/2020-02-02-preview/managedInstances.json - ./Microsoft.Sql/preview/2020-02-02-preview/ServerAzureADOnlyAuthentications.json - ./Microsoft.Sql/preview/2020-02-02-preview/ManagedInstanceAzureADOnlyAuthentications.json + - ./Microsoft.Sql/preview/2020-02-02-preview/ServerTrustGroups.json ``` @@ -50,6 +65,7 @@ output-folder: $(azureresourceschema-folder)/schemas # all the input files in this apiVersion input-file: + - Microsoft.Sql/preview/2019-06-01-preview/databases.json - Microsoft.Sql/preview/2019-06-01-preview/servers.json - Microsoft.Sql/preview/2019-06-01-preview/WorkloadGroups.json - Microsoft.Sql/preview/2019-06-01-preview/WorkloadClassifiers.json @@ -84,13 +100,13 @@ input-file: - Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json - Microsoft.Sql/preview/2018-06-01-preview/instancePools.json - Microsoft.Sql/preview/2018-06-01-preview/usages.json - - Microsoft.Sql/preview/2018-06-01-preview/FailoverDatabases.json - Microsoft.Sql/preview/2018-06-01-preview/FailoverElasticPools.json - Microsoft.Sql/preview/2018-06-01-preview/PrivateEndpointConnections.json - Microsoft.Sql/preview/2018-06-01-preview/PrivateLinkResources.json - Microsoft.Sql/preview/2018-06-01-preview/capabilities.json - Microsoft.Sql/preview/2018-06-01-preview/LongTermRetentionManagedInstanceBackups.json - Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceLongTermRetentionPolicies.json + - Microsoft.Sql/preview/2018-06-01-preview/FailoverDatabases.json - ./Microsoft.Sql/preview/2018-06-01-preview/DatabaseSecurityAlertPolicies.json - ./Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json - ./Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceVulnerabilityAssessments.json @@ -118,7 +134,6 @@ output-folder: $(azureresourceschema-folder)/schemas input-file: - Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json - Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json - - Microsoft.Sql/preview/2017-10-01-preview/databases.json - Microsoft.Sql/preview/2017-10-01-preview/elasticPools.json - Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json - Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssesmentRuleBaselines.json diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md index 0682ecf919c1..507c3ad8420a 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -849,236 +849,3 @@ directive: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/backups.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/connectionPolicies.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/databaseSecurityAlertPolicies.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/dataMasking.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/firewallRules.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/metrics.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/recommendedElasticPoolsDecoupled.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/replicationLinks.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/serviceObjectives.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/sql.core.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/usages.json - - $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json - - $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json - - $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json - - $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/operations.json - - $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json - - $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/syncAgents.json - - $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/usages.json - - $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/virtualclusters.json - - $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json - - $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json - - $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json - - $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json - - $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/jobs.json - - $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json - - $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json - - $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetenion.json - - $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json - - $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json - - $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json - - $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/restorableDroppedManagedDatabases.json - - $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json - - $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json - - $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json - - $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/SensitivityLabels.json - - $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/managedInstanceAdministrators.json - - $(this-folder)/Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json - - $(this-folder)/Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json - - $(this-folder)/Microsoft.Sql/preview/2017-10-01-preview/databases.json - - $(this-folder)/Microsoft.Sql/preview/2017-10-01-preview/elasticPools.json - - $(this-folder)/Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json - - $(this-folder)/Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssesmentRuleBaselines.json - - $(this-folder)/Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessmentScans.json - - $(this-folder)/Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessments.json - - $(this-folder)/Microsoft.Sql/preview/2017-10-01-preview/instanceFailoverGroups.json - - $(this-folder)/Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json - - $(this-folder)/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json - - $(this-folder)/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json - - $(this-folder)/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json - - $(this-folder)/Microsoft.Sql/preview/2017-10-01-preview/recoverableManagedDatabases.json - - $(this-folder)/Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceVulnerabilityAssessments.json - - $(this-folder)/Microsoft.Sql/preview/2018-06-01-preview/ServerVulnerabilityAssessments.json - - $(this-folder)/Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json - - $(this-folder)/Microsoft.Sql/preview/2018-06-01-preview/instancePools.json - - $(this-folder)/Microsoft.Sql/preview/2018-06-01-preview/usages.json - - $(this-folder)/Microsoft.Sql/preview/2018-06-01-preview/FailoverDatabases.json - - $(this-folder)/Microsoft.Sql/preview/2018-06-01-preview/FailoverElasticPools.json - - $(this-folder)/Microsoft.Sql/preview/2018-06-01-preview/PrivateEndpointConnections.json - - $(this-folder)/Microsoft.Sql/preview/2018-06-01-preview/PrivateLinkResources.json - - $(this-folder)/Microsoft.Sql/preview/2019-06-01-preview/servers.json - - $(this-folder)/Microsoft.Sql/preview/2018-06-01-preview/capabilities.json - - $(this-folder)/Microsoft.Sql/preview/2018-06-01-preview/LongTermRetentionManagedInstanceBackups.json - - $(this-folder)/Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceLongTermRetentionPolicies.json - - $(this-folder)/Microsoft.Sql/preview/2019-06-01-preview/WorkloadGroups.json - - $(this-folder)/Microsoft.Sql/preview/2019-06-01-preview/WorkloadClassifiers.json - - $(this-folder)/Microsoft.Sql/preview/2019-06-01-preview/managedInstanceOperations.json - - $(this-folder)/Microsoft.Sql/preview/2019-06-01-preview/ServerAzureADAdministrators.json - - $(this-folder)/Microsoft.Sql/preview/2019-06-01-preview/syncGroups.json - - $(this-folder)/Microsoft.Sql/preview/2019-06-01-preview/syncMembers.json - - $(this-folder)/Microsoft.Sql/preview/2019-06-01-preview/FailoverManagedInstance.json - - $(this-folder)/Microsoft.Sql/preview/2020-02-02-preview/shortTermRetentionPolicies.json - - $(this-folder)/Microsoft.Sql/preview/2020-02-02-preview/managedDatabases.json - - $(this-folder)/Microsoft.Sql/preview/2020-02-02-preview/ServerAzureADOnlyAuthentications.json - - $(this-folder)/Microsoft.Sql/preview/2020-02-02-preview/managedInstances.json - - $(this-folder)/Microsoft.Sql/preview/2020-02-02-preview/importexport.json - - $(this-folder)/Microsoft.Sql/preview/2020-02-02-preview/ManagedInstanceAzureADOnlyAuthentications.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/capabilities.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/databases.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/elasticPools.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/importExport.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json - - $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json - - $(this-folder)/Microsoft.Sql/preview/2017-10-01-preview/shortTermRetentionPolicies.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/serverAzureADAdministrators.json - - $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json - - $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/servers.json - - $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/syncGroups.json - - $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/syncMembers.json - - $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/cancelOperations.json - - $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/dataWarehouseUserActivities.json - - $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/restorePoints.json - - $(this-folder)/Microsoft.Sql/stable/2015-05-01/capabilities.json - - $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json - - $(this-folder)/./Microsoft.Sql/preview/2020-02-02-preview/DatabaseSecurityAlertPolicies.json - - $(this-folder)/./Microsoft.Sql/preview/2020-02-02-preview/ManagedServerSecurityAlertPolicies.json - - $(this-folder)/./Microsoft.Sql/preview/2020-02-02-preview/ServerSecurityAlertPolicies.json - - $(this-folder)/./Microsoft.Sql/preview/2020-02-02-preview/operations.json - - $(this-folder)/./Microsoft.Sql/preview/2020-02-02-preview/managedDatabases.json - - $(this-folder)/./Microsoft.Sql/preview/2020-02-02-preview/managedInstances.json - - $(this-folder)/./Microsoft.Sql/preview/2020-02-02-preview/ServerAzureADOnlyAuthentications.json - - $(this-folder)/./Microsoft.Sql/preview/2020-02-02-preview/ManagedInstanceAzureADOnlyAuthentications.json - - $(this-folder)/./Microsoft.Sql/preview/2019-06-01-preview/databases.json - - $(this-folder)/./Microsoft.Sql/preview/2019-06-01-preview/managedDatabases.json - - $(this-folder)/./Microsoft.Sql/preview/2019-06-01-preview/serverOperations.json - - $(this-folder)/./Microsoft.Sql/preview/2019-06-01-preview/servers.json - - $(this-folder)/./Microsoft.Sql/preview/2019-06-01-preview/WorkloadGroups.json - - $(this-folder)/./Microsoft.Sql/preview/2019-06-01-preview/WorkloadClassifiers.json - - $(this-folder)/./Microsoft.Sql/preview/2019-06-01-preview/managedInstanceOperations.json - - $(this-folder)/./Microsoft.Sql/preview/2019-06-01-preview/ServerAzureADAdministrators.json - - $(this-folder)/./Microsoft.Sql/preview/2019-06-01-preview/syncGroups.json - - $(this-folder)/./Microsoft.Sql/preview/2019-06-01-preview/syncMembers.json - - $(this-folder)/./Microsoft.Sql/preview/2019-06-01-preview/FailoverManagedInstance.json - - $(this-folder)/./Microsoft.Sql/preview/2018-06-01-preview/DatabaseSecurityAlertPolicies.json - - $(this-folder)/./Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json - - $(this-folder)/./Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceVulnerabilityAssessments.json - - $(this-folder)/./Microsoft.Sql/preview/2018-06-01-preview/managedInstanceOperations.json - - $(this-folder)/./Microsoft.Sql/preview/2018-06-01-preview/ServerVulnerabilityAssessments.json - - $(this-folder)/./Microsoft.Sql/preview/2018-06-01-preview/instancePools.json - - $(this-folder)/./Microsoft.Sql/preview/2018-06-01-preview/usages.json - - $(this-folder)/./Microsoft.Sql/preview/2018-06-01-preview/managedInstances.json - - $(this-folder)/./Microsoft.Sql/preview/2018-06-01-preview/managedDatabases.json - - $(this-folder)/./Microsoft.Sql/preview/2018-06-01-preview/FailoverDatabases.json - - $(this-folder)/./Microsoft.Sql/preview/2018-06-01-preview/FailoverElasticPools.json - - $(this-folder)/./Microsoft.Sql/preview/2018-06-01-preview/PrivateEndpointConnections.json - - $(this-folder)/./Microsoft.Sql/preview/2018-06-01-preview/ServerAzureADAdministrators.json - - $(this-folder)/./Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceLongTermRetentionPolicies.json - - $(this-folder)/./Microsoft.Sql/preview/2018-06-01-preview/LongTermRetentionManagedInstanceBackups.json - - $(this-folder)/./Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json - - $(this-folder)/./Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json - - $(this-folder)/./Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json - - $(this-folder)/./Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssesmentRuleBaselines.json - - $(this-folder)/./Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessmentScans.json - - $(this-folder)/./Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessments.json - - $(this-folder)/./Microsoft.Sql/preview/2017-10-01-preview/capabilities.json - - $(this-folder)/./Microsoft.Sql/preview/2017-10-01-preview/databases.json - - $(this-folder)/./Microsoft.Sql/preview/2017-10-01-preview/elasticPools.json - - $(this-folder)/./Microsoft.Sql/preview/2017-10-01-preview/instanceFailoverGroups.json - - $(this-folder)/./Microsoft.Sql/preview/2017-10-01-preview/shortTermRetentionPolicies.json - - $(this-folder)/./Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json - - $(this-folder)/./Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json - - $(this-folder)/./Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json - - $(this-folder)/./Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json - - $(this-folder)/./Microsoft.Sql/preview/2017-10-01-preview/recoverableManagedDatabases.json - - $(this-folder)/./Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json - - $(this-folder)/./Microsoft.Sql/preview/2017-03-01-preview/cancelOperations.json - - $(this-folder)/./Microsoft.Sql/preview/2017-03-01-preview/databases.json - - $(this-folder)/./Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json - - $(this-folder)/./Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json - - $(this-folder)/./Microsoft.Sql/preview/2017-03-01-preview/dataWarehouseUserActivities.json - - $(this-folder)/./Microsoft.Sql/preview/2017-03-01-preview/jobs.json - - $(this-folder)/./Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json - - $(this-folder)/./Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json - - $(this-folder)/./Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json - - $(this-folder)/./Microsoft.Sql/preview/2017-03-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetenion.json - - $(this-folder)/./Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json - - $(this-folder)/./Microsoft.Sql/preview/2017-03-01-preview/restorableDroppedManagedDatabases.json - - $(this-folder)/./Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json - - $(this-folder)/./Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json - - $(this-folder)/./Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json - - $(this-folder)/./Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json - - $(this-folder)/./Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json - - $(this-folder)/./Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json - - $(this-folder)/./Microsoft.Sql/preview/2017-03-01-preview/SensitivityLabels.json - - $(this-folder)/./Microsoft.Sql/preview/2017-03-01-preview/managedInstanceAdministrators.json - - $(this-folder)/./Microsoft.Sql/preview/2015-05-01-preview/advisors.json - - $(this-folder)/./Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json - - $(this-folder)/./Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json - - $(this-folder)/./Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json - - $(this-folder)/./Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json - - $(this-folder)/./Microsoft.Sql/preview/2015-05-01-preview/firewallRules.json - - $(this-folder)/./Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json - - $(this-folder)/./Microsoft.Sql/preview/2015-05-01-preview/operations.json - - $(this-folder)/./Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json - - $(this-folder)/./Microsoft.Sql/preview/2015-05-01-preview/servers.json - - $(this-folder)/./Microsoft.Sql/preview/2015-05-01-preview/syncAgents.json - - $(this-folder)/./Microsoft.Sql/preview/2015-05-01-preview/syncGroups.json - - $(this-folder)/./Microsoft.Sql/preview/2015-05-01-preview/syncMembers.json - - $(this-folder)/./Microsoft.Sql/preview/2015-05-01-preview/usages.json - - $(this-folder)/./Microsoft.Sql/preview/2015-05-01-preview/virtualclusters.json - - $(this-folder)/./Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/advisors.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/backups.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/capabilities.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/connectionPolicies.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/databases.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/databaseSecurityAlertPolicies.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/dataMasking.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/deprecated.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/disasterRecoveryConfigurations.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/elasticPools.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/firewallRules.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/importExport.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/metrics.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/operations.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/queries.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/replicationLinks.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/restorePoints.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/serverAzureADAdministrators.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/servers.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/serviceObjectives.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/sql.core.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/tableAuditing.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/usages.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/sqlvirtualmachine/resource-manager/readme.md b/specification/sqlvirtualmachine/resource-manager/readme.md index 9781c1145ebb..2f795d6ed01d 100644 --- a/specification/sqlvirtualmachine/resource-manager/readme.md +++ b/specification/sqlvirtualmachine/resource-manager/readme.md @@ -118,27 +118,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/sqlvm.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/storSimple1200Series/resource-manager/readme.md b/specification/storSimple1200Series/resource-manager/readme.md index 29f85866a59d..be1de214a05b 100644 --- a/specification/storSimple1200Series/resource-manager/readme.md +++ b/specification/storSimple1200Series/resource-manager/readme.md @@ -104,27 +104,3 @@ java: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.StorSimple/stable/2016-10-01/StorSimple.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/storage/resource-manager/readme.md b/specification/storage/resource-manager/readme.md index 4f58f5579193..eb7b621c27fa 100644 --- a/specification/storage/resource-manager/readme.md +++ b/specification/storage/resource-manager/readme.md @@ -319,55 +319,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Storage/preview/2020-08-01-preview/storage.json - - $(this-folder)/Microsoft.Storage/preview/2020-08-01-preview/blob.json - - $(this-folder)/Microsoft.Storage/preview/2020-08-01-preview/file.json - - $(this-folder)/Microsoft.Storage/preview/2020-08-01-preview/queue.json - - $(this-folder)/Microsoft.Storage/preview/2020-08-01-preview/table.json - - $(this-folder)/Microsoft.Storage/stable/2019-06-01/storage.json - - $(this-folder)/Microsoft.Storage/stable/2019-06-01/blob.json - - $(this-folder)/Microsoft.Storage/stable/2019-06-01/file.json - - $(this-folder)/Microsoft.Storage/stable/2019-06-01/queue.json - - $(this-folder)/Microsoft.Storage/stable/2019-06-01/table.json - - $(this-folder)/Microsoft.Storage/stable/2019-04-01/storage.json - - $(this-folder)/Microsoft.Storage/stable/2019-04-01/blob.json - - $(this-folder)/Microsoft.Storage/stable/2019-04-01/file.json - - $(this-folder)/Microsoft.Storage/stable/2018-11-01/storage.json - - $(this-folder)/Microsoft.Storage/stable/2018-11-01/blob.json - - $(this-folder)/Microsoft.Storage/stable/2018-07-01/storage.json - - $(this-folder)/Microsoft.Storage/stable/2018-07-01/blob.json - - $(this-folder)/Microsoft.Storage/preview/2018-03-01-preview/managementpolicy.json - - $(this-folder)/Microsoft.Storage/preview/2018-03-01-preview/storage.json - - $(this-folder)/Microsoft.Storage/preview/2018-03-01-preview/blob.json - - $(this-folder)/Microsoft.Storage/stable/2018-02-01/storage.json - - $(this-folder)/Microsoft.Storage/stable/2018-02-01/blob.json - - $(this-folder)/Microsoft.Storage/stable/2017-10-01/storage.json - - $(this-folder)/Microsoft.Storage/stable/2017-06-01/storage.json - - $(this-folder)/Microsoft.Storage/stable/2016-12-01/storage.json - - $(this-folder)/Microsoft.Storage/stable/2016-05-01/storage.json - - $(this-folder)/Microsoft.Storage/stable/2016-01-01/storage.json - - $(this-folder)/Microsoft.Storage/stable/2015-06-15/storage.json - - $(this-folder)/Microsoft.Storage/preview/2015-05-01-preview/storage.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/storagecache/resource-manager/readme.md b/specification/storagecache/resource-manager/readme.md index 58658d33c0c5..f76c762192d0 100644 --- a/specification/storagecache/resource-manager/readme.md +++ b/specification/storagecache/resource-manager/readme.md @@ -106,29 +106,3 @@ See configuration in [readme.ruby.md](./readme.ruby.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.StorageCache/stable/2020-03-01/storagecache.json - - $(this-folder)/Microsoft.StorageCache/stable/2019-11-01/storagecache.json - - $(this-folder)/Microsoft.StorageCache/preview/2019-08-01-preview/storagecache.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/storageimportexport/resource-manager/readme.md b/specification/storageimportexport/resource-manager/readme.md index 95e38cf94944..7c5743419cc8 100644 --- a/specification/storageimportexport/resource-manager/readme.md +++ b/specification/storageimportexport/resource-manager/readme.md @@ -135,28 +135,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.ImportExport/stable/2016-11-01/storageimportexport.json - - $(this-folder)/Microsoft.ImportExport/stable/2020-08-01/storageimportexport.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/storagesync/resource-manager/readme.md b/specification/storagesync/resource-manager/readme.md index d104d90cdc22..efb6bc8c2b57 100644 --- a/specification/storagesync/resource-manager/readme.md +++ b/specification/storagesync/resource-manager/readme.md @@ -190,34 +190,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.StorageSync/stable/2020-03-01/storagesync.json - - $(this-folder)/Microsoft.StorageSync/stable/2019-10-01/storagesync.json - - $(this-folder)/Microsoft.StorageSync/stable/2019-06-01/storagesync.json - - $(this-folder)/Microsoft.StorageSync/stable/2019-03-01/storagesync.json - - $(this-folder)/Microsoft.StorageSync/stable/2019-02-01/storagesync.json - - $(this-folder)/Microsoft.StorageSync/stable/2018-10-01/storagesync.json - - $(this-folder)/Microsoft.StorageSync/stable/2018-07-01/storagesync.json - - $(this-folder)/Microsoft.StorageSync/stable/2018-04-02/storagesync.json - - $(this-folder)/Microsoft.StorageSync/preview/2017-06-05-preview/storagesync.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/storsimple8000series/resource-manager/readme.md b/specification/storsimple8000series/resource-manager/readme.md index 12c67125362b..f717e6b9e303 100644 --- a/specification/storsimple8000series/resource-manager/readme.md +++ b/specification/storsimple8000series/resource-manager/readme.md @@ -125,27 +125,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.StorSimple/stable/2017-06-01/storsimple.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/streamanalytics/resource-manager/readme.azureresourceschema.md b/specification/streamanalytics/resource-manager/readme.azureresourceschema.md index 66f93a4bf826..d144db4a64a1 100644 --- a/specification/streamanalytics/resource-manager/readme.azureresourceschema.md +++ b/specification/streamanalytics/resource-manager/readme.azureresourceschema.md @@ -6,12 +6,43 @@ These settings apply only when `--azureresourceschema` is specified on the comma ``` yaml $(azureresourceschema) && $(multiapi) batch: + - tag: schema-streamanalytics-2020-03-01-preview + - tag: schema-streamanalytics-2017-04-01-preview - tag: schema-streamanalytics-2016-03-01 ``` Please also specify `--azureresourceschema-folder=`. +### Tag: schema-streamanalytics-2020-03-01-preview and azureresourceschema + +``` yaml $(tag) == 'schema-streamanalytics-2020-03-01-preview' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.StreamAnalytics/preview/2020-03-01-preview/clusters.json + - Microsoft.StreamAnalytics/preview/2020-03-01-preview/privateEndpoints.json + +``` + +### Tag: schema-streamanalytics-2017-04-01-preview and azureresourceschema + +``` yaml $(tag) == 'schema-streamanalytics-2017-04-01-preview' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json + - Microsoft.StreamAnalytics/preview/2017-04-01-preview/inputs.json + - Microsoft.StreamAnalytics/preview/2017-04-01-preview/outputs.json + - Microsoft.StreamAnalytics/preview/2017-04-01-preview/streamingjobs.json + - Microsoft.StreamAnalytics/preview/2017-04-01-preview/subscriptions.json + - Microsoft.StreamAnalytics/preview/2017-04-01-preview/transformations.json + - Microsoft.StreamAnalytics/preview/2017-04-01-preview/operations.json + +``` + ### Tag: schema-streamanalytics-2016-03-01 and azureresourceschema ``` yaml $(tag) == 'schema-streamanalytics-2016-03-01' && $(azureresourceschema) diff --git a/specification/streamanalytics/resource-manager/readme.md b/specification/streamanalytics/resource-manager/readme.md index 6fd532ad2a32..9770af90a658 100644 --- a/specification/streamanalytics/resource-manager/readme.md +++ b/specification/streamanalytics/resource-manager/readme.md @@ -233,31 +233,3 @@ directive: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.StreamAnalytics/stable/2016-03-01/streamingjobs.json - - $(this-folder)/Microsoft.StreamAnalytics/stable/2016-03-01/inputs.json - - $(this-folder)/Microsoft.StreamAnalytics/stable/2016-03-01/outputs.json - - $(this-folder)/Microsoft.StreamAnalytics/stable/2016-03-01/transformations.json - - $(this-folder)/Microsoft.StreamAnalytics/stable/2016-03-01/functions.json - - $(this-folder)/Microsoft.StreamAnalytics/stable/2016-03-01/subscriptions.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/subscription/resource-manager/readme.md b/specification/subscription/resource-manager/readme.md index 88936dde8d2f..af2761560070 100644 --- a/specification/subscription/resource-manager/readme.md +++ b/specification/subscription/resource-manager/readme.md @@ -208,35 +208,3 @@ description: The subscription client See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Subscription/stable/2016-06-01/subscriptions.json - - $(this-folder)/Microsoft.Subscription/stable/2020-09-01/subscriptions.json - - $(this-folder)/Microsoft.Subscription/stable/2020-01-01/subscriptions.json - - $(this-folder)/Microsoft.Subscription/preview/2019-10-01-preview/subscriptions.json - - $(this-folder)/Microsoft.Subscription/preview/2019-03-01-preview/subscriptions.json - - $(this-folder)/Microsoft.Subscription/preview/2018-11-01-preview/subscriptions.json - - $(this-folder)/Microsoft.Subscription/preview/2018-03-01-preview/subscriptions.json - - $(this-folder)/Microsoft.Subscription/preview/2018-03-01-preview/operations.json - - $(this-folder)/Microsoft.Subscription/preview/2017-11-01-preview/subscriptionDefinitions.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/support/resource-manager/readme.md b/specification/support/resource-manager/readme.md index 0cfd1d4d7776..9e1fbac31c0f 100644 --- a/specification/support/resource-manager/readme.md +++ b/specification/support/resource-manager/readme.md @@ -97,28 +97,3 @@ See configuration in [readme.ruby.md](./readme.ruby.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Support/stable/2020-04-01/support.json - - $(this-folder)/Microsoft.Support/preview/2019-05-01-preview/support.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/synapse/resource-manager/readme.md b/specification/synapse/resource-manager/readme.md index 43799498060f..68da597e5e27 100644 --- a/specification/synapse/resource-manager/readme.md +++ b/specification/synapse/resource-manager/readme.md @@ -128,38 +128,3 @@ See configuration in [readme.go.md](./readme.go.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPool.json - - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/checkNameAvailability.json - - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/firewallRule.json - - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/operations.json - - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/sqlPool.json - - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json - - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/integrationRuntime.json - - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/privateLinkResources.json - - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/privateEndpointConnections.json - - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/privatelinkhub.json - - $(this-folder)/Microsoft.Synapse/preview/2020-04-01-preview/operations.json - - $(this-folder)/Microsoft.Synapse/preview/2020-04-01-preview/sqlPool.json - - $(this-folder)/Microsoft.Synapse/preview/2020-04-01-preview/sqlDatabase.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` diff --git a/specification/timeseriesinsights/resource-manager/readme.md b/specification/timeseriesinsights/resource-manager/readme.md index f8d60e6f88aa..6e5d24befcad 100644 --- a/specification/timeseriesinsights/resource-manager/readme.md +++ b/specification/timeseriesinsights/resource-manager/readme.md @@ -199,30 +199,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json - - $(this-folder)/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/timeseriesinsights.json - - $(this-folder)/Microsoft.TimeSeriesInsights/stable/2017-11-15/timeseriesinsights.json - - $(this-folder)/Microsoft.TimeSeriesInsights/preview/2017-02-28-preview/timeseriesinsights.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/trafficmanager/resource-manager/readme.md b/specification/trafficmanager/resource-manager/readme.md index 8df9cc48520b..2c955bdde8c6 100644 --- a/specification/trafficmanager/resource-manager/readme.md +++ b/specification/trafficmanager/resource-manager/readme.md @@ -253,33 +253,3 @@ java: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Network/stable/2018-04-01/trafficmanager.json - - $(this-folder)/Microsoft.Network/stable/2018-03-01/trafficmanager.json - - $(this-folder)/Microsoft.Network/stable/2018-02-01/trafficmanager.json - - $(this-folder)/Microsoft.Network/preview/2017-09-01-preview/trafficmanageranalytics.json - - $(this-folder)/Microsoft.Network/stable/2017-05-01/trafficmanager.json - - $(this-folder)/Microsoft.Network/stable/2017-03-01/trafficmanager.json - - $(this-folder)/Microsoft.Network/stable/2015-11-01/trafficmanager.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/visualstudio/resource-manager/readme.md b/specification/visualstudio/resource-manager/readme.md index 11529a100cc2..c11e1701c524 100644 --- a/specification/visualstudio/resource-manager/readme.md +++ b/specification/visualstudio/resource-manager/readme.md @@ -109,27 +109,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.VisualStudio/preview/2014-04-01-preview/Csm.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/vmware/resource-manager/readme.md b/specification/vmware/resource-manager/readme.md index e659c411b608..a381bf23160b 100644 --- a/specification/vmware/resource-manager/readme.md +++ b/specification/vmware/resource-manager/readme.md @@ -103,28 +103,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.AVS/stable/2020-03-20/vmware.json - - $(this-folder)/Microsoft.AVS/preview/2019-08-09-preview/vmware.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/vmwarecloudsimple/resource-manager/readme.md b/specification/vmwarecloudsimple/resource-manager/readme.md index dc26819a766a..f6b5976a6807 100644 --- a/specification/vmwarecloudsimple/resource-manager/readme.md +++ b/specification/vmwarecloudsimple/resource-manager/readme.md @@ -87,27 +87,3 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.VMwareCloudSimple/stable/2019-04-01/vmwarecloudsimple.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/web/resource-manager/readme.md b/specification/web/resource-manager/readme.md index e50bd4a51edf..066d4cda40a8 100644 --- a/specification/web/resource-manager/readme.md +++ b/specification/web/resource-manager/readme.md @@ -1224,96 +1224,3 @@ input-file: See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.CertificateRegistration/stable/2020-06-01/AppServiceCertificateOrders.json - - $(this-folder)/Microsoft.CertificateRegistration/stable/2020-06-01/CertificateRegistrationProvider.json - - $(this-folder)/Microsoft.DomainRegistration/stable/2020-06-01/Domains.json - - $(this-folder)/Microsoft.DomainRegistration/stable/2020-06-01/TopLevelDomains.json - - $(this-folder)/Microsoft.DomainRegistration/stable/2020-06-01/DomainRegistrationProvider.json - - $(this-folder)/Microsoft.Web/stable/2020-06-01/Certificates.json - - $(this-folder)/Microsoft.Web/stable/2020-06-01/CommonDefinitions.json - - $(this-folder)/Microsoft.Web/stable/2020-06-01/DeletedWebApps.json - - $(this-folder)/Microsoft.Web/stable/2020-06-01/Diagnostics.json - - $(this-folder)/Microsoft.Web/stable/2020-06-01/Provider.json - - $(this-folder)/Microsoft.Web/stable/2020-06-01/Recommendations.json - - $(this-folder)/Microsoft.Web/stable/2020-06-01/ResourceProvider.json - - $(this-folder)/Microsoft.Web/stable/2020-06-01/WebApps.json - - $(this-folder)/Microsoft.Web/stable/2020-06-01/StaticSites.json - - $(this-folder)/Microsoft.Web/stable/2020-06-01/AppServiceEnvironments.json - - $(this-folder)/Microsoft.Web/stable/2020-06-01/AppServicePlans.json - - $(this-folder)/Microsoft.Web/stable/2020-06-01/ResourceHealthMetadata.json - - $(this-folder)/Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json - - $(this-folder)/Microsoft.CertificateRegistration/stable/2019-08-01/CertificateRegistrationProvider.json - - $(this-folder)/Microsoft.DomainRegistration/stable/2019-08-01/Domains.json - - $(this-folder)/Microsoft.DomainRegistration/stable/2019-08-01/TopLevelDomains.json - - $(this-folder)/Microsoft.DomainRegistration/stable/2019-08-01/DomainRegistrationProvider.json - - $(this-folder)/Microsoft.Web/stable/2019-08-01/Certificates.json - - $(this-folder)/Microsoft.Web/stable/2019-08-01/CommonDefinitions.json - - $(this-folder)/Microsoft.Web/stable/2019-08-01/DeletedWebApps.json - - $(this-folder)/Microsoft.Web/stable/2019-08-01/Diagnostics.json - - $(this-folder)/Microsoft.Web/stable/2019-08-01/Provider.json - - $(this-folder)/Microsoft.Web/stable/2019-08-01/Recommendations.json - - $(this-folder)/Microsoft.Web/stable/2019-08-01/ResourceProvider.json - - $(this-folder)/Microsoft.Web/stable/2019-08-01/WebApps.json - - $(this-folder)/Microsoft.Web/stable/2019-08-01/StaticSites.json - - $(this-folder)/Microsoft.Web/stable/2019-08-01/AppServiceEnvironments.json - - $(this-folder)/Microsoft.Web/stable/2019-08-01/AppServicePlans.json - - $(this-folder)/Microsoft.Web/stable/2019-08-01/ResourceHealthMetadata.json - - $(this-folder)/Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json - - $(this-folder)/Microsoft.CertificateRegistration/stable/2018-02-01/CertificateRegistrationProvider.json - - $(this-folder)/Microsoft.DomainRegistration/stable/2018-02-01/Domains.json - - $(this-folder)/Microsoft.DomainRegistration/stable/2018-02-01/TopLevelDomains.json - - $(this-folder)/Microsoft.DomainRegistration/stable/2018-02-01/DomainRegistrationProvider.json - - $(this-folder)/Microsoft.Web/stable/2018-11-01/Certificates.json - - $(this-folder)/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json - - $(this-folder)/Microsoft.Web/stable/2018-02-01/DeletedWebApps.json - - $(this-folder)/Microsoft.Web/stable/2018-02-01/Diagnostics.json - - $(this-folder)/Microsoft.Web/stable/2018-02-01/Provider.json - - $(this-folder)/Microsoft.Web/stable/2018-02-01/Recommendations.json - - $(this-folder)/Microsoft.Web/stable/2018-02-01/ResourceProvider.json - - $(this-folder)/Microsoft.Web/stable/2018-11-01/WebApps.json - - $(this-folder)/Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json - - $(this-folder)/Microsoft.Web/stable/2018-02-01/AppServicePlans.json - - $(this-folder)/Microsoft.Web/stable/2018-02-01/ResourceHealthMetadata.json - - $(this-folder)/Microsoft.Web/stable/2018-02-01/WebApps.json - - $(this-folder)/Microsoft.Web/stable/2018-02-01/Certificates.json - - $(this-folder)/Microsoft.CertificateRegistration/stable/2015-08-01/AppServiceCertificateOrders.json - - $(this-folder)/Microsoft.CertificateRegistration/stable/2015-08-01/CertificateRegistrationProvider.json - - $(this-folder)/Microsoft.DomainRegistration/stable/2015-04-01/Domains.json - - $(this-folder)/Microsoft.DomainRegistration/stable/2015-04-01/TopLevelDomains.json - - $(this-folder)/Microsoft.DomainRegistration/stable/2015-04-01/DomainRegistrationProvider.json - - $(this-folder)/Microsoft.Web/stable/2016-03-01/Certificates.json - - $(this-folder)/Microsoft.Web/stable/2016-03-01/CommonDefinitions.json - - $(this-folder)/Microsoft.Web/stable/2016-03-01/DeletedWebApps.json - - $(this-folder)/Microsoft.Web/stable/2016-03-01/Diagnostics.json - - $(this-folder)/Microsoft.Web/stable/2016-03-01/Provider.json - - $(this-folder)/Microsoft.Web/stable/2016-03-01/Recommendations.json - - $(this-folder)/Microsoft.Web/stable/2016-03-01/ResourceHealthMetadata.json - - $(this-folder)/Microsoft.Web/stable/2016-03-01/ResourceProvider.json - - $(this-folder)/Microsoft.Web/stable/2016-08-01/WebApps.json - - $(this-folder)/Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json - - $(this-folder)/Microsoft.Web/stable/2016-09-01/AppServicePlans.json - - $(this-folder)/Microsoft.Web/stable/2015-08-01/service.json - - $(this-folder)/Microsoft.Web/preview/2015-08-01-preview/logicAppsManagementClient.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/windowsesu/resource-manager/readme.md b/specification/windowsesu/resource-manager/readme.md index 9a5fda1c22f6..93e5346c595e 100644 --- a/specification/windowsesu/resource-manager/readme.md +++ b/specification/windowsesu/resource-manager/readme.md @@ -85,27 +85,3 @@ See configuration in [readme.csharp.md](./readme.csharp.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.WindowsESU/preview/2019-09-16-preview/windowsesu.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/windowsiot/resource-manager/readme.md b/specification/windowsiot/resource-manager/readme.md index 1778d3755230..ac4c4bc4dfc8 100644 --- a/specification/windowsiot/resource-manager/readme.md +++ b/specification/windowsiot/resource-manager/readme.md @@ -112,31 +112,6 @@ See configuration in [readme.ruby.md](./readme.ruby.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.WindowsIoT/stable/2019-06-01/WindowsIotServices.json - - $(this-folder)/Microsoft.WindowsIoT/preview/2018-02-16-preview/WindowsIotServices.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - ## trenton These settings apply only when `--trenton` is specified on the command line. diff --git a/specification/workloadmonitor/resource-manager/readme.md b/specification/workloadmonitor/resource-manager/readme.md index e92be26d508e..c5f72c03751d 100644 --- a/specification/workloadmonitor/resource-manager/readme.md +++ b/specification/workloadmonitor/resource-manager/readme.md @@ -173,27 +173,3 @@ generate-interface: true See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/Microsoft.WorkloadMonitor.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - From be39f5abd3dc4cf6db384f688e0dd18dd907d04b Mon Sep 17 00:00:00 2001 From: sudipd-msft <20959938+usvoyager@users.noreply.github.com> Date: Mon, 21 Sep 2020 21:54:39 -0700 Subject: [PATCH 105/164] Swagger for Communication Services Resource Manager Preview (#10877) * Swagger for Communication Services Preview * python track2 * Fix SpellCheck and PrettierCheck errors * More PrettierCheck fixes Co-authored-by: Sudipta Dey (WDG) Co-authored-by: Changlong Liu --- .../CommunicationService.json | 1088 +++++++++++++++++ .../examples/createOrUpdate.json | 44 + .../2020-08-20-preview/examples/delete.json | 17 + .../2020-08-20-preview/examples/get.json | 32 + .../examples/getOperationStatus.json | 26 + .../examples/linkNotificationHub.json | 27 + .../examples/listByResourceGroup.json | 23 + .../examples/listBySubscription.json | 22 + .../2020-08-20-preview/examples/listKeys.json | 16 + .../examples/regenerateKey.json | 22 + .../2020-08-20-preview/examples/update.json | 32 + .../resource-manager/readme.csharp.md | 15 + .../resource-manager/readme.go.md | 26 + .../communication/resource-manager/readme.md | 70 ++ .../resource-manager/readme.python.md | 44 + 15 files changed, 1504 insertions(+) create mode 100644 specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/CommunicationService.json create mode 100644 specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/createOrUpdate.json create mode 100644 specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/delete.json create mode 100644 specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/get.json create mode 100644 specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/getOperationStatus.json create mode 100644 specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/linkNotificationHub.json create mode 100644 specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/listByResourceGroup.json create mode 100644 specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/listBySubscription.json create mode 100644 specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/listKeys.json create mode 100644 specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/regenerateKey.json create mode 100644 specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/update.json create mode 100644 specification/communication/resource-manager/readme.csharp.md create mode 100644 specification/communication/resource-manager/readme.go.md create mode 100644 specification/communication/resource-manager/readme.md create mode 100644 specification/communication/resource-manager/readme.python.md diff --git a/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/CommunicationService.json b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/CommunicationService.json new file mode 100644 index 000000000000..6e840a1d9a20 --- /dev/null +++ b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/CommunicationService.json @@ -0,0 +1,1088 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Communication Services Management API", + "version": "2020-08-20-preview", + "description": "REST API for Azure Communication Services" + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "host": "management.azure.com", + "schemes": [ + "https" + ], + "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.Communication/operations": { + "get": { + "description": "Lists all of the available REST API operations of the Microsoft.Communication provider.", + "operationId": "Operations_List", + "summary": "List Operations", + "tags": [ + "Operations" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}/linkNotificationHub": { + "post": { + "description": "Links an Azure Notification Hub to this communication service.", + "operationId": "CommunicationService_LinkNotificationHub", + "summary": "Link Notification Hub", + "tags": [ + "CommunicationService" + ], + "parameters": [ + { + "name": "linkNotificationHubParameters", + "in": "body", + "schema": { + "$ref": "#/definitions/LinkNotificationHubParameters" + }, + "description": "Parameters supplied to the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/CommunicationServiceName" + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Success. The notification hub has been linked.", + "schema": { + "$ref": "#/definitions/LinkedNotificationHub" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Link notification hub": { + "$ref": "./examples/linkNotificationHub.json" + } + } + } + }, + "/providers/Microsoft.Communication/locations/{location}/operationStatuses/{operationId}": { + "get": { + "description": "Gets the current status of an async operation.", + "operationId": "OperationStatuses_Get", + "summary": "Get Operation Status", + "tags": [ + "OperationStatus" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "The requested operation status", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get OperationStatus": { + "$ref": "./examples/getOperationStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Communication/communicationServices": { + "get": { + "description": "Handles requests to list all resources in a subscription.", + "operationId": "CommunicationService_ListBySubscription", + "summary": "List By Subscription", + "tags": [ + "CommunicationService" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of CommunicationServices in the subscription.", + "schema": { + "$ref": "#/definitions/CommunicationServiceResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List by subscription": { + "$ref": "./examples/listBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices": { + "get": { + "description": "Handles requests to list all resources in a resource group.", + "operationId": "CommunicationService_ListByResourceGroup", + "summary": "List By Resource Group", + "tags": [ + "CommunicationService" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of CommunicationServices in a resourceGroup.", + "schema": { + "$ref": "#/definitions/CommunicationServiceResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "List by resource group": { + "$ref": "./examples/listByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}": { + "patch": { + "description": "Operation to update an existing CommunicationService.", + "operationId": "CommunicationService_Update", + "summary": "Update", + "tags": [ + "CommunicationService" + ], + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameters for the update operation", + "required": false, + "schema": { + "$ref": "#/definitions/TaggedResource" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/CommunicationServiceName" + } + ], + "responses": { + "200": { + "description": "The update request was successful", + "schema": { + "$ref": "#/definitions/CommunicationServiceResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Update resource": { + "$ref": "./examples/update.json" + } + } + }, + "get": { + "description": "Get the CommunicationService and its properties.", + "operationId": "CommunicationService_Get", + "summary": "Get", + "tags": [ + "CommunicationService" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/CommunicationServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the corresponding CommunicationService service.", + "schema": { + "$ref": "#/definitions/CommunicationServiceResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get resource": { + "$ref": "./examples/get.json" + } + } + }, + "put": { + "description": "Create a new CommunicationService or update an existing CommunicationService.", + "operationId": "CommunicationService_CreateOrUpdate", + "summary": "Create Or Update", + "tags": [ + "CommunicationService" + ], + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameters for the create or update operation", + "required": false, + "schema": { + "$ref": "#/definitions/CommunicationServiceResource" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/CommunicationServiceName" + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "The create or update request was completed successfully", + "schema": { + "$ref": "#/definitions/CommunicationServiceResource" + } + }, + "201": { + "description": "The create or update request was accepted", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CommunicationServiceResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update resource": { + "$ref": "./examples/createOrUpdate.json" + } + } + }, + "delete": { + "description": "Operation to delete a CommunicationService.", + "operationId": "CommunicationService_Delete", + "summary": "Delete", + "tags": [ + "CommunicationService" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/CommunicationServiceName" + } + ], + "responses": { + "200": { + "description": "The delete operation was successful." + }, + "202": { + "description": "The delete operation is being performed in the background.", + "headers": { + "location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "The resource did not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete resource": { + "$ref": "./examples/delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}/listKeys": { + "post": { + "description": "Get the access keys of the CommunicationService resource.", + "operationId": "CommunicationService_ListKeys", + "summary": "List Keys", + "tags": [ + "CommunicationService" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/CommunicationServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes CommunicationService access keys.", + "schema": { + "$ref": "#/definitions/CommunicationServiceKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "List keys": { + "$ref": "./examples/listKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}/regenerateKey": { + "post": { + "description": "Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.", + "operationId": "CommunicationService_RegenerateKey", + "summary": "Regenerate Key", + "tags": [ + "CommunicationService" + ], + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameter that describes the Regenerate Key Operation.", + "required": false, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/CommunicationServiceName" + } + ], + "responses": { + "200": { + "description": "Created. The response contains the new key.", + "schema": { + "$ref": "#/definitions/CommunicationServiceKeys" + } + }, + "201": { + "description": "Created and an async operation is executing in background to make the new key take effect. The response contains new keys and an Azure-AsyncOperation header to query the async operation result.", + "schema": { + "$ref": "#/definitions/CommunicationServiceKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Regenerate key": { + "$ref": "./examples/regenerateKey.json" + } + } + } + } + }, + "definitions": { + "ErrorResponse": { + "description": "Error response indicating why the requested operation could not be performed.", + "type": "object", + "properties": { + "error": { + "description": "The error", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + } + } + }, + "OperationList": { + "description": "Result of the request to list REST API operations. It contains a list of operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the resource provider.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "Operation": { + "description": "REST API operation supported by CommunicationService resource provider.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation with format: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The object that describes the operation." + }, + "origin": { + "description": "Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Extra properties for the operation.", + "x-ms-client-flatten": false + } + } + }, + "OperationDisplay": { + "description": "The object that describes a operation.", + "type": "object", + "properties": { + "provider": { + "description": "Friendly name of the resource provider", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string" + }, + "description": { + "description": "The localized friendly description for the operation", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Extra Operation properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "The service specifications." + } + } + }, + "ServiceSpecification": { + "description": "An object that describes a specification.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + } + } + } + }, + "MetricSpecification": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the metric.", + "type": "string" + }, + "displayDescription": { + "description": "Localized friendly description of the metric.", + "type": "string" + }, + "unit": { + "description": "The unit that makes sense for the metric.", + "type": "string" + }, + "aggregationType": { + "description": "The method for aggregating the metric.", + "type": "string", + "enum": [ + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "x-ms-enum": { + "name": "AggregationType", + "modelAsString": true + } + }, + "fillGapWithZero": { + "description": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. \r\nEx. a metric that returns the number of times a particular error code was emitted. The error code may not appear \r\noften, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.", + "type": "string" + }, + "category": { + "description": "The name of the metric category that the metric belongs to. A metric can only belong to a single category.", + "type": "string" + }, + "dimensions": { + "description": "The dimensions of the metrics.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + } + } + } + }, + "Dimension": { + "description": "Specifications of the Dimension of metrics.", + "type": "object", + "properties": { + "name": { + "description": "The public facing name of the dimension.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the dimension.", + "type": "string" + }, + "internalName": { + "description": "Name of the dimension as it appears in MDM.", + "type": "string" + }, + "toBeExportedForShoebox": { + "description": "A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.", + "type": "boolean" + } + } + }, + "LinkNotificationHubParameters": { + "description": "Description of an Azure Notification Hub to link to the communication service", + "required": [ + "resourceId", + "connectionString" + ], + "type": "object", + "properties": { + "resourceId": { + "description": "The resource ID of the notification hub", + "type": "string" + }, + "connectionString": { + "description": "Connection string for the notification hub", + "type": "string" + } + } + }, + "LinkedNotificationHub": { + "description": "A notification hub that has been linked to the communication service", + "type": "object", + "properties": { + "resourceId": { + "description": "The resource ID of the notification hub", + "type": "string" + } + } + }, + "OperationStatus": { + "description": "The current status of an async operation", + "type": "object", + "properties": { + "id": { + "description": "The operation Id.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Provisioning state of the resource.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Deleting", + "Moving" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "startTime": { + "description": "The start time of the operation", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "endTime": { + "description": "The end time of the operation", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "percentComplete": { + "description": "Percent of the operation that is complete", + "type": "number", + "readOnly": true, + "minimum": 0, + "maximum": 100 + }, + "error": { + "description": "Operation Error message", + "$ref": "#/definitions/ErrorResponse", + "x-ms-client-flatten": true + } + } + }, + "CommunicationServiceResourceList": { + "description": "Object that includes an array of CommunicationServices and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of CommunicationService", + "type": "array", + "items": { + "$ref": "#/definitions/CommunicationServiceResource" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "CommunicationServiceResource": { + "description": "A class representing a CommunicationService resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "$ref": "#/definitions/LocationResource" + }, + { + "$ref": "#/definitions/TaggedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CommunicationServiceProperties", + "description": "The properties of the service.", + "x-ms-client-flatten": true + } + } + }, + "Resource": { + "description": "The core properties of ARM resources.", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified resource ID for the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the service - e.g. \"Microsoft.Communication/CommunicationServices\"", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "LocationResource": { + "description": "An ARM resource with its own location (not a global or an inherited location).", + "type": "object", + "properties": { + "location": { + "description": "The Azure location where the CommunicationService is running.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + } + }, + "TaggedResource": { + "description": "An ARM resource with that can accept tags", + "type": "object", + "properties": { + "tags": { + "description": "Tags of the service which is a list of key value pairs that describe the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ] + } + } + }, + "CommunicationServiceProperties": { + "description": "A class that describes the properties of the CommunicationService.", + "required": [ + "dataLocation" + ], + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the resource.", + "enum": [ + "Unknown", + "Succeeded", + "Failed", + "Canceled", + "Running", + "Creating", + "Updating", + "Deleting", + "Moving" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "hostName": { + "description": "FQDN of the CommunicationService instance.", + "type": "string", + "readOnly": true + }, + "dataLocation": { + "description": "The location where the communication service stores its data at rest.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "notificationHubId": { + "description": "Resource ID of an Azure Notification Hub linked to this resource.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs.", + "type": "string", + "readOnly": true + }, + "immutableResourceId": { + "description": "The immutable resource Id of the communication service.", + "type": "string", + "readOnly": true + } + } + }, + "CommunicationServiceKeys": { + "description": "A class representing the access keys of a CommunicationService.", + "type": "object", + "properties": { + "primaryKey": { + "description": "The primary access key.", + "type": "string" + }, + "secondaryKey": { + "description": "The secondary access key.", + "type": "string" + }, + "primaryConnectionString": { + "description": "CommunicationService connection string constructed via the primaryKey", + "type": "string" + }, + "secondaryConnectionString": { + "description": "CommunicationService connection string constructed via the secondaryKey", + "type": "string" + } + } + }, + "RegenerateKeyParameters": { + "description": "Parameters describes the request to regenerate access keys", + "type": "object", + "properties": { + "keyType": { + "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive).", + "enum": [ + "Primary", + "Secondary" + ], + "type": "string", + "x-ms-enum": { + "name": "KeyType", + "modelAsString": false + } + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string", + "enum": [ + "2020-08-20-preview" + ] + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Gets subscription ID which uniquely identifies the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "required": true, + "type": "string" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "CommunicationServiceName": { + "name": "communicationServiceName", + "in": "path", + "description": "The name of the CommunicationService resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "description": "The Azure region", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "description": "The ID of an ongoing async operation", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/createOrUpdate.json b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/createOrUpdate.json new file mode 100644 index 000000000000..aafec77cf065 --- /dev/null +++ b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/createOrUpdate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "12345", + "resourceGroupName": "MyResourceGroup", + "communicationServiceName": "MyCommunicationResource", + "api-version": "2020-08-20-preview", + "parameters": { + "location": "Global", + "properties": { + "dataLocation": "United States" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/CommunicationServices/MyCommunicationResource", + "name": "MyCommunicationResource", + "type": "Microsoft.Communication/CommunicationServices", + "location": "Global", + "properties": { + "dataLocation": "United States", + "provisioningState": "Succeeded", + "hostName": "mycommunicationresource.communications.azure.com" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.Communication/locations/westus/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "id": "/subscriptions/12345/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/CommunicationServices/MyCommunicationResource", + "name": "MyCommunicationResource", + "type": "Microsoft.Communication/CommunicationServices", + "location": "Global", + "properties": { + "dataLocation": "United States", + "provisioningState": "Accepted" + } + } + } + } +} diff --git a/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/delete.json b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/delete.json new file mode 100644 index 000000000000..5bb01a4d2773 --- /dev/null +++ b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "12345", + "resourceGroupName": "MyResourceGroup", + "communicationServiceName": "MyCommunicationResource", + "api-version": "2020-08-20-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Communication/locations/westus/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + } + }, + "204": {} + } +} diff --git a/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/get.json b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/get.json new file mode 100644 index 000000000000..ea4bdc176b41 --- /dev/null +++ b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "12345", + "resourceGroupName": "MyResourceGroup", + "communicationServiceName": "MyCommunicationResource", + "api-version": "2020-08-20-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/CommunicationServices/MyCommunicationResource", + "name": "MyCommunicationResource", + "type": "Microsoft.Communication/CommunicationServices", + "location": "Global", + "properties": { + "dataLocation": "United States", + "provisioningState": "Running", + "hostName": "mycommunicationservice.comms.azure.net", + "version": "0.2.0" + } + } + }, + "default": { + "body": { + "error": { + "code": "ResourceNotFound", + "message": "The requested resource was not found" + } + } + } + } +} diff --git a/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/getOperationStatus.json b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/getOperationStatus.json new file mode 100644 index 000000000000..caa62830d1e7 --- /dev/null +++ b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/getOperationStatus.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "location": "westus2", + "operationId": "db5f291f-284d-46e9-9152-d5c83f7c14b8", + "api-version": "2020-08-20-preview" + }, + "responses": { + "200": { + "body": { + "id": "db5f291f-284d-46e9-9152-d5c83f7c14b8", + "status": "Succeeded", + "startTime": "2020-07-06T17:06:26.100Z", + "endTime": "2020-07-06T17:06:42.800Z", + "percentComplete": 100 + } + }, + "default": { + "body": { + "error": { + "code": "OperationNotFound", + "message": "The requested async operation was not found" + } + } + } + } +} diff --git a/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/linkNotificationHub.json b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/linkNotificationHub.json new file mode 100644 index 000000000000..1f39fc5fecc3 --- /dev/null +++ b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/linkNotificationHub.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "12345", + "resourceGroupName": "MyResourceGroup", + "communicationServiceName": "MyCommunicationResource", + "api-version": "2020-08-20-preview", + "linkNotificationHubParameters": { + "resourceId": "/subscriptions/12345/resourceGroups/MyOtherResourceGroup/providers/Microsoft.NotificationHubs/namespaces/MyNamespace/notificationHubs/MyHub", + "connectionString": "Endpoint=sb://MyNamespace.servicebus.windows.net/;SharedAccessKey=abcd1234" + } + }, + "responses": { + "200": { + "body": { + "resourceId": "/subscriptions/12345/resourceGroups/MyOtherResourceGroup/providers/Microsoft.NotificationHubs/namespaces/MyNamespace/notificationHubs/MyHub" + } + }, + "default": { + "body": { + "error": { + "code": "WrongSubscription", + "message": "The notification hub must be in the same subscription as the communication service" + } + } + } + } +} diff --git a/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/listByResourceGroup.json b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/listByResourceGroup.json new file mode 100644 index 000000000000..139e7f6cf04f --- /dev/null +++ b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/listByResourceGroup.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "12345", + "resourceGroupName": "MyResourceGroup", + "api-version": "2020-08-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Running", + "dataLocation": "United States", + "hostName": "mycommunicationservice.comms.azure.net", + "version": "0.2.0" + } + } + ] + } + } + } +} diff --git a/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/listBySubscription.json b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/listBySubscription.json new file mode 100644 index 000000000000..8300a9f55093 --- /dev/null +++ b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/listBySubscription.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "12345", + "api-version": "2020-08-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Running", + "dataLocation": "United States", + "hostName": "mycommunicationservice.comms.azure.net", + "version": "0.2.0" + } + } + ] + } + } + } +} diff --git a/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/listKeys.json b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/listKeys.json new file mode 100644 index 000000000000..ee092cda96e0 --- /dev/null +++ b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/listKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "12345", + "resourceGroupName": "MyResourceGroup", + "communicationServiceName": "MyCommunicationResource", + "api-version": "2020-08-20-preview" + }, + "responses": { + "200": { + "body": { + "primaryKey": "1234", + "secondaryKey": "ABCD" + } + } + } +} diff --git a/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/regenerateKey.json b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/regenerateKey.json new file mode 100644 index 000000000000..72ba59e10b8f --- /dev/null +++ b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/regenerateKey.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "12345", + "resourceGroupName": "MyResourceGroup", + "communicationServiceName": "MyCommunicationResource", + "api-version": "2020-08-20-preview", + "parameters": { + "keyType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "primaryKey": "1234", + "primaryConnectionString": "endpoint=http://example.com;accesskey=1234" + } + }, + "201": { + "body": {} + } + } +} diff --git a/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/update.json b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/update.json new file mode 100644 index 000000000000..a441c4f0546c --- /dev/null +++ b/specification/communication/resource-manager/Microsoft.Communication/preview/2020-08-20-preview/examples/update.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "12345", + "resourceGroupName": "MyResourceGroup", + "communicationServiceName": "MyCommunicationResource", + "api-version": "2020-08-20-preview", + "parameters": { + "tags": { + "newTag": "newVal" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/CommunicationServices/MyCommunicationResource", + "name": "MyCommunicationResource", + "type": "Microsoft.Communication/CommunicationServices", + "location": "Global", + "tags": { + "newTag": "newVal" + }, + "properties": { + "provisioningState": "Succeeded", + "dataLocation": "United States", + "hostName": "mycommunicationresource.communications.azure.com", + "version": "0.2.0" + } + } + } + } +} diff --git a/specification/communication/resource-manager/readme.csharp.md b/specification/communication/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..f1aed9643153 --- /dev/null +++ b/specification/communication/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.Azure.Management.Communication + output-folder: $(csharp-sdks-folder)/communication/Microsoft.Azure.Management.Communication/src/Generated +``` diff --git a/specification/communication/resource-manager/readme.go.md b/specification/communication/resource-manager/readme.go.md new file mode 100644 index 000000000000..1434d5fd3791 --- /dev/null +++ b/specification/communication/resource-manager/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: communication + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2020-08-20-preview +``` + +### Tag: package-2020-08-20-preview and go + +These settings apply only when `--tag=package-2020-08-20-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-08-20-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-08-20-preview/$(namespace) +``` diff --git a/specification/communication/resource-manager/readme.md b/specification/communication/resource-manager/readme.md new file mode 100644 index 000000000000..2191f6dd16bf --- /dev/null +++ b/specification/communication/resource-manager/readme.md @@ -0,0 +1,70 @@ +# vsonline + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Azure Communication Services. + +--- + +## Getting Started + +To build the SDKs for Azure Communication Services, simply [Install AutoRest](https://aka.ms/autorest/install) or via `npm` (`npm install -g autorest`) and in this folder run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for the Azure Communication Services API. + +```yaml +title: CommunicationServiceManagementClient +openapi-type: arm +openapi-subtype: rpaas +tag: package-2020-08-20-preview +``` + +### Tag: package-2020-08-20-preview + +These settings apply only when `--tag=package-2020-08-20-preview` is specified on the command line. + +```yaml $(tag) == 'package-2020-08-20-preview' +input-file: + - Microsoft.Communication/preview/2020-08-20-preview/CommunicationService.json +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-net + - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-go + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_vsonline'] +``` + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) diff --git a/specification/communication/resource-manager/readme.python.md b/specification/communication/resource-manager/readme.python.md new file mode 100644 index 000000000000..18112d3b5145 --- /dev/null +++ b/specification/communication/resource-manager/readme.python.md @@ -0,0 +1,44 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + + +``` yaml !$(track2) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.communication + package-name: azure-mgmt-communication + package-version: 1.0.0rc1 + clear-output-folder: true +``` + +These settings apply only when `--track2` is specified on the command line. + +``` yaml $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-communication +no-namespace-folders: true +package-version: 1.0.0rc1 +``` + +```yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/communication/azure-mgmt-communication/azure/mgmt/communication +no-namespace-folders: true +output-folder: $(python-sdks-folder)/communication/azure-mgmt-communication/azure/mgmt/communication +``` + +```yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/communication/azure-mgmt-communication +basic-setup-py: true +output-folder: $(python-sdks-folder)/communication/azure-mgmt-communication +``` From b8b8a53f43405c03e0073dd3c7ab41ab54003525 Mon Sep 17 00:00:00 2001 From: vayada Date: Mon, 21 Sep 2020 23:08:08 -0700 Subject: [PATCH 106/164] Fixed S360 issues related to ARM & SDK swagger linting errors for Microsoft.Solutions. (#10804) * Fixed Swagger linting ARM & SDK issues. * Fixed Swagger linting ARM & SDK issues. * Fixed model validation & example errors. * Fixed example errors. * Fixed example errors. * Prettier check commit. * Added examples. * Added examples. * Added examples. --- .../examples/deleteApplicationDefinition.json | 13 ++ .../managedapplications.json | 87 ++++++++-- .../examples/createOrUpdateApplication.json | 27 ++- .../createOrUpdateApplicationDefinition.json | 42 ++++- .../examples/deleteApplicationDefinition.json | 13 ++ .../2018-06-01/examples/getApplication.json | 7 +- .../examples/getApplicationDefinition.json | 8 +- ...ApplicationDefinitionsByResourceGroup.json | 6 +- .../listApplicationsByResourceGroup.json | 4 - .../examples/listSolutionsOperations.json | 30 ++++ .../2018-06-01/managedapplications.json | 158 ++++++++++++++++-- .../examples/deleteApplicationDefinition.json | 13 ++ .../2019-07-01/managedapplications.json | 87 ++++++++-- 13 files changed, 427 insertions(+), 68 deletions(-) create mode 100644 specification/resources/resource-manager/Microsoft.Solutions/preview/2020-08-21-preview/examples/deleteApplicationDefinition.json create mode 100644 specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/deleteApplicationDefinition.json create mode 100644 specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/listSolutionsOperations.json create mode 100644 specification/resources/resource-manager/Microsoft.Solutions/stable/2019-07-01/examples/deleteApplicationDefinition.json diff --git a/specification/resources/resource-manager/Microsoft.Solutions/preview/2020-08-21-preview/examples/deleteApplicationDefinition.json b/specification/resources/resource-manager/Microsoft.Solutions/preview/2020-08-21-preview/examples/deleteApplicationDefinition.json new file mode 100644 index 000000000000..ec85348c1fa0 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Solutions/preview/2020-08-21-preview/examples/deleteApplicationDefinition.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "applicationDefinitionName": "myManagedApplicationDef", + "api-version": "2020-08-21-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/resources/resource-manager/Microsoft.Solutions/preview/2020-08-21-preview/managedapplications.json b/specification/resources/resource-manager/Microsoft.Solutions/preview/2020-08-21-preview/managedapplications.json index 58091ce4a537..285104f4ea18 100644 --- a/specification/resources/resource-manager/Microsoft.Solutions/preview/2020-08-21-preview/managedapplications.json +++ b/specification/resources/resource-manager/Microsoft.Solutions/preview/2020-08-21-preview/managedapplications.json @@ -272,7 +272,7 @@ "name": "parameters", "in": "body", "schema": { - "$ref": "#/definitions/Application" + "$ref": "#/definitions/ApplicationPatchable" }, "description": "Parameters supplied to update an existing managed application." }, @@ -1106,24 +1106,43 @@ } }, "x-ms-paths": { - "/{applicationDefinitionId}?disambiguation_dummy": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applicationDefinitions/{applicationDefinitionName}?disambiguation_dummy": { "get": { "tags": [ "ApplicationDefinitions" ], "operationId": "ApplicationDefinitions_GetById", "description": "Gets the managed application definition.", + "x-ms-examples": { + "Get managed application definition": { + "$ref": "./examples/getApplicationDefinition.json" + } + }, "parameters": [ { - "name": "applicationDefinitionId", + "name": "resourceGroupName", "in": "path", "required": true, "type": "string", - "description": "The fully qualified ID of the managed application definition, including the managed application name and the managed application definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applicationDefinitions/{applicationDefinition-name}", - "x-ms-skip-url-encoding": true + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "applicationDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed application definition.", + "minLength": 3, + "maxLength": 64 }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -1147,17 +1166,36 @@ ], "operationId": "ApplicationDefinitions_DeleteById", "description": "Deletes the managed application definition.", + "x-ms-examples": { + "Get managed application definition": { + "$ref": "./examples/deleteApplicationDefinition.json" + } + }, "parameters": [ { - "name": "applicationDefinitionId", + "name": "resourceGroupName", "in": "path", "required": true, "type": "string", - "description": "The fully qualified ID of the managed application definition, including the managed application name and the managed application definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applicationDefinitions/{applicationDefinition-name}", - "x-ms-skip-url-encoding": true + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "applicationDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed application definition.", + "minLength": 3, + "maxLength": 64 }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -1185,14 +1223,36 @@ ], "operationId": "ApplicationDefinitions_CreateOrUpdateById", "description": "Creates a new managed application definition.", + "x-ms-examples": { + "Create or update managed application definition": { + "$ref": "./examples/createOrUpdateApplicationDefinition.json" + } + }, "parameters": [ { - "name": "applicationDefinitionId", + "name": "resourceGroupName", "in": "path", "required": true, "type": "string", - "description": "The fully qualified ID of the managed application definition, including the managed application name and the managed application definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applicationDefinitions/{applicationDefinition-name}", - "x-ms-skip-url-encoding": true + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "applicationDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed application definition.", + "minLength": 3, + "maxLength": 64 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { "name": "parameters", @@ -1202,9 +1262,6 @@ "$ref": "#/definitions/ApplicationDefinition" }, "description": "Parameters supplied to the create or update a managed application definition." - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -1268,7 +1325,7 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationPropertiesPatchable", + "$ref": "#/definitions/ApplicationProperties", "description": "The managed application properties." }, "plan": { diff --git a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/createOrUpdateApplication.json b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/createOrUpdateApplication.json index 957c3d0ec451..451460766d90 100644 --- a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/createOrUpdateApplication.json +++ b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/createOrUpdateApplication.json @@ -2,14 +2,12 @@ "parameters": { "subscriptionId": "subid", "resourceGroupName": "rg", - "managedApplicationName": "myManagedApplication", + "applicationName": "myManagedApplication", "api-version": "2018-06-01", "parameters": { "properties": { - "managedApplicationDefinitionId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applicationDefinitions/myAppDef", "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG" }, - "name": "myManagedApplication", "location": "East US 2", "kind": "ServiceCatalog" } @@ -23,14 +21,33 @@ "type": "Microsoft.Solutions/applications", "location": "East US 2", "managedBy": null, - "resourceGroup": "rg", "tags": null, "plan": null, "identity": null, "kind": "ServiceCatalog", "sku": null, "properties": { - "managedApplicationDefinitionId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applicationDefinitions/myAppDef", + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "outputs": null, + "parameters": null, + "provisioningState": "Created" + } + } + }, + "200": { + "headers": {}, + "body": { + "name": "myManagedApplication", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applications/myManagedApplication", + "type": "Microsoft.Solutions/applications", + "location": "East US 2", + "managedBy": null, + "tags": null, + "plan": null, + "identity": null, + "kind": "ServiceCatalog", + "sku": null, + "properties": { "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", "outputs": null, "parameters": null, diff --git a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/createOrUpdateApplicationDefinition.json b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/createOrUpdateApplicationDefinition.json index 6e1863f58728..745348a35fe4 100644 --- a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/createOrUpdateApplicationDefinition.json +++ b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/createOrUpdateApplicationDefinition.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "subid", "resourceGroupName": "rg", - "managedApplicationDefinitionName": "myManagedApplicationDef", + "applicationDefinitionName": "myManagedApplicationDef", "api-version": "2018-06-01", "parameters": { "properties": { @@ -29,7 +29,6 @@ "type": "Microsoft.Solutions/applicationDefinitions", "location": "East US 2", "managedBy": null, - "resourceGroup": "rg", "tags": null, "identity": null, "sku": null, @@ -54,7 +53,44 @@ ], "description": "myManagedApplicationDef description", "displayName": "myManagedApplicationDef", - "lockLevel": null, + "lockLevel": "None", + "packageFileUri": "https://path/to/packagezipfile" + } + } + }, + "200": { + "headers": {}, + "body": { + "name": "myManagedApplicationDef", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/applicationDefinitions/myManagedApplicationDef", + "type": "Microsoft.Solutions/applicationDefinitions", + "location": "East US 2", + "managedBy": null, + "tags": null, + "identity": null, + "sku": null, + "properties": { + "artifacts": [ + { + "name": "CreateUiDefinition", + "type": "Custom", + "uri": "https://path/to/managedApplicationCreateUiDefinition.json" + }, + { + "name": "ManagedApplicationResourceTemplate", + "type": "Template", + "uri": "https://path/to/mainTemplate.json" + } + ], + "authorizations": [ + { + "principalId": "validprincipalguid", + "roleDefinitionId": "validroleguid" + } + ], + "description": "myManagedApplicationDef description", + "displayName": "myManagedApplicationDef", + "lockLevel": "None", "packageFileUri": "https://path/to/packagezipfile" } } diff --git a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/deleteApplicationDefinition.json b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/deleteApplicationDefinition.json new file mode 100644 index 000000000000..72e9f6531a59 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/deleteApplicationDefinition.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "applicationDefinitionName": "myManagedApplicationDef", + "api-version": "2018-06-01" + }, + "responses": { + "204": {}, + "200": {}, + "202": {} + } +} diff --git a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/getApplication.json b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/getApplication.json index cf83b23e112d..339b581af507 100644 --- a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/getApplication.json +++ b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/getApplication.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "subid", "resourceGroupName": "rg", - "managedApplicationName": "myManagedApplication", + "applicationName": "myManagedApplication", "api-version": "2018-06-01" }, "responses": { @@ -14,20 +14,19 @@ "type": "Microsoft.Solutions/applications", "location": "East US 2", "managedBy": null, - "resourceGroup": "rg", "tags": null, "plan": null, "identity": null, "kind": "ServiceCatalog", "sku": null, "properties": { - "managedApplicationDefinitionId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/managedApplicationDefinitions/myAppDef", "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", "outputs": null, "parameters": null, "provisioningState": "Created" } } - } + }, + "404": {} } } diff --git a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/getApplicationDefinition.json b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/getApplicationDefinition.json index f3ee03cc02df..b6886c726d4d 100644 --- a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/getApplicationDefinition.json +++ b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/getApplicationDefinition.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "subid", "resourceGroupName": "rg", - "managedApplicationName": "myManagedApplicationDef", + "applicationDefinitionName": "myManagedApplicationDef", "api-version": "2018-06-01" }, "responses": { @@ -14,7 +14,6 @@ "type": "Microsoft.Solutions/applicationDefinitions", "location": "East US 2", "managedBy": null, - "resourceGroup": "rg", "tags": null, "identity": null, "sku": null, @@ -39,10 +38,11 @@ ], "description": "myManagedApplicationDef description", "displayName": "myManagedApplicationDef", - "lockLevel": null, + "lockLevel": "None", "packageFileUri": "https://path/to/packagezipfile" } } - } + }, + "404": {} } } diff --git a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/listApplicationDefinitionsByResourceGroup.json b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/listApplicationDefinitionsByResourceGroup.json index faec6495dd23..a7924b761b65 100644 --- a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/listApplicationDefinitionsByResourceGroup.json +++ b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/listApplicationDefinitionsByResourceGroup.json @@ -15,7 +15,6 @@ "type": "Microsoft.Solutions/applicationDefinitions", "location": "East US 2", "managedBy": null, - "resourceGroup": "rg", "tags": null, "identity": null, "sku": null, @@ -40,7 +39,7 @@ ], "description": "myManagedApplicationDef description", "displayName": "myManagedApplicationDef", - "lockLevel": null, + "lockLevel": "None", "packageFileUri": "https://path/to/packagezipfile" } }, @@ -50,7 +49,6 @@ "type": "Microsoft.Solutions/applicationDefinitions", "location": "West US", "managedBy": null, - "resourceGroup": "rg", "tags": null, "identity": null, "sku": null, @@ -75,7 +73,7 @@ ], "description": "myManagedApplicationDef2 description", "displayName": "myManagedApplicationDef2", - "lockLevel": null, + "lockLevel": "None", "packageFileUri": "https://path/to/packagezipfile" } } diff --git a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/listApplicationsByResourceGroup.json b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/listApplicationsByResourceGroup.json index 2cea45e315b8..ffc143598fec 100644 --- a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/listApplicationsByResourceGroup.json +++ b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/listApplicationsByResourceGroup.json @@ -15,14 +15,12 @@ "type": "Microsoft.Solutions/applications", "location": "East US 2", "managedBy": null, - "resourceGroup": "rg", "tags": null, "plan": null, "identity": null, "kind": "ServiceCatalog", "sku": null, "properties": { - "managedApplicationDefinitionId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/managedApplicationDefinitions/myAppDef", "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", "outputs": null, "parameters": null, @@ -35,14 +33,12 @@ "type": "Microsoft.Solutions/applications", "location": "West US", "managedBy": null, - "resourceGroup": "rg", "tags": null, "plan": null, "identity": null, "kind": "ServiceCatalog", "sku": null, "properties": { - "managedApplicationDefinitionId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Solutions/managedApplicationDefinitions/myAppDef2", "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", "outputs": null, "parameters": null, diff --git a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/listSolutionsOperations.json b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/listSolutionsOperations.json new file mode 100644 index 000000000000..55f367f84dc3 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/examples/listSolutionsOperations.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "SolutionsOpeartion1", + "display": { + "provider": "Microsoft.ResourceProvider", + "resource": "Resource1", + "operation": "Read" + } + }, + { + "name": "SolutionssOpeartion2", + "display": { + "provider": "Microsoft.ResourceProvider", + "resource": "Resource2", + "operation": "Write" + } + } + ] + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/managedapplications.json b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/managedapplications.json index 2702391b5df7..2653ec9878f1 100644 --- a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/managedapplications.json +++ b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/managedapplications.json @@ -34,6 +34,36 @@ } }, "paths": { + "/providers/Microsoft.Solutions/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "ListOperations", + "description": "Lists all of the available Microsoft.Solutions REST API operations.", + "x-ms-examples": { + "List Solutions operations": { + "$ref": "./examples/listSolutionsOperations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/{applicationName}": { "get": { "tags": [ @@ -239,7 +269,7 @@ "name": "parameters", "in": "body", "schema": { - "$ref": "#/definitions/Application" + "$ref": "#/definitions/ApplicationPatchable" }, "description": "Parameters supplied to update an existing managed application." }, @@ -745,24 +775,43 @@ } }, "x-ms-paths": { - "/{applicationDefinitionId}?disambiguation_dummy": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applicationDefinitions/{applicationDefinitionName}?disambiguation_dummy": { "get": { "tags": [ "ApplicationDefinitions" ], "operationId": "ApplicationDefinitions_GetById", "description": "Gets the managed application definition.", + "x-ms-examples": { + "Get managed application definition": { + "$ref": "./examples/getApplicationDefinition.json" + } + }, "parameters": [ { - "name": "applicationDefinitionId", + "name": "resourceGroupName", "in": "path", "required": true, "type": "string", - "description": "The fully qualified ID of the managed application definition, including the managed application name and the managed application definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applicationDefinitions/{applicationDefinition-name}", - "x-ms-skip-url-encoding": true + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "applicationDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed application definition.", + "minLength": 3, + "maxLength": 64 }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -789,17 +838,36 @@ ], "operationId": "ApplicationDefinitions_DeleteById", "description": "Deletes the managed application definition.", + "x-ms-examples": { + "Get managed application definition": { + "$ref": "./examples/deleteApplicationDefinition.json" + } + }, "parameters": [ { - "name": "applicationDefinitionId", + "name": "resourceGroupName", "in": "path", "required": true, "type": "string", - "description": "The fully qualified ID of the managed application definition, including the managed application name and the managed application definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applicationDefinitions/{applicationDefinition-name}", - "x-ms-skip-url-encoding": true + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "applicationDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed application definition.", + "minLength": 3, + "maxLength": 64 }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -827,14 +895,36 @@ ], "operationId": "ApplicationDefinitions_CreateOrUpdateById", "description": "Creates a new managed application definition.", + "x-ms-examples": { + "Create or update managed application definition": { + "$ref": "./examples/createOrUpdateApplicationDefinition.json" + } + }, "parameters": [ { - "name": "applicationDefinitionId", + "name": "resourceGroupName", "in": "path", "required": true, "type": "string", - "description": "The fully qualified ID of the managed application definition, including the managed application name and the managed application definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applicationDefinitions/{applicationDefinition-name}", - "x-ms-skip-url-encoding": true + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "applicationDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed application definition.", + "minLength": 3, + "maxLength": 64 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { "name": "parameters", @@ -844,9 +934,6 @@ "$ref": "#/definitions/ApplicationDefinition" }, "description": "Parameters supplied to the create or update a managed application definition." - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -1351,6 +1438,49 @@ "type": "string" } } + }, + "Operation": { + "description": "Microsoft.Solutions 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.Solutions", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed: Application, JitRequest, etc.", + "type": "string" + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string" + } + } + } + } + }, + "OperationListResult": { + "description": "Result of the request to list Microsoft.Solutions operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Microsoft.Solutions operations." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } } }, "parameters": { diff --git a/specification/resources/resource-manager/Microsoft.Solutions/stable/2019-07-01/examples/deleteApplicationDefinition.json b/specification/resources/resource-manager/Microsoft.Solutions/stable/2019-07-01/examples/deleteApplicationDefinition.json new file mode 100644 index 000000000000..c542a5d3dd5f --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Solutions/stable/2019-07-01/examples/deleteApplicationDefinition.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "applicationDefinitionName": "myManagedApplicationDef", + "api-version": "2019-07-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/resources/resource-manager/Microsoft.Solutions/stable/2019-07-01/managedapplications.json b/specification/resources/resource-manager/Microsoft.Solutions/stable/2019-07-01/managedapplications.json index 6a3432f615ea..df4427a208ec 100644 --- a/specification/resources/resource-manager/Microsoft.Solutions/stable/2019-07-01/managedapplications.json +++ b/specification/resources/resource-manager/Microsoft.Solutions/stable/2019-07-01/managedapplications.json @@ -266,7 +266,7 @@ "name": "parameters", "in": "body", "schema": { - "$ref": "#/definitions/Application" + "$ref": "#/definitions/ApplicationPatchable" }, "description": "Parameters supplied to update an existing managed application." }, @@ -1097,24 +1097,43 @@ } }, "x-ms-paths": { - "/{applicationDefinitionId}?disambiguation_dummy": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applicationDefinitions/{applicationDefinitionName}?disambiguation_dummy": { "get": { "tags": [ "ApplicationDefinitions" ], "operationId": "ApplicationDefinitions_GetById", "description": "Gets the managed application definition.", + "x-ms-examples": { + "Get managed application definition": { + "$ref": "./examples/getApplicationDefinition.json" + } + }, "parameters": [ { - "name": "applicationDefinitionId", + "name": "resourceGroupName", "in": "path", "required": true, "type": "string", - "description": "The fully qualified ID of the managed application definition, including the managed application name and the managed application definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applicationDefinitions/{applicationDefinition-name}", - "x-ms-skip-url-encoding": true + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "applicationDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed application definition.", + "minLength": 3, + "maxLength": 64 }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -1138,17 +1157,36 @@ ], "operationId": "ApplicationDefinitions_DeleteById", "description": "Deletes the managed application definition.", + "x-ms-examples": { + "Get managed application definition": { + "$ref": "./examples/deleteApplicationDefinition.json" + } + }, "parameters": [ { - "name": "applicationDefinitionId", + "name": "resourceGroupName", "in": "path", "required": true, "type": "string", - "description": "The fully qualified ID of the managed application definition, including the managed application name and the managed application definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applicationDefinitions/{applicationDefinition-name}", - "x-ms-skip-url-encoding": true + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "applicationDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed application definition.", + "minLength": 3, + "maxLength": 64 }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -1176,14 +1214,36 @@ ], "operationId": "ApplicationDefinitions_CreateOrUpdateById", "description": "Creates a new managed application definition.", + "x-ms-examples": { + "Create or update managed application definition": { + "$ref": "./examples/createOrUpdateApplicationDefinition.json" + } + }, "parameters": [ { - "name": "applicationDefinitionId", + "name": "resourceGroupName", "in": "path", "required": true, "type": "string", - "description": "The fully qualified ID of the managed application definition, including the managed application name and the managed application definition resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.Solutions/applicationDefinitions/{applicationDefinition-name}", - "x-ms-skip-url-encoding": true + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "applicationDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed application definition.", + "minLength": 3, + "maxLength": 64 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" }, { "name": "parameters", @@ -1193,9 +1253,6 @@ "$ref": "#/definitions/ApplicationDefinition" }, "description": "Parameters supplied to the create or update a managed application definition." - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -1259,7 +1316,7 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ApplicationPropertiesPatchable", + "$ref": "#/definitions/ApplicationProperties", "description": "The managed application properties." }, "plan": { From 38907c94084f9f6222206872b99674d3d48cd3e3 Mon Sep 17 00:00:00 2001 From: Eran Gonen Date: Tue, 22 Sep 2020 09:10:26 +0300 Subject: [PATCH 107/164] Fixed ActionRule's polymorphism via discriminator (#10829) --- .../2019-05-05-preview/ActionRules.json | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/ActionRules.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/ActionRules.json index 25123080680b..a441d6e0b967 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/ActionRules.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/ActionRules.json @@ -850,15 +850,15 @@ "$ref": "#/definitions/ActionRuleProperties" }, { - "type": "object" - } - ], - "properties": { - "suppressionConfig": { - "description": "suppression configuration for the action rule", - "$ref": "#/definitions/SuppressionConfig" + "type": "object", + "properties": { + "suppressionConfig": { + "description": "suppression configuration for the action rule", + "$ref": "#/definitions/SuppressionConfig" + } + } } - } + ] }, "ActionGroup": { "title": "Action Group based Action Rule", @@ -871,15 +871,15 @@ "$ref": "#/definitions/ActionRuleProperties" }, { - "type": "object" - } - ], - "properties": { - "actionGroupId": { - "type": "string", - "description": "Action group to trigger if action rule matches" + "type": "object", + "properties": { + "actionGroupId": { + "type": "string", + "description": "Action group to trigger if action rule matches" + } + } } - } + ] }, "Diagnostics": { "title": "Diagnostics based Action Rule", From 05e595db6c02b0c29c1690bdc21633c1175e795c Mon Sep 17 00:00:00 2001 From: msyyc <70930885+msyyc@users.noreply.github.com> Date: Tue, 22 Sep 2020 15:46:19 +0800 Subject: [PATCH 108/164] .md for python (#10881) --- .../resource-manager/readme.md | 1 + .../resource-manager/readme.python.md | 34 +++++++++++++++---- 2 files changed, 29 insertions(+), 6 deletions(-) diff --git a/specification/baremetalinfrastructure/resource-manager/readme.md b/specification/baremetalinfrastructure/resource-manager/readme.md index 2efae511812e..a56160acb966 100644 --- a/specification/baremetalinfrastructure/resource-manager/readme.md +++ b/specification/baremetalinfrastructure/resource-manager/readme.md @@ -50,6 +50,7 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js diff --git a/specification/baremetalinfrastructure/resource-manager/readme.python.md b/specification/baremetalinfrastructure/resource-manager/readme.python.md index 4f59e49672a9..3048a78804d7 100644 --- a/specification/baremetalinfrastructure/resource-manager/readme.python.md +++ b/specification/baremetalinfrastructure/resource-manager/readme.python.md @@ -2,20 +2,42 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. +Use --python-mode=update if you already have a setup.py and just want to update the code itself. -```yaml $(python) +```yaml !$(track2) +python-mode: create python: azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION payload-flattening-threshold: 2 - namespace: Microsoft.BareMetalInfrastructure - package-name: baremetalinfrastructure - package-version: 2020-08-06-preview + namespace: azure.mgmt.baremetalinfrastructure + package-name: azure-mgmt-baremetalinfrastructure + package-version: 0.1.0 clear-output-folder: true ``` -```yaml $(python) +These settings apply only when `--track2` is specified on the command line. + +``` yaml $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-baremetalinfrastructure +no-namespace-folders: true +package-version: 0.1.0 +``` + +``` yaml $(python-mode) == 'update' python: no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt/baremetalinfrastructure + output-folder: $(python-sdks-folder)/baremetalinfrastructure/azure-mgmt-baremetalinfrastructure/azure/mgmt/baremetalinfrastructure +no-namespace-folders: true +output-folder: $(python-sdks-folder)/baremetalinfrastructure/azure-mgmt-baremetalinfrastructure/azure/mgmt/baremetalinfrastructure ``` + +``` yaml $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/baremetalinfrastructure/azure-mgmt-baremetalinfrastructure +basic-setup-py: true +output-folder: $(python-sdks-folder)/baremetalinfrastructure/azure-mgmt-baremetalinfrastructure +``` \ No newline at end of file From 421231a8e36c63b9c2d1a1692152b14ccf637cbf Mon Sep 17 00:00:00 2001 From: Ray Chen Date: Tue, 22 Sep 2020 19:32:48 +0800 Subject: [PATCH 109/164] Assignment config (#10850) * Add free-form object spec for testing purpose. * Revert "Add free-form object spec for testing purpose." This reverts commit b711d809b6ae964fcbe7d04f31fec76db8798438. * Add powerplatform assignment. --- .github/pull_request_assignment.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_assignment.yml b/.github/pull_request_assignment.yml index 6f86ab255279..abdb98fcfd0c 100644 --- a/.github/pull_request_assignment.yml +++ b/.github/pull_request_assignment.yml @@ -30,7 +30,7 @@ - yungezz - rule: - paths: "specification/resources/**" + paths: "specification/@(resources|powerplatform)/**" reviewers: - raych1 From 507dd9455810e1b3805f2b2ca4483e39559dad72 Mon Sep 17 00:00:00 2001 From: vikrampraveen Date: Tue, 22 Sep 2020 08:56:03 -0700 Subject: [PATCH 110/164] Bring up ACS eventgrid events swagger (#10880) * Add Communication Services Specifications * Remove Go code generation * Bring back AzureCommunicationServices swagger * Merge the swagger changes from feature/commununication Co-authored-by: Reza Jooyandeh Co-authored-by: Reza Jooyandeh Co-authored-by: Vikram Praveen Kumar --- custom-words.txt | 1 + .../AzureCommunicationServices.json | 350 ++++++++++++++++++ specification/eventgrid/data-plane/readme.md | 2 + 3 files changed, 353 insertions(+) create mode 100644 specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json diff --git a/custom-words.txt b/custom-words.txt index 602c49385a73..6aa19385dc88 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1955,6 +1955,7 @@ watchlist Watchlist Stix STIX +ACSSMS Mibps ntfs networkrulesets diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json new file mode 100644 index 000000000000..8d83d520a87a --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json @@ -0,0 +1,350 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-01-01", + "title": "Schema of Azure Communication Services events published to Azure Event Grid", + "description": "Describes the schema of the Azure Communication Services events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent." + }, + "paths": {}, + "definitions": { + "ACSChatMessageReceivedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatMessageReceived event.", + "allOf": [ + { + "$ref": "#/definitions/ACSChatMessageEventBaseProperties" + } + ], + "properties": { + "messageBody": { + "description": "The body of the chat message", + "type": "string" + } + } + }, + "ACSChatMessageEditedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatMessageEdited event.", + "allOf": [ + { + "$ref": "#/definitions/ACSChatMessageEventBaseProperties" + } + ], + "properties": { + "messageBody": { + "description": "The body of the chat message", + "type": "string" + }, + "editTime": { + "description": "The time at which the message was edited", + "format": "date-time", + "type": "string" + } + } + }, + "ACSChatMessageDeletedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatMessageDeleted event.", + "allOf": [ + { + "$ref": "#/definitions/ACSChatMessageEventBaseProperties" + } + ], + "properties": { + "deleteTime": { + "description": "The time at which the message was deleted", + "format": "date-time", + "type": "string" + } + } + }, + "ACSChatThreadCreatedWithUserEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatThreadCreatedWithUser event.", + "allOf": [ + { + "$ref": "#/definitions/ACSChatThreadEventBaseProperties" + } + ], + "properties": { + "createdBy": { + "description": "The MRI of the creator of the thread", + "type": "string" + }, + "properties": { + "description": "The thread properties", + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "members": { + "description": "The list of properties of users who are part of the thread", + "type": "array", + "items": { + "$ref": "#/definitions/ACSChatThreadMemberProperties" + } + } + } + }, + "ACSChatThreadWithUserDeletedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatThreadWithUserDeleted event.", + "allOf": [ + { + "$ref": "#/definitions/ACSChatThreadEventBaseProperties" + } + ], + "properties": { + "deletedBy": { + "description": "The MRI of the user who deleted the thread", + "type": "string" + }, + "deleteTime": { + "description": "The deletion time of the thread", + "format": "date-time", + "type": "string" + } + } + }, + "ACSChatThreadPropertiesUpdatedPerUserEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatThreadPropertiesUpdatedPerUser event.", + "allOf": [ + { + "$ref": "#/definitions/ACSChatThreadEventBaseProperties" + } + ], + "properties": { + "editedBy": { + "description": "The MRI of the user who updated the thread properties", + "type": "string" + }, + "editTime": { + "description": "The time at which the properties of the thread were updated", + "format": "date-time", + "type": "string" + }, + "properties": { + "description": "The updated thread properties", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "ACSChatMemberAddedToThreadWithUserEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatMemberAddedToThreadWithUser event.", + "allOf": [ + { + "$ref": "#/definitions/ACSChatThreadEventBaseProperties" + } + ], + "properties": { + "time": { + "description": "The time at which the user was added to the thread", + "format": "date-time", + "type": "string" + }, + "addedBy": { + "description": "The MRI of the user who added the user", + "type": "string" + }, + "memberAdded": { + "description": "The details of the user who was added", + "$ref": "#/definitions/ACSChatThreadMemberProperties" + } + } + }, + "ACSChatMemberRemovedFromThreadWithUserEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.ChatMemberRemovedFromThreadWithUser event.", + "allOf": [ + { + "$ref": "#/definitions/ACSChatThreadEventBaseProperties" + } + ], + "properties": { + "time": { + "description": "The time at which the user was removed to the thread", + "format": "date-time", + "type": "string" + }, + "removedBy": { + "description": "The MRI of the user who removed the user", + "type": "string" + }, + "memberRemoved": { + "description": "The details of the user who was removed", + "$ref": "#/definitions/ACSChatThreadMemberProperties" + } + } + }, + "ACSSMSDeliveryReportReceivedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.SMSDeliveryReportReceived event.", + "allOf": [ + { + "$ref": "#/definitions/ACSSMSEventBaseProperties" + } + ], + "properties": { + "deliveryStatus": { + "description": "Status of Delivery", + "type": "string" + }, + "deliveryStatusDetails": { + "description": "Details about Delivery Status", + "type": "string" + }, + "deliveryAttempts": { + "description": "List of details of delivery attempts made", + "type": "array", + "items": { + "$ref": "#/definitions/ACSSMSDeliveryAttemptProperties" + } + }, + "receivedTimestamp": { + "description": "The time at which the SMS delivery report was received", + "format": "date-time", + "type": "string" + } + } + }, + "ACSSMSReceivedEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.SMSReceived event.", + "allOf": [ + { + "$ref": "#/definitions/ACSSMSEventBaseProperties" + } + ], + "properties": { + "message": { + "description": "The SMS content", + "type": "string" + }, + "receivedTimestamp": { + "description": "The time at which the SMS was received", + "format": "date-time", + "type": "string" + } + } + }, + "ACSChatThreadEventBaseProperties": { + "description": "Schema of common properties of all chat thread events", + "allOf": [ + { + "$ref": "#/definitions/ACSChatEventBaseProperties" + } + ], + "properties": { + "createTime": { + "description": "The original creation time of the thread", + "format": "date-time", + "type": "string" + }, + "version": { + "description": "The version of the thread", + "type": "integer" + } + } + }, + "ACSChatMessageEventBaseProperties": { + "description": "Schema of common properties of all chat message events", + "allOf": [ + { + "$ref": "#/definitions/ACSChatEventBaseProperties" + } + ], + "properties": { + "messageId": { + "description": "The chat message id", + "type": "string" + }, + "senderId": { + "description": "The MRI of the sender", + "type": "string" + }, + "senderDisplayName": { + "description": "The display name of the sender", + "type": "string" + }, + "composeTime": { + "description": "The original compose time of the message", + "format": "date-time", + "type": "string" + }, + "type": { + "description": "The type of the message", + "type": "string" + }, + "version": { + "description": "The version of the message", + "type": "integer" + } + } + }, + "ACSChatEventBaseProperties": { + "description": "Schema of common properties of all chat events", + "type": "object", + "properties": { + "recipientId": { + "description": "The MRI of the target user", + "type": "string" + }, + "transactionId": { + "description": "The transaction id will be used as co-relation vector", + "type": "string" + }, + "threadId": { + "description": "The chat thread id", + "type": "string" + } + } + }, + "ACSChatThreadMemberProperties": { + "description": "Schema of the chat thread member", + "type": "object", + "properties": { + "displayName": { + "description": "The name of the user", + "type": "string" + }, + "memberId": { + "description": "The MRI of the user", + "type": "string" + } + } + }, + "ACSSMSEventBaseProperties": { + "description": "Schema of common properties of all SMS events", + "type": "object", + "properties": { + "messageId": { + "description": "The identity of the SMS message", + "type": "string" + }, + "from": { + "description": "The identity of SMS message sender", + "type": "string" + }, + "to": { + "description": "The identity of SMS message receiver", + "type": "string" + } + } + }, + "ACSSMSDeliveryAttemptProperties": { + "description": "Schema for details of a delivery attempt", + "type": "object", + "properties": { + "timestamp": { + "description": "TimeStamp when delivery was attempted", + "format": "date-time", + "type": "string" + }, + "segmentsSucceeded": { + "description": "Number of segments that were successfully delivered", + "type": "integer" + }, + "segmentsFailed": { + "description": "Number of segments whose delivery failed", + "type": "integer" + } + } + } + } +} diff --git a/specification/eventgrid/data-plane/readme.md b/specification/eventgrid/data-plane/readme.md index 05a8c882b111..744ddac3e43e 100644 --- a/specification/eventgrid/data-plane/readme.md +++ b/specification/eventgrid/data-plane/readme.md @@ -59,6 +59,7 @@ input-file: - Microsoft.MachineLearningServices/stable/2018-01-01/MachineLearningServices.json - Microsoft.Cache/stable/2018-01-01/RedisCache.json - Microsoft.Web/stable/2018-01-01/Web.json +- Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json ``` ### Suppression @@ -150,6 +151,7 @@ input-file: - $(this-folder)/Microsoft.MachineLearningServices/stable/2018-01-01/MachineLearningServices.json - $(this-folder)/Microsoft.Cache/stable/2018-01-01/RedisCache.json - $(this-folder)/Microsoft.Web/stable/2018-01-01/Web.json + - $(this-folder)/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json ``` From 3791590b2d949657f3653ecd12b0172262c217bf Mon Sep 17 00:00:00 2001 From: kalyanrk61 Date: Tue, 22 Sep 2020 18:50:02 -0700 Subject: [PATCH 111/164] DataFactory: Update Rest Sink properties based on ship room comments. (#10815) * add rest sink swagger * update with shiproom comments Co-authored-by: Kalyan C Kesireddy --- .../stable/2018-06-01/entityTypes/Pipeline.json | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index ea95f8ea806d..35aa8392c78c 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -2203,13 +2203,9 @@ "type": "object", "description": "The time to await before sending next request, in milliseconds " }, - "compressionType": { + "httpCompressionType": { "type": "object", - "description": "Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip. " - }, - "wrapRequestJsonInAnObject": { - "type": "object", - "description": "Wraps Request Array Json into an Object before calling the rest endpoint , Default is false. ex: if true request content sample format is { rows:[]} else the format is []" + "description": "Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip. " } } }, From a37acc947bd00f88e74b7f381be6ff962d65c4e8 Mon Sep 17 00:00:00 2001 From: Liran Chen <1437075+liranc@users.noreply.github.com> Date: Wed, 23 Sep 2020 05:10:46 +0300 Subject: [PATCH 112/164] [Hub Generated] Review request for Microsoft.Security to add version preview/2020-08-06-preview (#10773) * Add onPremiseSensors * Suppress * Specify file download schema * Fix validaiton Co-authored-by: Liran Chen --- .../IotSensors/DownloadActivation.json | 7 +- .../examples/IotSensors/List.json | 2 +- .../examples/OnPremiseIotSensors/Delete.json | 11 + .../DownloadActivation.json | 15 + .../examples/OnPremiseIotSensors/Get.json | 17 ++ .../examples/OnPremiseIotSensors/List.json | 26 ++ .../examples/OnPremiseIotSensors/Put.json | 25 ++ .../2020-08-06-preview/iotSensors.json | 11 +- .../onPremiseIotSensors.json | 283 ++++++++++++++++++ .../security/resource-manager/readme.md | 10 + 10 files changed, 403 insertions(+), 4 deletions(-) create mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Delete.json create mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/DownloadActivation.json create mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Get.json create mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/List.json create mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Put.json create mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/onPremiseIotSensors.json diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/DownloadActivation.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/DownloadActivation.json index 2aebd9e8ac3b..7274a7caecc6 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/DownloadActivation.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/DownloadActivation.json @@ -5,6 +5,11 @@ "iotSensorName": "mySensor" }, "responses": { - "200": {} + "200": { + "headers": { + "content-type": "application/zip" + }, + "body": "{Binary}" + } } } diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/List.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/List.json index b7e9675bad0d..576d3874d317 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/List.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotSensors/List.json @@ -15,7 +15,7 @@ }, { "name": "otherSensor", - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/iotSensors/otherSensor", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Devices/IotHubs/myHub/providers/Microsoft.Security/iotSensors/otherSensor", "type": "Microsoft.Security/iotSensors", "properties": {} } diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Delete.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Delete.json new file mode 100644 index 000000000000..21b5427051fc --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2020-08-06-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "onPremiseIotSensorName": "mySensor" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/DownloadActivation.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/DownloadActivation.json new file mode 100644 index 000000000000..b2236a188f58 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/DownloadActivation.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2020-08-06-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "onPremiseIotSensorName": "mySensor" + }, + "responses": { + "200": { + "headers": { + "content-type": "application/zip" + }, + "body": "{Binary}" + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Get.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Get.json new file mode 100644 index 000000000000..e504ee9a9086 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Get.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-08-06-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "onPremiseIotSensorName": "mySensor" + }, + "responses": { + "200": { + "body": { + "name": "mySensor", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/onPremiseIotSensors/mySensor", + "type": "Microsoft.Security/onPremiseIotSensors", + "properties": {} + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/List.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/List.json new file mode 100644 index 000000000000..f2536dd92897 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/List.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2020-08-06-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mySensor", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/iotSensors/mySensor", + "type": "Microsoft.Security/onPremiseIotSensors", + "properties": {} + }, + { + "name": "otherSensor", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/iotSensors/otherSensor", + "type": "Microsoft.Security/onPremiseIotSensors", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Put.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Put.json new file mode 100644 index 000000000000..80f3d877d6d4 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/OnPremiseIotSensors/Put.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-08-06-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "onPremiseIotSensorName": "mySensor" + }, + "responses": { + "200": { + "body": { + "name": "mySensor", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/iotSensors/mySensor", + "type": "Microsoft.Security/onPremiseIotSensors", + "properties": {} + } + }, + "201": { + "body": { + "name": "mySensor", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/iotSensors/mySensor", + "type": "Microsoft.Security/onPremiseIotSensors", + "properties": {} + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotSensors.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotSensors.json index cad4e4eaf779..1f2aa771251f 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotSensors.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotSensors.json @@ -201,6 +201,9 @@ ], "operationId": "IotSensors_DownloadActivation", "description": "Download sensor activation file", + "produces": [ + "application/zip" + ], "parameters": [ { "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" @@ -214,7 +217,11 @@ ], "responses": { "200": { - "description": "Downloaded activation file" + "description": "Downloaded activation file", + "schema": { + "type": "object", + "format": "file" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -269,7 +276,7 @@ "in": "path", "required": true, "type": "string", - "description": "Scope of the query, can be subscription (/subscriptions/326b1ffa-8ac7-4034-8437-69bef733dede) or IoT Hub (/providers/Microsoft.Devices/iotHubs/myHub)", + "description": "Scope of the query (IoT Hub, /providers/Microsoft.Devices/iotHubs/myHub)", "x-ms-parameter-location": "method", "x-ms-skip-url-encoding": true }, diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/onPremiseIotSensors.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/onPremiseIotSensors.json new file mode 100644 index 000000000000..87fa110c99d4 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/onPremiseIotSensors.json @@ -0,0 +1,283 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Center", + "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", + "version": "2020-08-06-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/onPremiseIotSensors": { + "get": { + "x-ms-examples": { + "List on-premise IoT sensors": { + "$ref": "./examples/OnPremiseIotSensors/List.json" + } + }, + "tags": [ + "On-Premise IoT Sensors" + ], + "description": "List on-premise IoT sensors", + "operationId": "OnPremiseIotSensors_List", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OnPremiseIotSensorsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/onPremiseIotSensors/{onPremiseIotSensorName}": { + "get": { + "x-ms-examples": { + "Get on-premise IoT sensor": { + "$ref": "./examples/OnPremiseIotSensors/Get.json" + } + }, + "tags": [ + "On-Premise IoT Sensors" + ], + "operationId": "OnPremiseIotSensors_Get", + "description": "Get on-premise IoT sensor", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/OnPremiseIotSensorName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OnPremiseIotSensor" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or update on-premise IoT sensor": { + "$ref": "./examples/OnPremiseIotSensors/Put.json" + } + }, + "tags": [ + "On-Premise IoT Sensors" + ], + "operationId": "OnPremiseIotSensors_CreateOrUpdate", + "description": "Create or update on-premise IoT sensor", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/OnPremiseIotSensorName" + } + ], + "responses": { + "200": { + "description": "Updated on-premise IoT sensor", + "schema": { + "$ref": "#/definitions/OnPremiseIotSensor" + } + }, + "201": { + "description": "Created on-premise IoT sensor", + "schema": { + "$ref": "#/definitions/OnPremiseIotSensor" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete on-premise IoT sensor": { + "$ref": "./examples/OnPremiseIotSensors/Delete.json" + } + }, + "tags": [ + "On-Premise IoT Sensors" + ], + "operationId": "OnPremiseIotSensors_Delete", + "description": "Delete on-premise IoT sensor", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/OnPremiseIotSensorName" + } + ], + "responses": { + "200": { + "description": "Deleted on-premise IoT sensor" + }, + "204": { + "description": "On-premise IoT sensor does not exist" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/onPremiseIotSensors/{onPremiseIotSensorName}/downloadActivation": { + "post": { + "x-ms-examples": { + "Download activation file": { + "$ref": "./examples/OnPremiseIotSensors/DownloadActivation.json" + } + }, + "tags": [ + "On-Premise IoT Sensors" + ], + "operationId": "OnPremiseIotSensors_DownloadActivation", + "description": "Download sensor activation file", + "produces": [ + "application/zip" + ], + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/OnPremiseIotSensorName" + } + ], + "responses": { + "200": { + "description": "Downloaded activation file", + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "OnPremiseIotSensorsList": { + "description": "List of on-premise IoT sensors", + "type": "object", + "properties": { + "value": { + "description": "List data", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/OnPremiseIotSensor" + } + } + } + }, + "OnPremiseIotSensor": { + "type": "object", + "description": "On-premise IoT sensor", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "On-premise IoT sensor properties", + "$ref": "#/definitions/OnPremiseIotSensorProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/Resource" + } + ] + }, + "OnPremiseIotSensorProperties": { + "type": "object", + "description": "On-premise IoT sensor properties", + "properties": {} + } + }, + "parameters": { + "OnPremiseIotSensorName": { + "name": "onPremiseIotSensorName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the on-premise IoT sensor", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/security/resource-manager/readme.md b/specification/security/resource-manager/readme.md index a05992d01aef..87e3b6b42e5f 100644 --- a/specification/security/resource-manager/readme.md +++ b/specification/security/resource-manager/readme.md @@ -52,6 +52,14 @@ directive: from: iotSensors.json where: '$.paths["/{scope}/providers/Microsoft.Security/iotSensors/{iotSensorName}"].get' reason: The list returns limited number of items + - suppress: PageableOperation + from: onPremiseIotSensors.json + where: '$.paths["/subscriptions/{subscriptionId}/providers/Microsoft.Security/onPremiseIotSensors"].get' + reason: The list returns limited number of items + - suppress: TopLevelResourcesListByResourceGroup + from: onPremiseIotSensors.json + where: $.definitions.OnPremiseIotSensor + reason: The resource is managed in a subscription level (instead of inside a resource group) ``` ### Basic Information @@ -195,6 +203,7 @@ input-file: - Microsoft.Security/preview/2020-01-01-preview/connectors.json - Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json - Microsoft.Security/preview/2020-08-06-preview/iotSensors.json +- Microsoft.Security/preview/2020-08-06-preview/onPremiseIotSensors.json # Needed when there is more than one input file override-info: @@ -380,6 +389,7 @@ These settings apply only when `--tag=package-2020-08-preview-only` is specified input-file: - Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json - Microsoft.Security/preview/2020-08-06-preview/iotSensors.json +- Microsoft.Security/preview/2020-08-06-preview/onPremiseIotSensors.json # Needed when there is more than one input file override-info: From ededa408913291dc1f0b3f8e812d2c90de203af6 Mon Sep 17 00:00:00 2001 From: Lei Ni <7233663+leni-msft@users.noreply.github.com> Date: Wed, 23 Sep 2020 11:11:08 +0800 Subject: [PATCH 113/164] Add readme.azureresourceschema.md for sample rp (#10764) --- .../samplefiles/readme.azureresourceschema.md | 24 +++++++++++++++++++ documentation/samplefiles/samplereadme.md | 7 ++++++ 2 files changed, 31 insertions(+) create mode 100644 documentation/samplefiles/readme.azureresourceschema.md diff --git a/documentation/samplefiles/readme.azureresourceschema.md b/documentation/samplefiles/readme.azureresourceschema.md new file mode 100644 index 000000000000..819cac202170 --- /dev/null +++ b/documentation/samplefiles/readme.azureresourceschema.md @@ -0,0 +1,24 @@ +## AzureResourceSchema + +These settings apply only when `--azureresourceschema` is specified on the command line. + +### AzureResourceSchema multi-api + +``` yaml $(azureresourceschema) && $(multiapi) +batch: + - tag: schema-yourservicename-YYYY-MM-DD + +``` + +Please also specify `--azureresourceschema-folder=`. + +### Tag: schema-yourservicename-YYYY-MM-DD and azureresourceschema + +``` yaml $(tag) == 'schema-yourservicename-YYYY-MM-DD' && $(azureresourceschema) +output-folder: $(azureresourceschema-folder)/schemas + +# all the input files in this apiVersion +input-file: + - Microsoft.YourServiceName/stable/YYYY-MM-DD/YourServiceName.json + +``` diff --git a/documentation/samplefiles/samplereadme.md b/documentation/samplefiles/samplereadme.md index f76fab965fc8..af02111a6c18 100644 --- a/documentation/samplefiles/samplereadme.md +++ b/documentation/samplefiles/samplereadme.md @@ -56,6 +56,9 @@ swagger-to-sdk: - repo: azure-sdk-for-ruby after_scripts: - bundle install && rake arm:regen_all_profiles['azure_mgmt_YourServiceName'] + - repo: azure-resource-manager-schemas + after_scripts: + - node sdkauto_afterscript.js yourservicename/resource-manager ``` ## Go @@ -77,3 +80,7 @@ See configuration in [readme.typescript.md](https://github.com/Azure/azure-rest- ## CSharp See configuration in [readme.csharp.md](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/samplefiles/readme.chsarp.md) + +## AzureResourceSchema + +See configuration in [readme.azureresourceschema.md](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/samplefiles/readme.azureresourceschema.md) From dedd0efe5eb92257c3fcdb7b1aa18ef00cd6ea7c Mon Sep 17 00:00:00 2001 From: Moshe Malka Date: Wed, 23 Sep 2020 06:16:04 +0300 Subject: [PATCH 114/164] [Hub Generated] Review request for Microsoft.Insights to add version preview/2020-05-01-preview (#10891) * change enum operator and failingPeriods type * add 2020-05-preview Co-authored-by: Moshe Malka --- .../scheduledQueryRule_API.json | 12 ++++++++---- .../monitor/resource-manager/readme.python.md | 15 +++++++++++++++ 2 files changed, 23 insertions(+), 4 deletions(-) diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-05-01-preview/scheduledQueryRule_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-05-01-preview/scheduledQueryRule_API.json index 278a0a1a97ce..6d30d3fa0ac5 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-05-01-preview/scheduledQueryRule_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-05-01-preview/scheduledQueryRule_API.json @@ -511,7 +511,7 @@ "LessThanOrEqual" ], "x-ms-enum": { - "name": "Operator", + "name": "conditionOperator", "modelAsString": true }, "description": "The criteria operator." @@ -526,11 +526,15 @@ "description": "The minimum number of violations required within the selected lookback time window required to raise an alert.", "properties": { "numberOfEvaluationPeriods": { - "type": "number", + "type": "integer", + "format": "int64", + "default": 1, "description": "The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. Default value is 1" }, "minFailingPeriodsToAlert": { - "type": "number", + "type": "integer", + "format": "int64", + "default": 1, "description": "The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1" } } @@ -558,7 +562,7 @@ "Exclude" ], "x-ms-enum": { - "name": "operator", + "name": "dimensionOperator", "modelAsString": true } }, diff --git a/specification/monitor/resource-manager/readme.python.md b/specification/monitor/resource-manager/readme.python.md index 8d483156a925..92a777c5f250 100644 --- a/specification/monitor/resource-manager/readme.python.md +++ b/specification/monitor/resource-manager/readme.python.md @@ -30,6 +30,7 @@ Generate all API versions currently shipped for this package ```yaml $(multiapi) && !$(track2) batch: + - tag: package-2020-05-preview - tag: package-2020-01-01-preview-only - tag: package-2019-10-17-preview-only - tag: package-2019-06-01-only @@ -54,6 +55,7 @@ batch: ```yaml $(multiapi) && $(track2) clear-output-folder: true batch: + - tag: package-2020-05-preview - tag: package-2020-01-01-preview-only - tag: package-2019-10-17-preview-only - tag: package-2019-06-01-only @@ -82,6 +84,19 @@ clear-output-folder: false perform-load: false ``` +### Tag: package-2020-05-preview and python + +These settings apply only when `--tag=package-2020-05-preview --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-05-preview' +namespace: $(python-base-namespace).v2020_05_01_preview +output-folder: $(python-sdks-folder)/$(python-base-folder)/v2020_05_01_preview +python: + namespace: $(python-base-namespace).v2020_05_01_preview + output-folder: $(python-sdks-folder)/$(python-base-folder)/v2020_05_01_preview +``` + ### Tag: package-2020-01-01-preview-only and python These settings apply only when `--tag=package-2020-01-01-preview-only --python` is specified on the command line. From 48fcff7c0388a10ad94d2f4293abde7f72686091 Mon Sep 17 00:00:00 2001 From: Sebastian Herzig-Patel Date: Tue, 22 Sep 2020 20:37:54 -0700 Subject: [PATCH 115/164] [Hub Generated] Review request for Microsoft.DigitalTwins to add version stable/2020-10-31 (#10902) * Fix code generation issue * Resolved merge conflict --- .../Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json index a649d243d702..a0d33dd14c94 100644 --- a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json +++ b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/stable/2020-10-31/digitaltwins.json @@ -895,6 +895,7 @@ "ExternalResource": { "description": "Definition of a resource.", "type": "object", + "x-ms-azure-resource": true, "properties": { "id": { "readOnly": true, @@ -916,7 +917,6 @@ }, "DigitalTwinsEndpointResource": { "description": "DigitalTwinsInstance endpoint resource.", - "x-ms-azure-resource": true, "allOf": [ { "$ref": "#/definitions/ExternalResource" From ac98b0ee99b7650031d4df43eb9e999aa200d3aa Mon Sep 17 00:00:00 2001 From: Lei Ni <7233663+leni-msft@users.noreply.github.com> Date: Wed, 23 Sep 2020 13:29:10 +0800 Subject: [PATCH 116/164] Update SDKAutomation.yml for Azure Pipelines (#10904) * Update SDKAutomation.yml for Azure Pipelines * Update SDKAutomation.yml for Azure Pipelines * Update SDKAutomation.yml for Azure Pipelines * Update SDKAutomation.yml for Azure Pipelines * Update SDKAutomation.yml for Azure Pipelines * Update SDKAutomation.yml for Azure Pipelines * Update SDKAutomation.yml for Azure Pipelines * Update SDKAutomation.yml for Azure Pipelines --- .azure-pipelines/SDKAutomation.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.azure-pipelines/SDKAutomation.yml b/.azure-pipelines/SDKAutomation.yml index a567d468ab0b..982a0fd77d77 100644 --- a/.azure-pipelines/SDKAutomation.yml +++ b/.azure-pipelines/SDKAutomation.yml @@ -41,9 +41,8 @@ jobs: SDK_REPO_NAME: azure-sdk-for-go Trenton: SDK_REPO_NAME: azure-sdk-for-trenton - ${{ if eq(variables['ENABLE_RESOURCE_MANAGER_SCHEMAS'], 'true') }}: - Schema: - SDK_REPO_NAME: azure-resource-manager-schemas + Schema: + SDK_REPO_NAME: azure-resource-manager-schemas steps: - checkout: none - script: | @@ -80,6 +79,7 @@ jobs: -e AZURE_DEVOPS_EXT_PAT \ -e BUILD_ID \ sdk-automation:latest npm start + condition: or(ne(variables['SDK_REPO_NAME'], 'azure-resource-manager-schemas'), endsWith(variables['SPEC_REPO'], '/azure-rest-api-specs')) env: BLOB_STORAGE_NAME: $(blob-storage-name) BLOB_STORAGE_KEY: $(blob-storage-key) From 7a555b82850876e8cc5c0f51ec52585913da8e6f Mon Sep 17 00:00:00 2001 From: hohershk <58219337+hohershk@users.noreply.github.com> Date: Wed, 23 Sep 2020 08:43:23 +0300 Subject: [PATCH 117/164] Operationalinsights/data export delete all tables param (#10775) * microsoft.operationalinsights_add_data_export * fix * fix * delete_unneeded_property Co-authored-by: Hodaya Hershkovich --- .../2019-08-01-preview/examples/DataExportCreateOrUpdate.json | 1 - .../preview/2019-08-01-preview/examples/DataExportGet.json | 1 - .../examples/DataExportListByWorkspace.json | 1 - .../preview/2020-03-01-preview/DataExports.json | 4 ---- .../2020-03-01-preview/examples/DataExportCreateOrUpdate.json | 2 -- .../preview/2020-03-01-preview/examples/DataExportGet.json | 1 - .../examples/DataExportListByWorkspace.json | 1 - 7 files changed, 11 deletions(-) diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportCreateOrUpdate.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportCreateOrUpdate.json index f738632a370c..00e71ce6ab28 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportCreateOrUpdate.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportCreateOrUpdate.json @@ -25,7 +25,6 @@ "resourceId": "/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test", "type": "EventHub" }, - "allTables": false, "tableNames": [ "Heartbeat" ], diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportGet.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportGet.json index aee7dba8ecfb..472297024e2b 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportGet.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportGet.json @@ -15,7 +15,6 @@ "resourceId": "/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test", "type": "EventHub" }, - "allTables": false, "tableNames": [ "Heartbeat" ], diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportListByWorkspace.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportListByWorkspace.json index 4d0a89e0b861..0d01e4a909c9 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportListByWorkspace.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2019-08-01-preview/examples/DataExportListByWorkspace.json @@ -15,7 +15,6 @@ "resourceId": "/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test", "type": "EventHub" }, - "allTables": false, "tableNames": [ "Heartbeat" ], diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/DataExports.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/DataExports.json index d776e4a1ff24..4ca8b68ce1a2 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/DataExports.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/DataExports.json @@ -276,10 +276,6 @@ "type": "string", "description": "The data export rule ID." }, - "allTables": { - "type": "boolean", - "description": "When ‘true’, all workspace's tables are exported." - }, "tableNames": { "type": "array", "items": { diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportCreateOrUpdate.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportCreateOrUpdate.json index 413c8a0480bf..02b00dbe7a71 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportCreateOrUpdate.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportCreateOrUpdate.json @@ -25,7 +25,6 @@ "resourceId": "/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test", "type": "EventHub" }, - "allTables": false, "tableNames": [ "Heartbeat" ], @@ -46,7 +45,6 @@ "resourceId": "/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test", "type": "EventHub" }, - "allTables": false, "tableNames": [ "Heartbeat" ], diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportGet.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportGet.json index 0bb0b00f44b5..1be2c0459fea 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportGet.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportGet.json @@ -15,7 +15,6 @@ "resourceId": "/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test", "type": "EventHub" }, - "allTables": false, "tableNames": [ "Heartbeat" ], diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportListByWorkspace.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportListByWorkspace.json index acec03e93f8a..df13cd8a8444 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportListByWorkspace.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportListByWorkspace.json @@ -16,7 +16,6 @@ "resourceId": "/subscriptions/192b9f85-a39a-4276-b96d-d5cd351703f9/resourceGroups/OIAutoRest1234/providers/Microsoft.EventHub/namespaces/test", "type": "EventHub" }, - "allTables": false, "tableNames": [ "Heartbeat" ], From 0107a840ba2826d50e19283f7d82766ab5121cc6 Mon Sep 17 00:00:00 2001 From: Junyang Chen Date: Tue, 22 Sep 2020 22:58:51 -0700 Subject: [PATCH 118/164] Add location info for cross region compute feature (#10816) --- .../machineLearningServices.json | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json index dc61a4cb656b..3c283424747c 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json @@ -2249,6 +2249,11 @@ "type": "string", "description": "Specifies the resource ID." }, + "amlWorkspaceLocation": { + "readOnly": true, + "type": "string", + "description": "Region of the AML workspace in the id." + }, "type": { "readOnly": true, "type": "string", @@ -2524,6 +2529,10 @@ "items": { "$ref": "#/definitions/QuotaBaseProperties" } + }, + "location": { + "description": "Region of workspace quota to be updated.", + "type": "string" } }, "description": "Quota update parameters." @@ -2621,6 +2630,11 @@ "type": "string", "description": "Specifies the resource ID." }, + "amlWorkspaceLocation": { + "readOnly": true, + "type": "string", + "description": "Region of the AML workspace in the id." + }, "type": { "readOnly": true, "type": "string", From 88e86e706ad26f3c7efa7a913977e651150f0f3b Mon Sep 17 00:00:00 2001 From: Arcturus Date: Wed, 23 Sep 2020 14:17:02 +0800 Subject: [PATCH 119/164] Add api-version of 2019-10-01/comsuption to go SDK (#10749) --- specification/consumption/resource-manager/readme.go.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/specification/consumption/resource-manager/readme.go.md b/specification/consumption/resource-manager/readme.go.md index 2cd5284033ad..a0de97215d8d 100644 --- a/specification/consumption/resource-manager/readme.go.md +++ b/specification/consumption/resource-manager/readme.go.md @@ -22,8 +22,17 @@ batch: - tag: package-2018-08 - tag: package-2018-10 - tag: package-2019-01 + - tag: package-2019-10 ``` +### Tag: package-2019-10 and go + +These settings apply only when `--tag=package-2019-10 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2019-10' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2019-10-01/$(namespace) +``` ### Tag: package-2017-04-preview and go From 7e631da3d3b1c572c0d7b76c89855d7a8e72fa92 Mon Sep 17 00:00:00 2001 From: Braden Watkins Date: Tue, 22 Sep 2020 23:24:35 -0700 Subject: [PATCH 120/164] Add documentation for downloading invoices through Microsoft.Billing API (#10585) - 2019-10-01-preview - POST Multiple Modern Invoice Download - 2019-10-01-preview - POST Multiple EA Invoice Download - 2019-10-01-preview - POST Multiple Legacy Invoice Download - 2019-10-01-preview - Changed ErrorResponse and ErrorDetails - 2020-05-01 - POST Multiple Invoice Download (Modern & EA) - 2020-05-01 - POST Multiple Legacy Invoice Download - 2020-05-01 - Changed ErrorResponse and ErrorDetails Co-authored-by: Braden Watkins --- .../preview/2018-03-01-preview/billingV2.json | 28 +++ .../preview/2019-10-01-preview/billing.json | 235 ++++++++++++++++++ ...pleBillingSubscriptionInvoiceDownload.json | 24 ++ .../examples/MultipleInvoiceDownload.json | 24 ++ .../MultipleModernInvoiceDownload.json | 25 ++ .../stable/2020-05-01/billing.json | 166 ++++++++++++- .../BillingSubscriptionInvoiceDownload.json | 2 +- ...wnload.json => ModernInvoiceDownload.json} | 2 +- ...pleBillingSubscriptionInvoiceDownload.json | 24 ++ .../MultipleModernInvoiceDownload.json | 24 ++ 10 files changed, 551 insertions(+), 3 deletions(-) create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/MultipleBillingSubscriptionInvoiceDownload.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/MultipleInvoiceDownload.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/MultipleModernInvoiceDownload.json rename specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/{InvoiceDownload.json => ModernInvoiceDownload.json} (83%) create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MultipleBillingSubscriptionInvoiceDownload.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MultipleModernInvoiceDownload.json diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/billingV2.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/billingV2.json index e9b752a24fda..a4b03809ce4f 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/billingV2.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/billingV2.json @@ -322,6 +322,11 @@ "description": "The target of the particular error.", "type": "string", "readOnly": true + }, + "details": { + "description": "The sub details of the error.", + "readOnly": true, + "$ref": "#/definitions/ErrorSubDetails" } } }, @@ -335,6 +340,29 @@ } } }, + "ErrorSubDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "The target of the particular error.", + "type": "string", + "readOnly": true + } + } + } + }, "Resource": { "description": "The Resource model definition.", "properties": { diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json index 680b35022642..2f6b7a0b47ad 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json @@ -1685,6 +1685,74 @@ } } }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/downloadDocuments": { + "post": { + "tags": [ + "Invoices" + ], + "x-ms-examples": { + "InvoiceDownload": { + "$ref": "./examples/MultipleInvoiceDownload.json" + } + }, + "operationId": "Invoices_DownloadMultipleEAInvoice", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "description": "Gets a URL to download an multiple invoices documents (invoice pdf, tax receipts, credit notes) as a zip file.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "name": "downloadUrls", + "in": "body", + "required": true, + "description": "An array of download urls for individual documents. The download url paths in the request body should match the path of the original request.", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "202": { + "description": "Accepted.", + "headers": { + "Location": { + "description": "GET this URL to retrieve the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "type": "string" + } + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}": { "get": { "tags": [ @@ -1724,6 +1792,74 @@ } } }, + "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/downloadDocuments": { + "post": { + "tags": [ + "Invoices" + ], + "x-ms-examples": { + "BillingSubscriptionInvoiceDownload": { + "$ref": "./examples/MultipleBillingSubscriptionInvoiceDownload.json" + } + }, + "operationId": "Invoices_DownloadMultipleBillingSubscriptionInvoice", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "description": "Gets a URL to download multiple invoices documents (invoice pdf, tax receipts, credit notes) as a zip file.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "name": "downloadUrls", + "in": "body", + "required": true, + "description": "An array of download urls for individual documents. The download url paths in the request body should match the path of the original request.", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "202": { + "description": "Accepted.", + "headers": { + "Location": { + "description": "GET this URL to retrieve the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "type": "string" + } + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}/pricesheet/default/download": { "post": { "tags": [ @@ -1900,6 +2036,77 @@ } } }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/downloadDocuments": { + "post": { + "tags": [ + "Invoices" + ], + "x-ms-examples": { + "ModernInvoiceDownload": { + "$ref": "./examples/MultipleModernInvoiceDownload.json" + } + }, + "operationId": "Invoices_DownloadMultipleModernInvoice", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "description": "Gets a URL to download multiple invoices documents (invoice pdf, tax receipts, credit notes) as a zip file.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "name": "downloadUrls", + "in": "body", + "required": true, + "description": "An array of download urls for individual documents. The download url paths in the request body should match the path of the original request.", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "202": { + "description": "Accepted.", + "headers": { + "Location": { + "description": "GET this URL to retrieve the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "type": "string" + } + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}": { "get": { "tags": [ @@ -7004,6 +7211,11 @@ "description": "The target of the particular error.", "type": "string", "readOnly": true + }, + "details": { + "description": "The sub details of the error.", + "readOnly": true, + "$ref": "#/definitions/ErrorSubDetails" } } }, @@ -7017,6 +7229,29 @@ } } }, + "ErrorSubDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "The target of the particular error.", + "type": "string", + "readOnly": true + } + } + } + }, "Reseller": { "description": "Details of the reseller.", "properties": { diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/MultipleBillingSubscriptionInvoiceDownload.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/MultipleBillingSubscriptionInvoiceDownload.json new file mode 100644 index 000000000000..a810e1a7775d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/MultipleBillingSubscriptionInvoiceDownload.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "subscriptionId": "{subscriptionId}", + "downloadUrls": [ + "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}/download?downloadToken={downloadToken}&useCache=True&api-version=2019-10-01-preview", + "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}/download?downloadToken={downloadToken}&useCache=True&api-version=2019-10-01-preview", + "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}/download?downloadToken={downloadToken}&useCache=True&api-version=2019-10-01-preview" + ] + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/operationResults/invoiceDownload_{operationId}?api-version=2019-10-01-preview", + "Retry-After": "10" + } + }, + "200": { + "body": { + "url": "https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sig=sp=r" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/MultipleInvoiceDownload.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/MultipleInvoiceDownload.json new file mode 100644 index 000000000000..bd9e7f59f578 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/MultipleInvoiceDownload.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}", + "downloadUrls": [ + "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/download?downloadToken={downloadToken}&useCache=True&api-version=2019-10-01-preview", + "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/download?downloadToken={downloadToken}&useCache=True&api-version=2019-10-01-preview", + "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/download?downloadToken={downloadToken}&useCache=True&api-version=2019-10-01-preview" + ] + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/operationResults/invoiceDownload_{operationId}?api-version=2019-10-01-preview", + "Retry-After": "10" + } + }, + "200": { + "body": { + "url": "https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sp=r" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/MultipleModernInvoiceDownload.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/MultipleModernInvoiceDownload.json new file mode 100644 index 000000000000..cafb3e2cbaa7 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/MultipleModernInvoiceDownload.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}", + "downloadUrls": [ + "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}billingProfiles/{billingProfileName}/invoices/{invoiceName}/download?downloadToken={downloadToken}&useCache=True&api-version=2019-10-01-preview", + "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}billingProfiles/{billingProfileName}/invoices/{invoiceName}/download?downloadToken={downloadToken}&useCache=True&api-version=2019-10-01-preview", + "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}billingProfiles/{billingProfileName}/invoices/{invoiceName}/download?downloadToken={downloadToken}&useCache=True&api-version=2019-10-01-preview" + ] + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}billingProfiles/{billingProfileName}/invoices/{invoiceName}/operationResults/invoiceDownload_{operationId}?api-version=2019-10-01-preview", + "Retry-After": "10" + } + }, + "200": { + "body": { + "url": "https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sp=r" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json index fecbec2a08c9..65048a244a9f 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json @@ -1274,7 +1274,7 @@ ], "x-ms-examples": { "InvoiceDownload": { - "$ref": "./examples/InvoiceDownload.json" + "$ref": "./examples/ModernInvoiceDownload.json" } }, "operationId": "Invoices_DownloadInvoice", @@ -1333,6 +1333,74 @@ } } }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/downloadDocuments": { + "post": { + "tags": [ + "Invoices" + ], + "x-ms-examples": { + "InvoiceDownload": { + "$ref": "./examples/MultipleModernInvoiceDownload.json" + } + }, + "operationId": "Invoices_DownloadMultipleModernInvoice", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "description": "Gets a URL to download an multiple invoices documents (invoice pdf, tax receipts, credit notes) as a zip file. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "name": "downloadUrls", + "in": "body", + "required": true, + "description": "An array of download urls for individual documents", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "202": { + "description": "Accepted.", + "headers": { + "Location": { + "description": "GET this URL to retrieve the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "type": "string" + } + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions": { "get": { "tags": [ @@ -1539,6 +1607,74 @@ } } }, + "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/downloadDocuments": { + "post": { + "tags": [ + "Invoices" + ], + "x-ms-examples": { + "BillingSubscriptionInvoiceDownload": { + "$ref": "./examples/MultipleBillingSubscriptionInvoiceDownload.json" + } + }, + "operationId": "Invoices_DownloadMultipleBillingSubscriptionInvoice", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "description": "Gets a URL to download multiple invoices documents (invoice pdf, tax receipts, credit notes) as a zip file.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "name": "downloadUrls", + "in": "body", + "required": true, + "description": "An array of download urls for individual documents", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "202": { + "description": "Accepted.", + "headers": { + "Location": { + "description": "GET this URL to retrieve the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "type": "string" + } + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingSubscriptions": { "get": { "tags": [ @@ -4615,6 +4751,11 @@ "description": "The target of the particular error.", "type": "string", "readOnly": true + }, + "details": { + "description": "The sub details of the error.", + "readOnly": true, + "$ref": "#/definitions/ErrorSubDetails" } } }, @@ -4628,6 +4769,29 @@ } } }, + "ErrorSubDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "The target of the particular error.", + "type": "string", + "readOnly": true + } + } + } + }, "Reseller": { "description": "Details of the reseller.", "properties": { diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoiceDownload.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoiceDownload.json index 226bfa9ef63e..1d2f434b068d 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoiceDownload.json +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoiceDownload.json @@ -8,7 +8,7 @@ "responses": { "202": { "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11000000-0000-0000-0000-000000000000/operationResults/invoiceDownload_11000000-0000-0000-0000-000000000000?api-version=2020-05-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/operationResults/invoiceDownload_{operationId}?api-version=2020-05-01", "Retry-After": "10" } }, diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceDownload.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ModernInvoiceDownload.json similarity index 83% rename from specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceDownload.json rename to specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ModernInvoiceDownload.json index 9bf994a947cb..38774eb60736 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceDownload.json +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ModernInvoiceDownload.json @@ -8,7 +8,7 @@ "responses": { "202": { "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/operationResults/invoiceDownload_11000000-0000-0000-0000-000000000000?api-version=2020-05-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/operationResults/invoiceDownload_{operationId}?api-version=2020-05-01", "Retry-After": "10" } }, diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MultipleBillingSubscriptionInvoiceDownload.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MultipleBillingSubscriptionInvoiceDownload.json new file mode 100644 index 000000000000..00c11b106f6a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MultipleBillingSubscriptionInvoiceDownload.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "{subscriptionId}", + "downloadUrls": [ + "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}/download?downloadToken={downloadToken}&useCache=True&api-version=2020-05-01", + "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}/download?downloadToken={downloadToken}&useCache=True&api-version=2020-05-01", + "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}/download?downloadToken={downloadToken}&useCache=True&api-version=2020-05-01" + ] + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/operationResults/invoiceDownload_{operationId}?api-version=2020-05-01", + "Retry-After": "10" + } + }, + "200": { + "body": { + "url": "https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sp=r" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MultipleModernInvoiceDownload.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MultipleModernInvoiceDownload.json new file mode 100644 index 000000000000..209820727664 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MultipleModernInvoiceDownload.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "downloadUrls": [ + "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/download?downloadToken={downloadToken}&useCache=True&api-version=2020-05-01", + "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/download?downloadToken={downloadToken}&useCache=True&api-version=2020-05-01", + "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/download?downloadToken={downloadToken}&useCache=True&api-version=2020-05-01" + ] + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/operationResults/invoiceDownload_{operationId}?api-version=2020-05-01", + "Retry-After": "10" + } + }, + "200": { + "body": { + "url": "https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sp=r" + } + } + } +} From cddb8f03f061c59fe383f21b0095d9f3e08900b8 Mon Sep 17 00:00:00 2001 From: zhaomuzhi Date: Tue, 22 Sep 2020 23:27:58 -0700 Subject: [PATCH 121/164] [Do Not Merge][Really To Review] add a new apis (#10756) * Add Identity to createWorkpace example * change for getTransitivePEUsages * update * prettier code * add another new endpoint * address comments --- custom-words.txt | 1 + .../examples/getTransitivePEUsages.json | 26 +++ .../examples/listWorkspaceNotebookKeys.json | 16 ++ .../machineLearningServices.json | 171 ++++++++++++++++++ 4 files changed, 214 insertions(+) create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/getTransitivePEUsages.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/listWorkspaceNotebookKeys.json diff --git a/custom-words.txt b/custom-words.txt index 6aa19385dc88..85475fa43129 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1684,6 +1684,7 @@ tráfico transcoding transcodes transcriptmoderationresult +transitivepeusages translatortext trendingtopics triggeredwebjobs diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/getTransitivePEUsages.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/getTransitivePEUsages.json new file mode 100644 index 000000000000..b37c57afc17c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/getTransitivePEUsages.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2020-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "transitivePrivateEndpointsUsage": { + "totalUsage": 0 + }, + "transitivePrivateEndpointsQuota": 0, + "privateDnsZonesUsage": { + "totalUsage": 0 + }, + "privateDnsZonesQuota": 0 + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/listWorkspaceNotebookKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/listWorkspaceNotebookKeys.json new file mode 100644 index 000000000000..4182751f0f91 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/listWorkspaceNotebookKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2020-09-01-preview" + }, + "responses": { + "200": { + "body": { + "primaryAccessKey": "vBvVhYgAGtUSewVCUv3w95p4/q5Yrsnw", + "secondaryAccessKey": "0KARRQoQHSUq1yViPWg7YFernOS" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json index 3c283424747c..7154aa1b18b3 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json @@ -349,6 +349,48 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookKeys": { + "post": { + "tags": [ + "Workspaces" + ], + "description": "Lists notebook keys associated with this workspace. The notebook keys are used for loading notebook components, which a reader should have access to. So make it a Get, not Post call", + "operationId": "Workspaces_ListNotebookKeys", + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/listWorkspaceNotebookKeys.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/NotebookListCredentialsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": { "post": { "tags": [ @@ -430,6 +472,53 @@ } } }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/transitivepeusages": { + "get": { + "tags": [ + "TransitivePEUsage" + ], + "operationId": "TransitivePEUsage_Get", + "description": "Gets the current transitive private endpoint usage information as well as limits for AML resources for given subscription and location.", + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListTransitivePEUsagesResult" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + }, + "x-ms-examples": { + "Get Transitive PE Usages": { + "$ref": "./examples/getTransitivePEUsages.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/usages": { "get": { "tags": [ @@ -2291,6 +2380,77 @@ }, "description": "Describes AML Resource Usage." }, + "TransitivePEUsage": { + "type": "object", + "properties": { + "totalUsage": { + "readOnly": true, + "format": "int32", + "type": "integer" + } + } + }, + "PrivateDNSZoneUsage": { + "type": "object", + "properties": { + "totalUsage": { + "readOnly": true, + "format": "int32", + "type": "integer" + } + } + }, + "TransitivePEUsagesResult": { + "type": "object", + "description": "The transitive private endpoint usage in this location", + "properties": { + "subscriptionId": { + "readOnly": true, + "type": "string", + "description": "Subscription id that the transitive private endpoint usage is measured." + }, + "transitivePrivateEndpointsUsage": { + "readOnly": true, + "description": "Transitive private endpoint usage", + "$ref": "#/definitions/TransitivePEUsage" + }, + "transitivePrivateEndpointsQuota": { + "readOnly": true, + "description": "Transitive private endpoint quota that currently set", + "format": "int32", + "type": "integer" + }, + "privateDnsZonesUsage": { + "readOnly": true, + "description": "Private DNS zone usage", + "$ref": "#/definitions/PrivateDNSZoneUsage" + }, + "privateDnsZonesQuota": { + "readOnly": true, + "description": "Private Dns Zones quota that currently set", + "format": "int32", + "type": "integer" + } + } + }, + "ListTransitivePEUsagesResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TransitivePEUsagesResult" + }, + "description": "The list of transitive private endpoint usages." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page of transitive private endpoint usages information. Call ListNext() with this to fetch the next page of AML resource usage information." + } + }, + "description": "The List transitive private endpoint usages operation response." + }, "ListUsagesResult": { "properties": { "value": { @@ -2798,6 +2958,17 @@ "description": "Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.", "x-ms-azure-resource": true }, + "NotebookListCredentialsResult": { + "type": "object", + "properties": { + "primaryAccessKey": { + "type": "string" + }, + "secondaryAccessKey": { + "type": "string" + } + } + }, "ListWorkspaceKeysResult": { "type": "object", "properties": { From 4e0c86991df0089597a58cf92823d57c2efa9d36 Mon Sep 17 00:00:00 2001 From: Arcturus Date: Wed, 23 Sep 2020 14:50:54 +0800 Subject: [PATCH 122/164] Revert "[Do Not Merge][Really To Review] add a new apis (#10756)" (#10908) This reverts commit cddb8f03f061c59fe383f21b0095d9f3e08900b8. --- custom-words.txt | 1 - .../examples/getTransitivePEUsages.json | 26 --- .../examples/listWorkspaceNotebookKeys.json | 16 -- .../machineLearningServices.json | 171 ------------------ 4 files changed, 214 deletions(-) delete mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/getTransitivePEUsages.json delete mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/listWorkspaceNotebookKeys.json diff --git a/custom-words.txt b/custom-words.txt index 85475fa43129..6aa19385dc88 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1684,7 +1684,6 @@ tráfico transcoding transcodes transcriptmoderationresult -transitivepeusages translatortext trendingtopics triggeredwebjobs diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/getTransitivePEUsages.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/getTransitivePEUsages.json deleted file mode 100644 index b37c57afc17c..000000000000 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/getTransitivePEUsages.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "location": "eastus", - "api-version": "2020-09-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "transitivePrivateEndpointsUsage": { - "totalUsage": 0 - }, - "transitivePrivateEndpointsQuota": 0, - "privateDnsZonesUsage": { - "totalUsage": 0 - }, - "privateDnsZonesQuota": 0 - } - ] - } - } - } -} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/listWorkspaceNotebookKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/listWorkspaceNotebookKeys.json deleted file mode 100644 index 4182751f0f91..000000000000 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/examples/listWorkspaceNotebookKeys.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", - "resourceGroupName": "testrg123", - "workspaceName": "workspaces123", - "api-version": "2020-09-01-preview" - }, - "responses": { - "200": { - "body": { - "primaryAccessKey": "vBvVhYgAGtUSewVCUv3w95p4/q5Yrsnw", - "secondaryAccessKey": "0KARRQoQHSUq1yViPWg7YFernOS" - } - } - } -} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json index 7154aa1b18b3..3c283424747c 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-09-01-preview/machineLearningServices.json @@ -349,48 +349,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listNotebookKeys": { - "post": { - "tags": [ - "Workspaces" - ], - "description": "Lists notebook keys associated with this workspace. The notebook keys are used for loading notebook components, which a reader should have access to. So make it a Get, not Post call", - "operationId": "Workspaces_ListNotebookKeys", - "x-ms-examples": { - "List Workspace Keys": { - "$ref": "./examples/listWorkspaceNotebookKeys.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/APIVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - } - ], - "responses": { - "200": { - "description": "The request was successful; the request was well-formed and received properly.", - "schema": { - "$ref": "#/definitions/NotebookListCredentialsResult" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/MachineLearningServiceError" - } - } - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": { "post": { "tags": [ @@ -472,53 +430,6 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/transitivepeusages": { - "get": { - "tags": [ - "TransitivePEUsage" - ], - "operationId": "TransitivePEUsage_Get", - "description": "Gets the current transitive private endpoint usage information as well as limits for AML resources for given subscription and location.", - "parameters": [ - { - "$ref": "#/parameters/APIVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The location for which resource usage is queried.", - "pattern": "^[-\\w\\._]+$" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ListTransitivePEUsagesResult" - } - }, - "default": { - "description": "Error response describing why the request failed.", - "schema": { - "$ref": "#/definitions/MachineLearningServiceError" - } - } - }, - "x-ms-examples": { - "Get Transitive PE Usages": { - "$ref": "./examples/getTransitivePEUsages.json" - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/usages": { "get": { "tags": [ @@ -2380,77 +2291,6 @@ }, "description": "Describes AML Resource Usage." }, - "TransitivePEUsage": { - "type": "object", - "properties": { - "totalUsage": { - "readOnly": true, - "format": "int32", - "type": "integer" - } - } - }, - "PrivateDNSZoneUsage": { - "type": "object", - "properties": { - "totalUsage": { - "readOnly": true, - "format": "int32", - "type": "integer" - } - } - }, - "TransitivePEUsagesResult": { - "type": "object", - "description": "The transitive private endpoint usage in this location", - "properties": { - "subscriptionId": { - "readOnly": true, - "type": "string", - "description": "Subscription id that the transitive private endpoint usage is measured." - }, - "transitivePrivateEndpointsUsage": { - "readOnly": true, - "description": "Transitive private endpoint usage", - "$ref": "#/definitions/TransitivePEUsage" - }, - "transitivePrivateEndpointsQuota": { - "readOnly": true, - "description": "Transitive private endpoint quota that currently set", - "format": "int32", - "type": "integer" - }, - "privateDnsZonesUsage": { - "readOnly": true, - "description": "Private DNS zone usage", - "$ref": "#/definitions/PrivateDNSZoneUsage" - }, - "privateDnsZonesQuota": { - "readOnly": true, - "description": "Private Dns Zones quota that currently set", - "format": "int32", - "type": "integer" - } - } - }, - "ListTransitivePEUsagesResult": { - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/TransitivePEUsagesResult" - }, - "description": "The list of transitive private endpoint usages." - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URI to fetch the next page of transitive private endpoint usages information. Call ListNext() with this to fetch the next page of AML resource usage information." - } - }, - "description": "The List transitive private endpoint usages operation response." - }, "ListUsagesResult": { "properties": { "value": { @@ -2958,17 +2798,6 @@ "description": "Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.", "x-ms-azure-resource": true }, - "NotebookListCredentialsResult": { - "type": "object", - "properties": { - "primaryAccessKey": { - "type": "string" - }, - "secondaryAccessKey": { - "type": "string" - } - } - }, "ListWorkspaceKeysResult": { "type": "object", "properties": { From 57735e7b7b372b62314cad80fa2e1d38d76b516a Mon Sep 17 00:00:00 2001 From: Zunli Hu Date: Wed, 23 Sep 2020 15:57:16 +0800 Subject: [PATCH 123/164] add fix (#10906) --- specification/storage/resource-manager/readme.python.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/specification/storage/resource-manager/readme.python.md b/specification/storage/resource-manager/readme.python.md index 9c4a6ba3d79f..655dfb68e8b2 100644 --- a/specification/storage/resource-manager/readme.python.md +++ b/specification/storage/resource-manager/readme.python.md @@ -17,6 +17,8 @@ azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-storage no-namespace-folders: true +modelerfour: + lenient-model-deduplication: true ``` ### Python multi-api From bfc3af3be11659794186df73982a11d3c84ec05a Mon Sep 17 00:00:00 2001 From: Priyaranjan Pandey Date: Wed, 23 Sep 2020 01:48:34 -0700 Subject: [PATCH 124/164] [Microsoft.Storage] Adding support for ResourceAccessRules (#10868) * [Microsoft.Storage] Adding support for ResourceAccessRules [Microsoft.Storage] Adding support for ResourceAccessRules * PrettierCheck failure --- .../examples/StorageAccountGetProperties.json | 8 +++++++- ...StorageAccountGetPropertiesCMKEnabled.json | 3 ++- .../examples/StorageAccountList.json | 6 ++++++ .../examples/StorageAccountUpdate.json | 12 +++++++++++ .../preview/2020-08-01-preview/storage.json | 20 +++++++++++++++++++ 5 files changed, 47 insertions(+), 2 deletions(-) diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetProperties.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetProperties.json index 5fe7647f8058..339fc0850970 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetProperties.json +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetProperties.json @@ -25,7 +25,13 @@ "bypass": "AzureServices", "defaultAction": "Allow", "ipRules": [], - "virtualNetworkRules": [] + "virtualNetworkRules": [], + "resourceAccessRules": [ + { + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "resourceId": "/subscriptions/a7e99807-abbf-4642-bdec-2c809a96a8bc/resourceGroups/res9407/providers/Microsoft.Synapse/workspaces/testworkspace" + } + ] }, "primaryEndpoints": { "web": "https://sto8596.web.core.windows.net/", diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetPropertiesCMKEnabled.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetPropertiesCMKEnabled.json index 5554a5a31755..8b8626bd2f10 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetPropertiesCMKEnabled.json +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountGetPropertiesCMKEnabled.json @@ -30,7 +30,8 @@ "bypass": "AzureServices", "defaultAction": "Allow", "ipRules": [], - "virtualNetworkRules": [] + "virtualNetworkRules": [], + "resourceAccessRules": [] }, "primaryEndpoints": { "web": "https://sto8596.web.core.windows.net/", diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountList.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountList.json index 4744fc9baf61..c0617cc2028f 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountList.json +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountList.json @@ -129,6 +129,12 @@ "isHnsEnabled": true, "creationTime": "2017-06-01T02:42:41.7633306Z", "networkAcls": { + "resourceAccessRules": [ + { + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "resourceId": "/subscriptions/a7e99807-abbf-4642-bdec-2c809a96a8bc/resourceGroups/res9407/providers/Microsoft.Synapse/workspaces/testworkspace" + } + ], "bypass": "AzureServices", "defaultAction": "Allow", "ipRules": [], diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountUpdate.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountUpdate.json index 52ad395f900c..1426ec2791e9 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountUpdate.json +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountUpdate.json @@ -10,6 +10,12 @@ "allowBlobPublicAccess": false, "minimumTlsVersion": "TLS1_2", "networkAcls": { + "resourceAccessRules": [ + { + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "resourceId": "/subscriptions/a7e99807-abbf-4642-bdec-2c809a96a8bc/resourceGroups/res9407/providers/Microsoft.Synapse/workspaces/testworkspace" + } + ], "defaultAction": "Allow" }, "routingPreference": { @@ -46,6 +52,12 @@ "minimumTlsVersion": "TLS1_2", "creationTime": "2017-06-01T02:42:41.7633306Z", "networkAcls": { + "resourceAccessRules": [ + { + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "resourceId": "/subscriptions/a7e99807-abbf-4642-bdec-2c809a96a8bc/resourceGroups/res9407/providers/Microsoft.Synapse/workspaces/testworkspace" + } + ], "bypass": "AzureServices", "defaultAction": "Allow", "ipRules": [], diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/storage.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/storage.json index 1bc46b6069ab..e91a7d63f20d 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/storage.json @@ -1979,6 +1979,19 @@ ], "description": "The encryption settings on the storage account." }, + "ResourceAccessRule": { + "properties": { + "tenantId": { + "type": "string", + "description": "Tenant Id" + }, + "resourceId": { + "type": "string", + "description": "Resource Id" + } + }, + "description": "Resource Access Rule." + }, "VirtualNetworkRule": { "properties": { "id": { @@ -2062,6 +2075,13 @@ "default": "AzureServices", "description": "Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, \"Logging, Metrics\"), or None to bypass none of those traffics." }, + "resourceAccessRules": { + "type": "array", + "items": { + "description": "Resource Access Rules.", + "$ref": "#/definitions/ResourceAccessRule" + } + }, "virtualNetworkRules": { "type": "array", "items": { From e15b2deae09ac147de16249013c83e7ed54a27e7 Mon Sep 17 00:00:00 2001 From: Tanyi Chen Date: Wed, 23 Sep 2020 20:24:19 +0800 Subject: [PATCH 125/164] rename synapse model in java (#10911) --- specification/synapse/resource-manager/readme.java.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/specification/synapse/resource-manager/readme.java.md b/specification/synapse/resource-manager/readme.java.md index 05c8d6afc164..ea2e19b7c9a9 100644 --- a/specification/synapse/resource-manager/readme.java.md +++ b/specification/synapse/resource-manager/readme.java.md @@ -23,6 +23,9 @@ directive: - rename-operation: from: IntegrationRuntimeStatus_Get to: IntegrationRuntimeStatusOperation_Get + - rename-model: + from: SubResource + to: EntityResource ``` ### Java multi-api From 0ae35fd0c27e0f06004d820e75a13c615b9c2e96 Mon Sep 17 00:00:00 2001 From: Srikanta <51379715+srnagar@users.noreply.github.com> Date: Wed, 23 Sep 2020 10:58:01 -0700 Subject: [PATCH 126/164] Initial preview version of swagger for Monitor Exporters (#10814) * Swagger for Monitor Exporters * Update Domain to include version * Add readme and format json * Update readme * Add examples * Format sample json * Add more samples * Fix formatting * Fix samples path * Fix json format * Update time format * Fix typo * Add error status --- .../2020-09-15_Preview/examples/track.json | 193 ++++ .../preview/2020-09-15_Preview/swagger.json | 1020 +++++++++++++++++ .../data-plane/Monitor.Exporters/readme.md | 44 + 3 files changed, 1257 insertions(+) create mode 100644 specification/applicationinsights/data-plane/Monitor.Exporters/preview/2020-09-15_Preview/examples/track.json create mode 100644 specification/applicationinsights/data-plane/Monitor.Exporters/preview/2020-09-15_Preview/swagger.json create mode 100644 specification/applicationinsights/data-plane/Monitor.Exporters/readme.md diff --git a/specification/applicationinsights/data-plane/Monitor.Exporters/preview/2020-09-15_Preview/examples/track.json b/specification/applicationinsights/data-plane/Monitor.Exporters/preview/2020-09-15_Preview/examples/track.json new file mode 100644 index 000000000000..dad4cd1bc839 --- /dev/null +++ b/specification/applicationinsights/data-plane/Monitor.Exporters/preview/2020-09-15_Preview/examples/track.json @@ -0,0 +1,193 @@ +{ + "parameters": { + "Host": "{Host}", + "body": [ + { + "ver": 1, + "name": "Microsoft.ApplicationInsights.b4f83947968d4e2f82ad804be07697ae.Event", + "time": "2020-09-22T10:12:53.208-0700", + "sampleRate": 100.0, + "iKey": "c1f83947-938c-5e2a-82ff-804be07647bc", + "tags": { + "ai.internal.sdkVersion": "java:3.0.0-PREVIEW.5", + "ai.internal.nodeName": "MININT-PLOJ2RD", + "ai.operation.id": "f364119ed1ff3bcda0d4ee0896cf785f", + "ai.cloud.roleInstance": "MININT-PLOJ2RD", + "ai.operation.childid": "75706a2ac9456288" + } + }, + { + "ver": 1, + "name": "Microsoft.ApplicationInsights.b4f83947968d4e2f82ad804be07697ae.Event", + "time": "2020-09-22T10:12:53.208-0700", + "sampleRate": 100.0, + "iKey": "c1f83947-938c-5e2a-82ff-804be07647bc", + "tags": { + "ai.internal.sdkVersion": "java:3.0.0-PREVIEW.5", + "ai.internal.nodeName": "MININT-PLOJ2RD", + "ai.operation.id": "f364119ed1ff3bcda0d4ee0896cf785f", + "ai.cloud.roleInstance": "MININT-PLOJ2RD", + "ai.operation.childid": "75706a2ac9456288" + } + }, + { + "ver": 1, + "name": "Microsoft.ApplicationInsights.b4f83947968d4e2f82ad804be07697ae.Event", + "time": "2020-09-22T10:12:53.208-0700", + "sampleRate": 100.0, + "iKey": "c1f83947-938c-5e2a-82ff-804be07647bc", + "tags": { + "ai.internal.sdkVersion": "java:3.0.0-PREVIEW.5", + "ai.internal.nodeName": "MININT-PLOJ2RD", + "ai.operation.id": "f364119ed1ff3bcda0d4ee0896cf785f", + "ai.cloud.roleInstance": "MININT-PLOJ2RD", + "ai.operation.childid": "75706a2ac9456288" + } + }, + { + "ver": 1, + "name": "Microsoft.ApplicationInsights.b4f83947968d4e2f82ad804be07697ae.Event", + "time": "2020-09-22T10:12:53.208-0700", + "sampleRate": 100.0, + "iKey": "c1f83947-938c-5e2a-82ff-804be07647bc", + "tags": { + "ai.internal.sdkVersion": "java:3.0.0-PREVIEW.5", + "ai.internal.nodeName": "MININT-PLOJ2RD", + "ai.operation.id": "f364119ed1ff3bcda0d4ee0896cf785f", + "ai.cloud.roleInstance": "MININT-PLOJ2RD", + "ai.operation.childid": "75706a2ac9456288" + } + }, + { + "ver": 1, + "name": "Microsoft.ApplicationInsights.b4f83947968d4e2f82ad804be07697ae.Event", + "time": "2020-09-22T10:12:53.208-0700", + "sampleRate": 100.0, + "iKey": "c1f83947-938c-5e2a-82ff-804be07647bc", + "tags": { + "ai.internal.sdkVersion": "java:3.0.0-PREVIEW.5", + "ai.internal.nodeName": "MININT-PLOJ2RD", + "ai.operation.id": "f364119ed1ff3bcda0d4ee0896cf785f", + "ai.cloud.roleInstance": "MININT-PLOJ2RD", + "ai.operation.childid": "75706a2ac9456288" + } + }, + { + "ver": 1, + "name": "Microsoft.ApplicationInsights.b4f83947968d4e2f82ad804be07697ae.Event", + "time": "2020-09-22T10:12:53.208-0700", + "sampleRate": 100.0, + "iKey": "c1f83947-938c-5e2a-82ff-804be07647bc", + "tags": { + "ai.internal.sdkVersion": "java:3.0.0-PREVIEW.5", + "ai.internal.nodeName": "MININT-PLOJ2RD", + "ai.operation.id": "f364119ed1ff3bcda0d4ee0896cf785f", + "ai.cloud.roleInstance": "MININT-PLOJ2RD", + "ai.operation.childid": "75706a2ac9456288" + } + }, + { + "ver": 1, + "name": "Microsoft.ApplicationInsights.b4f83947968d4e2f82ad804be07697ae.Event", + "time": "2020-09-22T10:12:53.208-0700", + "sampleRate": 100.0, + "iKey": "c1f83947-938c-5e2a-82ff-804be07647bc", + "tags": { + "ai.internal.sdkVersion": "java:3.0.0-PREVIEW.5", + "ai.internal.nodeName": "MININT-PLOJ2RD", + "ai.operation.id": "f364119ed1ff3bcda0d4ee0896cf785f", + "ai.cloud.roleInstance": "MININT-PLOJ2RD", + "ai.operation.childid": "75706a2ac9456288" + } + } + ] + }, + "responses": { + "200": { + "headers": {}, + "body": { + "itemsReceived": 1, + "itemsAccepted": 1, + "errors": [] + } + }, + "206": { + "headers": {}, + "body": { + "itemsReceived": 1, + "itemsAccepted": 1, + "errors": [] + } + }, + "400": { + "headers": {}, + "body": { + "itemsReceived": 1, + "itemsAccepted": 0, + "errors": [ + { + "index": 1, + "statusCode": 400, + "message": "103: Field 'time' on type 'Envelope' is older than the allowed min date. Expected: now - 172800000ms, Actual: now - 2694990759ms" + } + ] + } + }, + "402": { + "headers": {}, + "body": { + "itemsReceived": 1, + "itemsAccepted": 0, + "errors": [ + { + "index": 1, + "statusCode": 402, + "message": "" + } + ] + } + }, + "429": { + "headers": {}, + "body": { + "itemsReceived": 1, + "itemsAccepted": 0, + "errors": [ + { + "index": 1, + "statusCode": 429, + "message": "" + } + ] + } + }, + "500": { + "headers": {}, + "body": { + "itemsReceived": 1, + "itemsAccepted": 0, + "errors": [ + { + "index": 1, + "statusCode": 500, + "message": "" + } + ] + } + }, + "503": { + "headers": {}, + "body": { + "itemsReceived": 1, + "itemsAccepted": 0, + "errors": [ + { + "index": 1, + "statusCode": 503, + "message": "" + } + ] + } + } + } +} diff --git a/specification/applicationinsights/data-plane/Monitor.Exporters/preview/2020-09-15_Preview/swagger.json b/specification/applicationinsights/data-plane/Monitor.Exporters/preview/2020-09-15_Preview/swagger.json new file mode 100644 index 000000000000..90a37e91a9ee --- /dev/null +++ b/specification/applicationinsights/data-plane/Monitor.Exporters/preview/2020-09-15_Preview/swagger.json @@ -0,0 +1,1020 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-09-15_Preview", + "title": "ApplicationInsightsClient", + "description": "This document describes the protocol for client requests and responses to the data collection endpoint." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{Host}/v2/", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Host" + } + ] + }, + "paths": { + "/track": { + "post": { + "summary": "Track telemetry events", + "description": "This operation sends a sequence of telemetry events that will be monitored by Azure Monitor.", + "operationId": "track", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "The list of telemetry events to track.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/TelemetryEnvelope" + } + } + } + ], + "consumes": [ + "application/json", + "x-json-stream" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "All of the telemetry items were accepted and processed.", + "schema": { + "$ref": "#/definitions/TrackResponse" + } + }, + "206": { + "description": "Partial success. Some of the telemetry items were accepted and processed.", + "schema": { + "$ref": "#/definitions/TrackResponse" + } + }, + "400": { + "description": "Bad Request", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/TrackResponse" + } + }, + "402": { + "description": "Payment Required", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/TrackResponse" + } + }, + "429": { + "description": "Too Many Requests", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/TrackResponse" + } + }, + "500": { + "description": "Internal Server Error", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/TrackResponse" + } + }, + "503": { + "description": "Service Unavailable", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/TrackResponse" + } + } + }, + "x-ms-examples": { + "Track examples": { + "$ref": "examples/track.json" + } + } + } + } + }, + "definitions": { + "AvailabilityData": { + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "Instances of AvailabilityData represent the result of executing an availability test.", + "required": [ + "id", + "name", + "duration", + "success" + ], + "properties": { + "id": { + "type": "string", + "description": "Identifier of a test run. Use it to correlate steps of test run and telemetry generated by the service.", + "maxLength": 512 + }, + "name": { + "type": "string", + "description": "Name of the test that these availability results represent.", + "maxLength": 1024 + }, + "duration": { + "type": "string", + "description": "Duration in format: DD.HH:MM:SS.MMMMMM. Must be less than 1000 days." + }, + "success": { + "type": "boolean", + "x-nullable": false, + "description": "Success flag." + }, + "runLocation": { + "type": "string", + "description": "Name of the location where the test was run from.", + "maxLength": 1024 + }, + "message": { + "type": "string", + "description": "Diagnostic message for the result.", + "maxLength": 8192 + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "Base": { + "x-ms-client-name": "MonitorBase", + "type": "object", + "description": "Data struct to contain only C section with custom fields.", + "properties": { + "baseType": { + "type": "string", + "description": "Name of item (B section) if any. If telemetry data is derived straight from this, this should be null." + }, + "baseData": { + "$ref": "#/definitions/Domain", + "description": "The data payload for the telemetry request" + } + } + }, + "DataPoint": { + "x-ms-client-name": "MetricDataPoint", + "type": "object", + "description": "Metric data single measurement.", + "required": [ + "name", + "value" + ], + "properties": { + "ns": { + "x-ms-client-name": "namespace", + "type": "string", + "description": "Namespace of the metric.", + "maxLength": 256 + }, + "name": { + "type": "string", + "description": "Name of the metric.", + "maxLength": 1024 + }, + "kind": { + "x-ms-client-name": "dataPointType", + "$ref": "#/definitions/DataPointType", + "description": "Metric type. Single measurement or the aggregated value." + }, + "value": { + "type": "number", + "description": "Single value for measurement. Sum of individual measurements for the aggregation.", + "format": "double" + }, + "count": { + "type": "number", + "format": "int32", + "description": "Metric weight of the aggregated metric. Should not be set for a measurement.", + "x-nullable": true + }, + "min": { + "type": "number", + "format": "double", + "description": "Minimum value of the aggregated metric. Should not be set for a measurement.", + "x-nullable": true + }, + "max": { + "type": "number", + "format": "double", + "description": "Maximum value of the aggregated metric. Should not be set for a measurement.", + "x-nullable": true + }, + "stdDev": { + "type": "number", + "format": "double", + "description": "Standard deviation of the aggregated metric. Should not be set for a measurement.", + "x-nullable": true + } + } + }, + "DataPointType": { + "type": "string", + "description": "Type of the metric data measurement.", + "enum": [ + "Measurement", + "Aggregation" + ] + }, + "Domain": { + "x-ms-client-name": "MonitorDomain", + "type": "object", + "description": "The abstract common base of all domains.", + "required": [ + "ver" + ], + "properties": { + "ver": { + "x-ms-client-name": "version", + "type": "integer", + "format": "int32", + "description": "Schema version", + "default": 2 + } + } + }, + "EventData": { + "x-ms-client-name": "TelemetryEventData", + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "Instances of Event represent structured event records that can be grouped and searched by their properties. Event data item also creates a metric of event count by name.", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Event name. Keep it low cardinality to allow proper grouping and useful metrics.", + "maxLength": 512 + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "ExceptionData": { + "x-ms-client-name": "TelemetryExceptionData", + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "An instance of Exception represents a handled or unhandled exception that occurred during execution of the monitored application.", + "required": [ + "exceptions" + ], + "properties": { + "exceptions": { + "type": "array", + "description": "Exception chain - list of inner exceptions.", + "items": { + "$ref": "#/definitions/ExceptionDetails" + } + }, + "severityLevel": { + "x-nullable": true, + "description": "Severity level. Mostly used to indicate exception severity level when it is reported by logging library.", + "$ref": "#/definitions/SeverityLevel" + }, + "problemId": { + "type": "string", + "description": "Identifier of where the exception was thrown in code. Used for exceptions grouping. Typically a combination of exception type and a function from the call stack.", + "maxLength": 1024 + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "ExceptionDetails": { + "x-ms-client-name": "TelemetryExceptionDetails", + "type": "object", + "description": "Exception details of the exception in a chain.", + "required": [ + "message" + ], + "properties": { + "id": { + "type": "number", + "format": "int32", + "description": "In case exception is nested (outer exception contains inner one), the id and outerId properties are used to represent the nesting." + }, + "outerId": { + "type": "number", + "format": "int32", + "description": "The value of outerId is a reference to an element in ExceptionDetails that represents the outer exception" + }, + "typeName": { + "type": "string", + "description": "Exception type name.", + "maxLength": 1024 + }, + "message": { + "type": "string", + "description": "Exception message.", + "maxLength": 32768 + }, + "hasFullStack": { + "type": "boolean", + "default": true, + "description": "Indicates if full exception stack is provided in the exception. The stack may be trimmed, such as in the case of a StackOverflow exception." + }, + "stack": { + "type": "string", + "description": "Text describing the stack. Either stack or parsedStack should have a value.", + "maxLength": 32768 + }, + "parsedStack": { + "type": "array", + "description": "List of stack frames. Either stack or parsedStack should have a value.", + "items": { + "$ref": "#/definitions/StackFrame" + } + } + } + }, + "MessageData": { + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "Instances of Message represent printf-like trace statements that are text-searched. Log4Net, NLog and other text-based log file entries are translated into instances of this type. The message does not have measurements.", + "required": [ + "message" + ], + "properties": { + "message": { + "type": "string", + "description": "Trace message", + "maxLength": 32768 + }, + "severityLevel": { + "$ref": "#/definitions/SeverityLevel", + "description": "Trace severity level." + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "MetricsData": { + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "An instance of the Metric item is a list of measurements (single data points) and/or aggregations.", + "required": [ + "metrics" + ], + "properties": { + "metrics": { + "type": "array", + "description": "List of metrics. Only one metric in the list is currently supported by Application Insights storage. If multiple data points were sent only the first one will be used.", + "items": { + "$ref": "#/definitions/DataPoint" + } + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + } + } + } + ] + }, + "PageViewData": { + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "An instance of PageView represents a generic action on a page like a button click. It is also the base type for PageView.", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "Identifier of a page view instance. Used for correlation between page view and other telemetry items.", + "maxLength": 512 + }, + "name": { + "type": "string", + "description": "Event name. Keep it low cardinality to allow proper grouping and useful metrics.", + "maxLength": 1024 + }, + "url": { + "type": "string", + "description": "Request URL with all query string parameters", + "maxLength": 2048 + }, + "duration": { + "type": "string", + "description": "Request duration in format: DD.HH:MM:SS.MMMMMM. For a page view (PageViewData), this is the duration. For a page view with performance information (PageViewPerfData), this is the page load time. Must be less than 1000 days." + }, + "referredUri": { + "type": "string", + "description": "Fully qualified page URI or URL of the referring page; if unknown, leave blank", + "maxLength": 2048 + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "PageViewPerfData": { + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "An instance of PageViewPerf represents: a page view with no performance data, a page view with performance data, or just the performance data of an earlier page request.", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "description": "Identifier of a page view instance. Used for correlation between page view and other telemetry items.", + "maxLength": 512 + }, + "name": { + "type": "string", + "description": "Event name. Keep it low cardinality to allow proper grouping and useful metrics.", + "maxLength": 1024 + }, + "url": { + "type": "string", + "description": "Request URL with all query string parameters", + "maxLength": 2048 + }, + "duration": { + "type": "string", + "description": "Request duration in format: DD.HH:MM:SS.MMMMMM. For a page view (PageViewData), this is the duration. For a page view with performance information (PageViewPerfData), this is the page load time. Must be less than 1000 days." + }, + "perfTotal": { + "type": "string", + "description": "Performance total in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff" + }, + "networkConnect": { + "type": "string", + "description": "Network connection time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff" + }, + "sentRequest": { + "type": "string", + "description": "Sent request time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff" + }, + "receivedResponse": { + "type": "string", + "description": "Received response time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff" + }, + "domProcessing": { + "type": "string", + "description": "DOM processing time in TimeSpan 'G' (general long) format: d:hh:mm:ss.fffffff" + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "RemoteDependencyData": { + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "An instance of Remote Dependency represents an interaction of the monitored component with a remote component/service like SQL or an HTTP endpoint.", + "required": [ + "name", + "duration" + ], + "properties": { + "id": { + "type": "string", + "description": "Identifier of a dependency call instance. Used for correlation with the request telemetry item corresponding to this dependency call.", + "maxLength": 512 + }, + "name": { + "type": "string", + "description": "Name of the command initiated with this dependency call. Low cardinality value. Examples are stored procedure name and URL path template.", + "maxLength": 1024 + }, + "resultCode": { + "type": "string", + "description": "Result code of a dependency call. Examples are SQL error code and HTTP status code.", + "maxLength": 1024 + }, + "data": { + "type": "string", + "description": "Command initiated by this dependency call. Examples are SQL statement and HTTP URL with all query parameters.", + "maxLength": 8192 + }, + "type": { + "type": "string", + "description": "Dependency type name. Very low cardinality value for logical grouping of dependencies and interpretation of other fields like commandName and resultCode. Examples are SQL, Azure table, and HTTP.", + "maxLength": 1024 + }, + "target": { + "type": "string", + "description": "Target site of a dependency call. Examples are server name, host address.", + "maxLength": 1024 + }, + "duration": { + "type": "string", + "description": "Request duration in format: DD.HH:MM:SS.MMMMMM. Must be less than 1000 days." + }, + "success": { + "type": "boolean", + "description": "Indication of successful or unsuccessful call.", + "default": true + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "RequestData": { + "allOf": [ + { + "$ref": "#/definitions/Domain" + }, + { + "type": "object", + "description": "An instance of Request represents completion of an external request to the application to do work and contains a summary of that request execution and the results.", + "required": [ + "id", + "duration", + "responseCode", + "success" + ], + "properties": { + "id": { + "type": "string", + "description": "Identifier of a request call instance. Used for correlation between request and other telemetry items.", + "maxLength": 512 + }, + "name": { + "type": "string", + "description": "Name of the request. Represents code path taken to process request. Low cardinality value to allow better grouping of requests. For HTTP requests it represents the HTTP method and URL path template like 'GET /values/{id}'.", + "maxLength": 1024 + }, + "duration": { + "type": "string", + "description": "Request duration in format: DD.HH:MM:SS.MMMMMM. Must be less than 1000 days." + }, + "success": { + "type": "boolean", + "description": "Indication of successful or unsuccessful call.", + "default": true + }, + "responseCode": { + "type": "string", + "description": "Result of a request execution. HTTP status code for HTTP requests.", + "maxLength": 1024 + }, + "source": { + "type": "string", + "description": "Source of the request. Examples are the instrumentation key of the caller or the ip address of the caller.", + "maxLength": 1024 + }, + "url": { + "type": "string", + "description": "Request URL with all query string parameters.", + "maxLength": 2048 + }, + "properties": { + "type": "object", + "description": "Collection of custom properties.", + "additionalProperties": { + "type": "string", + "maxLength": 8192 + } + }, + "measurements": { + "type": "object", + "description": "Collection of custom measurements.", + "additionalProperties": { + "type": "number", + "format": "double" + } + } + } + } + ] + }, + "SeverityLevel": { + "type": "string", + "description": "Defines the level of severity for the event.", + "enum": [ + "Verbose", + "Information", + "Warning", + "Error", + "Critical" + ] + }, + "StackFrame": { + "type": "object", + "description": "Stack frame information.", + "required": [ + "level", + "method" + ], + "properties": { + "level": { + "type": "number", + "format": "int32", + "description": "" + }, + "method": { + "type": "string", + "description": "Method name.", + "maxLength": 1024 + }, + "assembly": { + "type": "string", + "description": "Name of the assembly (dll, jar, etc.) containing this function.", + "maxLength": 1024 + }, + "fileName": { + "type": "string", + "description": "File name or URL of the method implementation.", + "maxLength": 1024 + }, + "line": { + "type": "number", + "format": "int32", + "description": "Line number of the code implementation." + } + } + }, + "TrackResponse": { + "description": "Response containing the status of each telemetry item.", + "type": "object", + "properties": { + "itemsReceived": { + "type": "number", + "format": "int32", + "description": "The number of items received." + }, + "itemsAccepted": { + "type": "number", + "format": "int32", + "description": "The number of items accepted." + }, + "errors": { + "type": "array", + "description": "An array of error detail objects.", + "items": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "ErrorDetails": { + "x-ms-client-name": "TelemetryErrorDetails", + "description": "The error details", + "type": "object", + "properties": { + "index": { + "type": "number", + "format": "int32", + "description": "The index in the original payload of the item." + }, + "statusCode": { + "type": "number", + "format": "int32", + "description": "The item specific [HTTP Response status code](#Response Status Codes)." + }, + "message": { + "type": "string", + "description": "The error message." + } + } + }, + "TelemetryEnvelope": { + "x-ms-client-name": "TelemetryItem", + "description": "System variables for a telemetry item.", + "type": "object", + "required": [ + "name", + "time" + ], + "properties": { + "ver": { + "type": "number", + "x-ms-client-name": "version", + "format": "int32", + "default": 1, + "description": "Envelope version. For internal use only. By assigning this the default, it will not be serialized within the payload unless changed to a value other than #1." + }, + "name": { + "type": "string", + "description": "Type name of telemetry data item." + }, + "time": { + "type": "string", + "description": "Event date time when telemetry item was created. This is the wall clock time on the client when the event was generated. There is no guarantee that the client's time is accurate. This field must be formatted in UTC ISO 8601 format, with a trailing 'Z' character, as described publicly on https://en.wikipedia.org/wiki/ISO_8601#UTC. Note: the number of decimal seconds digits provided are variable (and unspecified). Consumers should handle this, i.e. managed code consumers should not use format 'O' for parsing as it specifies a fixed length. Example: 2009-06-15T13:45:30.0000000Z." + }, + "sampleRate": { + "type": "number", + "format": "float", + "default": 100.0, + "description": "Sampling rate used in application. This telemetry item represents 1 / sampleRate actual telemetry items." + }, + "seq": { + "type": "string", + "x-ms-client-name": "sequence", + "maxLength": 64, + "description": "Sequence field used to track absolute order of uploaded events." + }, + "iKey": { + "type": "string", + "x-ms-client-name": "instrumentationKey", + "description": "The instrumentation key of the Application Insights resource." + }, + "tags": { + "type": "object", + "description": "Key/value collection of context properties. See ContextTagKeys for information on available properties.", + "additionalProperties": { + "type": "string" + } + }, + "data": { + "$ref": "#/definitions/Base", + "description": "Telemetry data item." + } + } + }, + "ContextTagKeys": { + "type": "string", + "description": "The context tag keys.", + "enum": [ + "ApplicationVersion", + "DeviceId", + "DeviceLocale", + "DeviceModel", + "DeviceOEMName", + "DeviceOSVersion", + "DeviceType", + "LocationIp", + "LocationCountry", + "LocationProvince", + "LocationCity", + "OperationId", + "OperationName", + "OperationParentId", + "OperationSyntheticSource", + "OperationCorrelationVector", + "SessionId", + "SessionIsFirst", + "UserAccountId", + "UserId", + "UserAuthUserId", + "CloudRole", + "CloudRoleVer", + "CloudRoleInstance", + "CloudLocation", + "InternalSdkVersion", + "InternalAgentVersion", + "InternalNodeName " + ], + "x-ms-enum": { + "name": "ContextTagKeys", + "modelAsString": true, + "values": [ + { + "value": "ai.application.ver" + }, + { + "value": "ai.device.id" + }, + { + "value": "ai.device.locale" + }, + { + "value": "ai.device.model" + }, + { + "value": "ai.device.oemName" + }, + { + "value": "ai.device.osVersion" + }, + { + "value": "ai.device.type" + }, + { + "value": "ai.location.ip" + }, + { + "value": "ai.location.country" + }, + { + "value": "ai.location.province" + }, + { + "value": "ai.location.city" + }, + { + "value": "ai.operation.id" + }, + { + "value": "ai.operation.name" + }, + { + "value": "ai.operation.parentId" + }, + { + "value": "ai.operation.syntheticSource" + }, + { + "value": "ai.operation.correlationVector" + }, + { + "value": "ai.session.id" + }, + { + "value": "ai.session.isFirst" + }, + { + "value": "ai.user.accountId" + }, + { + "value": "ai.user.id" + }, + { + "value": "ai.user.authUserId" + }, + { + "value": "ai.cloud.role" + }, + { + "value": "ai.cloud.roleVer" + }, + { + "value": "ai.cloud.roleInstance" + }, + { + "value": "ai.cloud.location" + }, + { + "value": "ai.internal.sdkVersion" + }, + { + "value": "ai.internal.agentVersion" + }, + { + "value": "ai.internal.nodeName" + } + ] + } + } + }, + "parameters": { + "Host": { + "name": "Host", + "description": "Breeze endpoint: https://dc.services.visualstudio.com", + "x-ms-parameter-location": "client", + "default": "https://dc.services.visualstudio.com", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/applicationinsights/data-plane/Monitor.Exporters/readme.md b/specification/applicationinsights/data-plane/Monitor.Exporters/readme.md new file mode 100644 index 000000000000..b1ae6ed86f47 --- /dev/null +++ b/specification/applicationinsights/data-plane/Monitor.Exporters/readme.md @@ -0,0 +1,44 @@ +# Exporter for Azure Monitor +> see https://aka.ms/autorest + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +## Configuration + +The following are the settings for this using this API with AutoRest. + +``` yaml +# specify the version of Autorest to use +version: 1.0.1-20170402 + +# (more settings here...) +``` + +### Basic Information + +These are the global settings for the schemaregistry. + +```yaml +openapi-type: data-plane +tag: 2020-09-15-preview +``` + +### Tag: 2020-09-15-preview + +These settings apply only when `--tag=2020-09-15-preview` is specified on the command line. + +```yaml $(tag) == '2020-09-15-preview' +input-file: + - preview/2020-09-15_Preview/swagger.json +``` + From 5c462e945e5fa6aa7361e437b6e12c8d979c9287 Mon Sep 17 00:00:00 2001 From: Arcturus Date: Thu, 24 Sep 2020 02:17:12 +0800 Subject: [PATCH 127/164] Add data plane configuration for go SDK (#10907) --- .../attestation/data-plane/readme.go.md | 26 +++++++++++++++++++ .../attestation/data-plane/readme.md | 3 +++ 2 files changed, 29 insertions(+) create mode 100644 specification/attestation/data-plane/readme.go.md diff --git a/specification/attestation/data-plane/readme.go.md b/specification/attestation/data-plane/readme.go.md new file mode 100644 index 000000000000..a99623b96edf --- /dev/null +++ b/specification/attestation/data-plane/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: attestation + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2018-09-preview +``` + +### Tag: package-2018-09-preview and go + +These settings apply only when `--tag=package-2018-09-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-09-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/2018-09-01-preview/$(namespace) +``` diff --git a/specification/attestation/data-plane/readme.md b/specification/attestation/data-plane/readme.md index f382f8bb7b01..c0dfa3499891 100644 --- a/specification/attestation/data-plane/readme.md +++ b/specification/attestation/data-plane/readme.md @@ -51,6 +51,7 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-net - repo: azure-sdk-for-python + - repo: azure-sdk-for-go ``` ## Python @@ -72,7 +73,9 @@ csharp: clear-output-folder: true ``` +## Go +See configuration in [readme.go.md](./readme.go.md) ## Multi-API/Profile support for AutoRest v3 generators From 6e2e92303f07ab35ac61b27e1e3ea480d7520c2f Mon Sep 17 00:00:00 2001 From: Tyler James Leonhardt Date: Wed, 23 Sep 2020 12:20:07 -0700 Subject: [PATCH 128/164] Additional changes for az CLI (#10795) * changes for CLI * add aliases * maybe it's machineextensions * Update readme.az.md * Update readme.cli.md * Update readme.az.md * maybe the param is different * add name * GET -> Get --- .../stable/2020-08-02/HybridCompute.json | 10 +++++----- .../hybridcompute/resource-manager/readme.cli.md | 7 +++++++ 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/stable/2020-08-02/HybridCompute.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/stable/2020-08-02/HybridCompute.json index f316157c55eb..3b8a59c50a8a 100644 --- a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/stable/2020-08-02/HybridCompute.json +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/stable/2020-08-02/HybridCompute.json @@ -266,7 +266,7 @@ "machines" ], "operationId": "Machines_ListByResourceGroup", - "description": "Lists all the hybrid machines in the specified resource group. Use the nextLink property in the response to get the next page of hybrid machines.", + "description": "Lists all the hybrid machines in the specified resource group.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -312,7 +312,7 @@ "machines" ], "operationId": "Machines_ListBySubscription", - "description": "Lists all the hybrid machines in the specified subscription. Use the nextLink property in the response to get the next page of hybrid machines.", + "description": "Lists all the hybrid machines in the specified subscription.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -413,7 +413,7 @@ "MachineExtensions" ], "operationId": "MachineExtensions_Update", - "description": "The operation to create or update the extension.", + "description": "The operation to update the extension.", "parameters": [ { "name": "resourceGroupName", @@ -567,7 +567,7 @@ } }, "x-ms-examples": { - "GET Machine Extension": { + "Get Machine Extension": { "$ref": "./examples/GETExtension.json" } } @@ -621,7 +621,7 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "GET all Machine Extensions": { + "Get all Machine Extensions": { "$ref": "./examples/LISTExtension.json" } } diff --git a/specification/hybridcompute/resource-manager/readme.cli.md b/specification/hybridcompute/resource-manager/readme.cli.md index 061e2aadbb38..5a59b0080270 100644 --- a/specification/hybridcompute/resource-manager/readme.cli.md +++ b/specification/hybridcompute/resource-manager/readme.cli.md @@ -21,4 +21,11 @@ cli: param: 'autoUpgradeMinorVersion' alias: - auto_upgrade_minor + - where: + operationGroup: 'machineExtensions' + param: 'extensionName' + alias: + - n + - extension_name + - name ``` From d08bc2753b8de8d08ad1c44ff96aea3d2cd74236 Mon Sep 17 00:00:00 2001 From: Arcturus Date: Thu, 24 Sep 2020 03:22:08 +0800 Subject: [PATCH 129/164] Add new api-version in go SDK for mariadb (#10702) --- specification/mariadb/resource-manager/readme.go.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/specification/mariadb/resource-manager/readme.go.md b/specification/mariadb/resource-manager/readme.go.md index 5655a69784ad..787e63c11c97 100644 --- a/specification/mariadb/resource-manager/readme.go.md +++ b/specification/mariadb/resource-manager/readme.go.md @@ -13,9 +13,19 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2020-01-01 - tag: package-2018-06-01 ``` +### Tag: package-2020-01-01 and go + +These settings apply only when `--tag=package-2020-01-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-01-01' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-01-01/$(namespace) +``` + ### Tag: package-2018-06-01 and go These settings apply only when `--tag=package-2018-06-01 --go` is specified on the command line. From d587005c88aaa684cd744fe32019ad5f8f51dd98 Mon Sep 17 00:00:00 2001 From: changlong-liu <59815250+changlong-liu@users.noreply.github.com> Date: Thu, 24 Sep 2020 03:25:35 +0800 Subject: [PATCH 130/164] correct example responses (#10360) --- .../examples/ApplicationGroup_Create.json | 14 +++++++------- .../examples/ApplicationGroup_Delete.json | 6 +++--- .../examples/ApplicationGroup_Get.json | 6 +++--- .../ApplicationGroup_ListByResourceGroup.json | 12 ++++++------ .../ApplicationGroup_ListBySubscription.json | 12 ++++++------ .../examples/ApplicationGroup_Update.json | 6 +++--- .../examples/Application_Create.json | 4 ++-- .../examples/Application_Delete.json | 2 +- .../examples/Application_Get.json | 2 +- .../examples/Application_List.json | 4 ++-- .../examples/Application_Update.json | 2 +- .../2019-12-10-preview/examples/Desktop_Get.json | 2 +- .../examples/Desktop_List.json | 2 +- .../examples/Desktop_Update.json | 2 +- .../examples/HostPool_Create.json | 16 ++++++++-------- .../examples/HostPool_Delete.json | 8 ++++---- .../examples/HostPool_Get.json | 8 ++++---- .../examples/HostPool_List.json | 16 ++++++++-------- .../examples/HostPool_ListByResourceGroup.json | 16 ++++++++-------- .../examples/HostPool_Update.json | 8 ++++---- .../examples/SessionHost_Delete.json | 4 ++-- .../examples/SessionHost_Get.json | 4 ++-- .../examples/SessionHost_List.json | 8 ++++---- .../examples/SessionHost_Update.json | 4 ++-- .../examples/StartMenuItem_List.json | 4 ++-- .../examples/UserSession_Delete.json | 2 +- .../examples/UserSession_Get.json | 2 +- .../examples/UserSession_List.json | 4 ++-- .../examples/UserSession_ListByHostPool.json | 4 ++-- .../examples/Workspace_Create.json | 4 ++-- .../examples/Workspace_Delete.json | 2 +- .../examples/Workspace_Get.json | 2 +- .../examples/Workspace_ListByResourceGroup.json | 4 ++-- .../examples/Workspace_ListBySubscription.json | 4 ++-- .../examples/Workspace_Update.json | 2 +- 35 files changed, 101 insertions(+), 101 deletions(-) diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Create.json index 8d6b4bb1382b..1323b6f7b04c 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Create.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Create.json @@ -13,7 +13,7 @@ "properties": { "description": "des1", "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", "applicationGroupType": "RemoteApp" } } @@ -22,7 +22,7 @@ "200": { "body": { "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", "type": "Microsoft.DesktopVirtualization/applicationGroups", "location": "centralus", "tags": { @@ -32,8 +32,8 @@ "properties": { "description": "des1", "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", "applicationGroupType": "RemoteApp" } } @@ -41,7 +41,7 @@ "201": { "body": { "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", "type": "Microsoft.DesktopVirtualization/applicationGroups", "location": "centralus", "tags": { @@ -51,8 +51,8 @@ "properties": { "description": "des1", "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", "applicationGroupType": "RemoteApp" } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Delete.json index 79cf00e37e7c..fe87af2b8ad1 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Delete.json @@ -8,7 +8,7 @@ "responses": { "200": { "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", "type": "Microsoft.DesktopVirtualization/applicationGroups", "location": "centralus", "tags": { @@ -18,8 +18,8 @@ "properties": { "description": "des1", "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", "applicationGroupType": "RemoteApp" } }, diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Get.json index b7bb05752a8a..823c1bb55ec6 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Get.json @@ -9,7 +9,7 @@ "200": { "body": { "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", "type": "Microsoft.DesktopVirtualization/applicationGroups", "location": "centralus", "tags": { @@ -19,8 +19,8 @@ "properties": { "description": "des1", "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", "applicationGroupType": "RemoteApp" } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_ListByResourceGroup.json index afcec930670e..18136fe1eae9 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_ListByResourceGroup.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_ListByResourceGroup.json @@ -11,7 +11,7 @@ "value": [ { "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", "type": "Microsoft.DesktopVirtualization/applicationGroups", "location": "centralus", "tags": { @@ -21,14 +21,14 @@ "properties": { "description": "des1", "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", "applicationGroupType": "RemoteApp" } }, { "name": "applicationGroup2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", "type": "Microsoft.DesktopVirtualization/applicationGroups", "location": "centralus", "tags": { @@ -38,8 +38,8 @@ "properties": { "description": "des1", "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", "applicationGroupType": "RemoteApp" } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_ListBySubscription.json index 6a7fe723d2ed..985bc6a50874 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_ListBySubscription.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_ListBySubscription.json @@ -10,7 +10,7 @@ "value": [ { "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", "type": "Microsoft.DesktopVirtualization/applicationGroups", "location": "centralus", "tags": { @@ -20,14 +20,14 @@ "properties": { "description": "des1", "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", "applicationGroupType": "RemoteApp" } }, { "name": "applicationGroup2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", "type": "Microsoft.DesktopVirtualization/applicationGroups", "location": "centralus", "tags": { @@ -37,8 +37,8 @@ "properties": { "description": "des1", "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", "applicationGroupType": "RemoteApp" } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Update.json index 0d6da727b913..cb865a4a4e97 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroup_Update.json @@ -19,7 +19,7 @@ "200": { "body": { "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", "type": "Microsoft.DesktopVirtualization/applicationGroups", "location": "centralus", "tags": { @@ -29,8 +29,8 @@ "properties": { "description": "des1", "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", "applicationGroupType": "RemoteApp" } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Create.json index 6b4a238bc273..a3f648c58d75 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Create.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Create.json @@ -22,7 +22,7 @@ "200": { "body": { "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", "properties": { "description": "des1", @@ -41,7 +41,7 @@ "201": { "body": { "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", "properties": { "description": "des1", diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Delete.json index 519b9ba4a249..38052680851e 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Delete.json @@ -9,7 +9,7 @@ "responses": { "200": { "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", "properties": { "description": "des1", diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Get.json index 563967b99b5b..f0a8cfc7afab 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Get.json @@ -10,7 +10,7 @@ "200": { "body": { "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", "properties": { "description": "des1", diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_List.json index ad1a505f987b..fcdbc6548ab6 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_List.json @@ -11,7 +11,7 @@ "value": [ { "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", "properties": { "description": "des1", @@ -28,7 +28,7 @@ }, { "name": "applicationGroup1/application2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application2", "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", "properties": { "description": "des2", diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Update.json index 14cc21f094ed..cebc96b274e3 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Application_Update.json @@ -22,7 +22,7 @@ "200": { "body": { "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", "properties": { "description": "des1", diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Get.json index 26b94e09f7c8..9ba7029e8d05 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Get.json @@ -10,7 +10,7 @@ "200": { "body": { "name": "applicationGroup1/SessionDesktop", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", "properties": { "description": "des1", diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_List.json index ed22d9f54aa9..278df9477b0a 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_List.json @@ -11,7 +11,7 @@ "value": [ { "name": "applicationGroup1/SessionDesktop", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", "properties": { "description": "des1", diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Update.json index 0a1f83fccb49..8b93343fdda7 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Desktop_Update.json @@ -16,7 +16,7 @@ "200": { "body": { "name": "applicationGroup1/SessionDesktop", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/desktops/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/desktops/SessionDesktop", "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", "properties": { "description": "des1", diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Create.json index 12ea67762e9d..8f7ebb829d8a 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Create.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Create.json @@ -31,8 +31,8 @@ "200": { "body": { "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostPools", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostpools", "location": "centralus", "tags": { "key1": "value1", @@ -42,7 +42,7 @@ "friendlyName": "friendly", "description": "des1", "hostPoolType": "Pooled", - "personalDesktopAssignmentType": "Automatic", + "personalDesktopAssignmentType": null, "customRdpProperty": null, "maxSessionLimit": 999999, "loadBalancerType": "BreadthFirst", @@ -53,7 +53,7 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath", + "ssoContext": null, "preferredAppGroupType": "Desktop" } } @@ -61,8 +61,8 @@ "201": { "body": { "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostPools", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostpools", "location": "centralus", "tags": { "key1": "value1", @@ -72,7 +72,7 @@ "friendlyName": "friendly", "description": "des1", "hostPoolType": "Pooled", - "personalDesktopAssignmentType": "Automatic", + "personalDesktopAssignmentType": null, "customRdpProperty": null, "maxSessionLimit": 999999, "loadBalancerType": "BreadthFirst", @@ -83,7 +83,7 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath", + "ssoContext": null, "preferredAppGroupType": "Desktop" } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Delete.json index 447fc42fc699..fba66ca5ceb9 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Delete.json @@ -9,8 +9,8 @@ "responses": { "200": { "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostPools", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostpools", "location": "centralus", "tags": { "key1": "value1", @@ -20,7 +20,7 @@ "friendlyName": "friendly", "description": "des1", "hostPoolType": "Pooled", - "personalDesktopAssignmentType": "Automatic", + "personalDesktopAssignmentType": null, "customRdpProperty": null, "maxSessionLimit": 999999, "loadBalancerType": "BreadthFirst", @@ -31,7 +31,7 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath" + "ssoContext": null } }, "204": {} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Get.json index fb86c3da15ee..e4b3609d0a4a 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Get.json @@ -9,8 +9,8 @@ "200": { "body": { "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostPools", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostpools", "location": "centralus", "tags": { "key1": "value1", @@ -20,7 +20,7 @@ "friendlyName": "friendly", "description": "des1", "hostPoolType": "Pooled", - "personalDesktopAssignmentType": "Automatic", + "personalDesktopAssignmentType": null, "customRdpProperty": null, "maxSessionLimit": 999999, "loadBalancerType": "BreadthFirst", @@ -31,7 +31,7 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath", + "ssoContext": null, "preferredAppGroupType": "Desktop" } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_List.json index 69ef8301a370..4d63045e0f2c 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_List.json @@ -9,8 +9,8 @@ "value": [ { "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostPools", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostpools", "location": "centralus", "tags": { "key1": "value1", @@ -20,7 +20,7 @@ "friendlyName": "friendly", "description": "des1", "hostPoolType": "Pooled", - "personalDesktopAssignmentType": "Automatic", + "personalDesktopAssignmentType": null, "customRdpProperty": null, "maxSessionLimit": 999999, "loadBalancerType": "BreadthFirst", @@ -31,14 +31,14 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath", + "ssoContext": null, "preferredAppGroupType": "Desktop" } }, { "name": "hostPool2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2", - "type": "/Microsoft.DesktopVirtualization/hostPools", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool2", + "type": "/Microsoft.DesktopVirtualization/hostpools", "location": "centralus", "tags": { "key1": "value1", @@ -48,7 +48,7 @@ "friendlyName": "friendly", "description": "des1", "hostPoolType": "Pooled", - "personalDesktopAssignmentType": "Automatic", + "personalDesktopAssignmentType": null, "customRdpProperty": null, "maxSessionLimit": 999999, "loadBalancerType": "BreadthFirst", @@ -59,7 +59,7 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath", + "ssoContext": null, "preferredAppGroupType": "Desktop" } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_ListByResourceGroup.json index 933bf9839591..a298ffa4a1ef 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_ListByResourceGroup.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_ListByResourceGroup.json @@ -10,8 +10,8 @@ "value": [ { "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostPools", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostpools", "location": "centralus", "tags": { "key1": "value1", @@ -21,7 +21,7 @@ "friendlyName": "friendly", "description": "des1", "hostPoolType": "Pooled", - "personalDesktopAssignmentType": "Automatic", + "personalDesktopAssignmentType": null, "customRdpProperty": null, "maxSessionLimit": 999999, "loadBalancerType": "BreadthFirst", @@ -32,14 +32,14 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath", + "ssoContext": null, "preferredAppGroupType": "Desktop" } }, { "name": "hostPool2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2", - "type": "/Microsoft.DesktopVirtualization/hostPools", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool2", + "type": "/Microsoft.DesktopVirtualization/hostpools", "location": "centralus", "tags": { "key1": "value1", @@ -49,7 +49,7 @@ "friendlyName": "friendly", "description": "des1", "hostPoolType": "Pooled", - "personalDesktopAssignmentType": "Automatic", + "personalDesktopAssignmentType": null, "customRdpProperty": null, "maxSessionLimit": 999999, "loadBalancerType": "BreadthFirst", @@ -60,7 +60,7 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath", + "ssoContext": null, "preferredAppGroupType": "Desktop" } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Update.json index 833bf8716bbf..7eb76d9cbb1f 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Update.json @@ -28,8 +28,8 @@ "200": { "body": { "name": "hostPool1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "type": "/Microsoft.DesktopVirtualization/hostPools", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostpools", "location": "centralus", "tags": { "key1": "value1", @@ -39,7 +39,7 @@ "friendlyName": "friendly", "description": "des1", "hostPoolType": "Pooled", - "personalDesktopAssignmentType": "Automatic", + "personalDesktopAssignmentType": null, "customRdpProperty": null, "maxSessionLimit": 999999, "loadBalancerType": "BreadthFirst", @@ -50,7 +50,7 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath", + "ssoContext": null, "preferredAppGroupType": "Desktop" } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Delete.json index 12cae16ead92..8961354c5283 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Delete.json @@ -10,7 +10,7 @@ "responses": { "200": { "name": "sessionHost1.microsoft.com", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com", "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", "properties": { "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", @@ -26,7 +26,7 @@ "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", "updateErrorMessage": "", "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", - "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } }, "204": {} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Get.json index 7c4fc2180b4b..1006aadcae10 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Get.json @@ -10,7 +10,7 @@ "200": { "body": { "name": "sessionHost1.microsoft.com", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com", "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", "properties": { "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", @@ -26,7 +26,7 @@ "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", "updateErrorMessage": "", "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", - "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_List.json index 12ba5cafb4f2..f683f51f839e 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_List.json @@ -11,7 +11,7 @@ "value": [ { "name": "sessionHost1.microsoft.com", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com", "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", "properties": { "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", @@ -27,12 +27,12 @@ "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", "updateErrorMessage": "", "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", - "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } }, { "name": "sessionHost2.microsoft.com", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost2microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost2microsoft.com", "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", "properties": { "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", @@ -48,7 +48,7 @@ "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", "updateErrorMessage": "", "virtualMachineId": "39491b54-c033-4dec-b09a-18bf0ebafaef", - "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2" + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2" } } ] diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Update.json index 9353b6accd08..41356917763b 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Update.json @@ -16,7 +16,7 @@ "200": { "body": { "name": "sessionHost1.microsoft.com", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com", "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", "properties": { "lastHeartBeat": "2019-01-11T19:27:13.6108027Z", @@ -32,7 +32,7 @@ "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", "updateErrorMessage": "", "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", - "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/StartMenuItem_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/StartMenuItem_List.json index afd698213ed8..fa4017a89b86 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/StartMenuItem_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/StartMenuItem_List.json @@ -11,7 +11,7 @@ "value": [ { "name": "application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application1", "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", "properties": { "appAlias": "word", @@ -24,7 +24,7 @@ }, { "name": "application2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application2", "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", "properties": { "appAlias": "excel", diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Delete.json index da8cd8ae4bfb..ee13e7555380 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Delete.json @@ -11,7 +11,7 @@ "responses": { "200": { "name": "1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", "properties": { "userPrincipalName": "user1@microsoft.com", diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Get.json index 06aac45ba81e..ad30b313730e 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_Get.json @@ -11,7 +11,7 @@ "200": { "body": { "name": "1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", "properties": { "userPrincipalName": "user1@microsoft.com", diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_List.json index cef72db2561d..771a4b13da70 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_List.json @@ -12,7 +12,7 @@ "value": [ { "name": "1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", "properties": { "userPrincipalName": "user1@microsoft.com", @@ -24,7 +24,7 @@ }, { "name": "2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", "properties": { "userPrincipalName": "user1@microsoft.com", diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_ListByHostPool.json index 1c39908d8349..f6d1edc1f4dc 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_ListByHostPool.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/UserSession_ListByHostPool.json @@ -12,7 +12,7 @@ "value": [ { "name": "1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", "properties": { "userPrincipalName": "user1@microsoft.com", @@ -24,7 +24,7 @@ }, { "name": "2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", "properties": { "userPrincipalName": "user1@microsoft.com", diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Create.json index 7085ade8ceed..ff6de1e47064 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Create.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Create.json @@ -20,7 +20,7 @@ "200": { "body": { "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", "type": "Microsoft.DesktopVirtualization/workspaces", "location": "centralus", "tags": { @@ -36,7 +36,7 @@ "201": { "body": { "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", "type": "Microsoft.DesktopVirtualization/workspaces", "location": "centralus", "tags": { diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Delete.json index 2048117807aa..b1fac0b29d22 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Delete.json @@ -8,7 +8,7 @@ "responses": { "200": { "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", "type": "Microsoft.DesktopVirtualization/workspaces", "location": "centralus", "tags": { diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Get.json index dc613edd408b..96cec1aa7acf 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Get.json @@ -9,7 +9,7 @@ "200": { "body": { "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", "type": "Microsoft.DesktopVirtualization/workspaces", "location": "centralus", "tags": { diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_ListByResourceGroup.json index 6f6dc3ad0de8..2988972d0e2f 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_ListByResourceGroup.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_ListByResourceGroup.json @@ -10,7 +10,7 @@ "value": [ { "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", "type": "Microsoft.DesktopVirtualization/workspaces", "location": "centralus", "tags": { @@ -24,7 +24,7 @@ }, { "name": "workspace2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", "type": "Microsoft.DesktopVirtualization/workspaces", "location": "centralus", "tags": { diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_ListBySubscription.json index 79ec5eea61dd..49f61942a4ff 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_ListBySubscription.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_ListBySubscription.json @@ -9,7 +9,7 @@ "value": [ { "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", "type": "Microsoft.DesktopVirtualization/workspaces", "location": "centralus", "tags": { @@ -23,7 +23,7 @@ }, { "name": "workspace2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", "type": "Microsoft.DesktopVirtualization/workspaces", "location": "centralus", "tags": { diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Update.json index 33060dc90353..bd3f747371af 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/Workspace_Update.json @@ -19,7 +19,7 @@ "200": { "body": { "name": "workspace1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", "type": "Microsoft.DesktopVirtualization/workspaces", "location": "centralus", "tags": { From 4583ff4b01b6b9cd8ebd6a9fc26fc2ad483f4fdd Mon Sep 17 00:00:00 2001 From: Phoenix He Date: Thu, 24 Sep 2020 08:12:06 +0800 Subject: [PATCH 131/164] Add DISCRIMINATOR_VALUE_NOT_FOUND and INVALID_RESPONSE_BODY (#10910) * Add DISCRIMINATOR_VALUE_NOT_FOUND and INVALID_RESPONSE_BODY * Update Semantic-and-Model-Violations-Reference.md --- ...Semantic-and-Model-Violations-Reference.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/documentation/Semantic-and-Model-Violations-Reference.md b/documentation/Semantic-and-Model-Violations-Reference.md index de459aa90c63..0742ec712138 100644 --- a/documentation/Semantic-and-Model-Violations-Reference.md +++ b/documentation/Semantic-and-Model-Violations-Reference.md @@ -59,10 +59,12 @@ This document lists the set of automated rules that can be validated against swa | [REMOTE_NOT_VALID](#REMOTE_NOT_VALID) | | | [INVALID_REQUEST_PARAMETER](#INVALID_REQUEST_PARAMETER) | | | [INVALID_RESPONSE_CODE](#INVALID_RESPONSE_CODE) | | +| [INVALID_RESPONSE_BODY](#INVALID_RESPONSE_BODY) | | | [MISSING_REQUIRED_PARAMETER](#MISSING_REQUIRED_PARAMETER) | | | [KEYWORD_TYPE_EXPECTED](#KEYWORD_TYPE_EXPECTED) | | | [READONLY_PROPERTY_NOT_ALLOWED_IN_REQUEST](#READONLY_PROPERTY_NOT_ALLOWED_IN_REQUEST) | | | [SCHEMA_VALIDATION_FAILED](#SCHEMA_VALIDATION_FAILED) | | +| [DISCRIMINATOR_VALUE_NOT_FOUND](#DISCRIMINATOR_VALUE_NOT_FOUND) | | | [DISCRIMINATOR_NOT_REQUIRED](#DISCRIMINATOR_NOT_REQUIRED) | [OAV131](#DISCRIMINATOR_NOT_REQUIRED) | | [RESPONSE_BODY_NOT_IN_EXAMPLE](#RESPONSE_BODY_NOT_IN_EXAMPLE) | [OAV130](#RESPONSE_BODY_NOT_IN_EXAMPLE) | | [DOUBLE_FORWARD_SLASHES_IN_URL](#DOUBLE_FORWARD_SLASHES_IN_URL) | [OAV129](#DOUBLE_FORWARD_SLASHES_IN_URL) | @@ -546,6 +548,15 @@ This document lists the set of automated rules that can be validated against swa **How to fix the violation**: Remove extra response code definition in example or correct it. +### INVALID_RESPONSE_BODY + +**Output Message**:Body is required in response but not provided + +**Description**: Body schema is defined in swagger but body is not found in example or traffic. + +**How to fix the violation**: Add response body. + + ### KEYWORD_TYPE_EXPECTED **Output Message**: Keyword 'type' is expected to be of type 'array,boolean,integer,number,null,object,string'. @@ -611,6 +622,14 @@ This document lists the set of automated rules that can be validated against swa **How to fix the violation**: Provide the requried property in example or remove this property from the required list of the definition in swagger spec. Or add items property if the type is array. +### DISCRIMINATOR_VALUE_NOT_FOUND + +**Output Message**: Discriminator value "{0}" not found + +**Description**: The property used as discriminator has a value {0} but it's not found in swagger spec. + +**How to fix the violation**: Add the model that has the discriminator value or fix the discriminator value. The discriminator value could be specified by model name in definitions or by "x-ms-discriminator-value". + ### DISCRIMINATOR_NOT_REQUIRED From 2a4dc288266c1f1829d6c1d5ef877b120fa2abd7 Mon Sep 17 00:00:00 2001 From: kristynhamasaki <68716650+kristynhamasaki@users.noreply.github.com> Date: Wed, 23 Sep 2020 16:56:58 -1000 Subject: [PATCH 132/164] Cosmos DB - Adding APIs for Role Definition and Role Assignment (#10493) * WOrk on Role Definition * Finish json initial * added examples * added missing comma * changes based on linter * try removing filter from paht? * spelled description wrong :( * more fixes * more changes for exmaple issesu * hopefully fix * minor changes and delete old files * changes based on warnings * chnage to invalidroledefinition * change delete to 202 * change put to 202 * change default error response * fix response code example * fix errors * RoleDefinitionType enum * changes based on comments * trying different errorresponse * more changes based on comments + add DefaultErrorResponse * minor typo fixes * some minor changes * remove notdataactions and change databaseAccountName to accountName * new changes based on comments * changes to comments and DefaultErrorResponse * change to errorResponse * change to delete responses * changes to descriptions * change description * add back notDataActions * add 'Sql' to operationIds --- .../preview/2020-06-01-preview/cosmos-db.json | 10 +- ...CosmosDBSqlRoleAssignmentCreateUpdate.json | 31 + .../CosmosDBSqlRoleAssignmentDelete.json | 14 + .../CosmosDBSqlRoleAssignmentGet.json | 23 + .../CosmosDBSqlRoleAssignmentList.json | 26 + ...CosmosDBSqlRoleDefinitionCreateUpdate.json | 54 ++ .../CosmosDBSqlRoleDefinitionDelete.json | 14 + .../CosmosDBSqlRoleDefinitionGet.json | 35 ++ .../CosmosDBSqlRoleDefinitionList.json | 38 ++ .../preview/2020-06-01-preview/rbac.json | 573 ++++++++++++++++++ .../cosmos-db/resource-manager/readme.md | 44 ++ 11 files changed, 857 insertions(+), 5 deletions(-) create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleAssignmentCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleAssignmentDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleAssignmentGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleAssignmentList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleDefinitionCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleDefinitionDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleDefinitionGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleDefinitionList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/rbac.json diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json index 9cde743923e7..cde658ad05ed 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json @@ -4215,7 +4215,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponseUpdatedFormat" + "$ref": "#/definitions/DefaultErrorResponse" } } }, @@ -4251,7 +4251,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponseUpdatedFormat" + "$ref": "#/definitions/DefaultErrorResponse" } } }, @@ -4293,7 +4293,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponseUpdatedFormat" + "$ref": "#/definitions/DefaultErrorResponse" } } } @@ -4483,11 +4483,11 @@ }, "description": "Error Response." }, - "ErrorResponseUpdatedFormat": { + "DefaultErrorResponse": { "description": "An error response from the service.", "properties": { "error": { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleAssignmentCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleAssignmentCreateUpdate.json new file mode 100644 index 000000000000..dde4f7397304 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleAssignmentCreateUpdate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "roleAssignmentId": "myRoleAssignmentId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2020-06-01-preview", + "createUpdateSqlRoleAssignmentParameters": { + "properties": { + "roleDefinitionId": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId", + "scope": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases", + "principalId": "myPrincipalId" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleAssignments/myRoleAssignmentId", + "name": "myRoleAssignmentId", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments", + "properties": { + "roleDefinitionId": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId", + "scope": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases", + "principalId": "myPrincipalId" + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleAssignmentDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleAssignmentDelete.json new file mode 100644 index 000000000000..2055244f0a8d --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleAssignmentDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "roleAssignmentId": "myRoleAssignmentId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2020-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleAssignmentGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleAssignmentGet.json new file mode 100644 index 000000000000..e42f8592a146 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleAssignmentGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "roleAssignmentId": "myRoleAssignmentId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2020-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleAssignments/myRoleAssignmentId", + "name": "myRoleAssignmentId", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments", + "properties": { + "roleDefinitionId": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId", + "scope": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases", + "principalId": "myPrincipalId" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleAssignmentList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleAssignmentList.json new file mode 100644 index 000000000000..5ef2595574ee --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleAssignmentList.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2020-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleAssignments/myRoleAssignmentId", + "name": "myRoleAssignmentId", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments", + "properties": { + "roleDefinitionId": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId", + "scope": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases/colls/redmond-purchases", + "principalId": "myPrincipalId" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleDefinitionCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleDefinitionCreateUpdate.json new file mode 100644 index 000000000000..88351bec1d9e --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleDefinitionCreateUpdate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "roleDefinitionId": "myRoleDefinitionId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2020-06-01-preview", + "createUpdateSqlRoleDefinitionParameters": { + "properties": { + "roleName": "myRoleName", + "type": "CustomRole", + "assignableScopes": [ + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales", + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases" + ], + "permissions": [ + { + "dataActions": [ + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create", + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read" + ], + "notDataActions": [] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId", + "name": "myRoleDefinitionId", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions", + "properties": { + "roleName": "myRoleName", + "type": "CustomRole", + "assignableScopes": [ + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales", + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases" + ], + "permissions": [ + { + "dataActions": [ + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create", + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read" + ] + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleDefinitionDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleDefinitionDelete.json new file mode 100644 index 000000000000..2208e3274038 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleDefinitionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "roleDefinitionId": "myRoleDefinitionId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2020-06-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleDefinitionGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleDefinitionGet.json new file mode 100644 index 000000000000..43ee7da06029 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleDefinitionGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "roleDefinitionId": "myRoleDefinitionId", + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2020-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId", + "name": "myRoleDefinitionId", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions", + "properties": { + "roleName": "myRoleName", + "type": "CustomRole", + "assignableScopes": [ + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales", + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases" + ], + "permissions": [ + { + "dataActions": [ + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create", + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read" + ], + "notDataActions": [] + } + ] + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleDefinitionList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleDefinitionList.json new file mode 100644 index 000000000000..52933db02416 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlRoleDefinitionList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "accountName": "myAccountName", + "api-version": "2020-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId", + "name": "myRoleDefinitionId", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions", + "properties": { + "roleName": "myRoleName", + "type": "CustomRole", + "assignableScopes": [ + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales", + "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases" + ], + "permissions": [ + { + "dataActions": [ + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create", + "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read" + ], + "notDataActions": [] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/rbac.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/rbac.json new file mode 100644 index 000000000000..cda13ff0d7e9 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/rbac.json @@ -0,0 +1,573 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB", + "description": "Azure Cosmos DB Role Based Access Control Resource Provider REST API", + "version": "2020-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions/{roleDefinitionId}": { + "get": { + "operationId": "SqlResources_GetSqlRoleDefinition", + "x-ms-examples": { + "CosmosDBSqlRoleDefinitionGet": { + "$ref": "./examples/CosmosDBSqlRoleDefinitionGet.json" + } + }, + "description": "Retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id.", + "parameters": [ + { + "$ref": "#/parameters/roleDefinitionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Role Definition was successfully retrieved.", + "schema": { + "$ref": "#/definitions/SqlRoleDefinitionGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateSqlRoleDefinition", + "x-ms-examples": { + "CosmosDBSqlRoleDefinitionCreateUpdate": { + "$ref": "./examples/CosmosDBSqlRoleDefinitionCreateUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Creates or updates an Azure Cosmos DB SQL Role Definition.", + "parameters": [ + { + "$ref": "#/parameters/roleDefinitionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateSqlRoleDefinitionParameters", + "in": "body", + "required": true, + "description": "The properties required to create or update a Role Definition.", + "schema": { + "$ref": "#/definitions/SqlRoleDefinitionCreateUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Role Definition create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/SqlRoleDefinitionGetResults" + } + }, + "202": { + "description": "The Role Definition create or update request was accepted and will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "operationId": "SqlResources_DeleteSqlRoleDefinition", + "x-ms-examples": { + "CosmosDBSqlRoleDefinitionDelete": { + "$ref": "./examples/CosmosDBSqlRoleDefinitionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Deletes an existing Azure Cosmos DB SQL Role Definition.", + "parameters": [ + { + "$ref": "#/parameters/roleDefinitionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Role Definition delete operation was completed successfully." + }, + "202": { + "description": "The Role Definition delete request was accepted and will complete asynchronously." + }, + "204": { + "description": "The requested Role Definition does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions": { + "get": { + "operationId": "SqlResources_ListSqlRoleDefinitions", + "x-ms-examples": { + "CosmosDBSqlRoleDefinitionList": { + "$ref": "./examples/CosmosDBSqlRoleDefinitionList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the list of all Azure Cosmos DB SQL Role Definitions.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlRoleDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments/{roleAssignmentId}": { + "get": { + "operationId": "SqlResources_GetSqlRoleAssignment", + "x-ms-examples": { + "CosmosDBSqlRoleAssignmentGet": { + "$ref": "./examples/CosmosDBSqlRoleAssignmentGet.json" + } + }, + "description": "Retrieves the properties of an existing Azure Cosmos DB SQL Role Assignment with the given Id.", + "parameters": [ + { + "$ref": "#/parameters/roleAssignmentIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Role Assignment was successfully retrieved.", + "schema": { + "$ref": "#/definitions/SqlRoleAssignmentGetResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateSqlRoleAssignment", + "x-ms-examples": { + "CosmosDBSqlRoleAssignmentCreateUpdate": { + "$ref": "./examples/CosmosDBSqlRoleAssignmentCreateUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Creates or updates an Azure Cosmos DB SQL Role Assignment.", + "parameters": [ + { + "$ref": "#/parameters/roleAssignmentIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateSqlRoleAssignmentParameters", + "in": "body", + "required": true, + "description": "The properties required to create or update a Role Assignment.", + "schema": { + "$ref": "#/definitions/SqlRoleAssignmentCreateUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The Role Assignment create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/SqlRoleAssignmentGetResults" + } + }, + "202": { + "description": "The Role Assignment create or update request was accepted and will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/DefaultErrorResponse" + } + } + } + }, + "delete": { + "operationId": "SqlResources_DeleteSqlRoleAssignment", + "x-ms-examples": { + "CosmosDBSqlRoleAssignmentDelete": { + "$ref": "./examples/CosmosDBSqlRoleAssignmentDelete.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Deletes an existing Azure Cosmos DB SQL Role Assignment.", + "parameters": [ + { + "$ref": "#/parameters/roleAssignmentIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Role Assignment delete operation was completed successfully." + }, + "202": { + "description": "The Role Assignment delete request was accepted and will complete asynchronously." + }, + "204": { + "description": "The requested Role Assignment does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/DefaultErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments": { + "get": { + "operationId": "SqlResources_ListSqlRoleAssignments", + "x-ms-examples": { + "CosmosDBSqlRoleAssignmentList": { + "$ref": "./examples/CosmosDBSqlRoleAssignmentList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the list of all Azure Cosmos DB SQL Role Assignments.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "cosmos-db.json#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlRoleAssignmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "cosmos-db.json#/definitions/DefaultErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SqlRoleDefinitionResource": { + "properties": { + "roleName": { + "type": "string", + "description": "A user-friendly name for the Role Definition. Must be unique for the database account." + }, + "type": { + "type": "string", + "enum": [ + "BuiltInRole", + "CustomRole" + ], + "description": "Indicates whether the Role Definition was built-in or user created.", + "x-ms-enum": { + "name": "RoleDefinitionType", + "modelAsString": false + } + }, + "assignableScopes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist." + }, + "permissions": { + "type": "array", + "items": { + "$ref": "#/definitions/Permission" + }, + "description": "The set of operations allowed through this Role Definition." + } + }, + "description": "Azure Cosmos DB SQL Role Definition resource object." + }, + "SqlRoleDefinitionCreateUpdateParameters": { + "description": "Parameters to create and update an Azure Cosmos DB SQL Role Definition.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update an Azure Cosmos DB SQL Role Definition.", + "$ref": "#/definitions/SqlRoleDefinitionResource" + } + } + }, + "SqlRoleDefinitionGetResults": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SqlRoleDefinitionResource", + "description": "Properties related to the Role Definition." + } + }, + "allOf": [ + { + "$ref": "cosmos-db.json#/definitions/ARMProxyResource" + } + ], + "description": "An Azure Cosmos DB SQL Role Definition." + }, + "Permission": { + "type": "object", + "properties": { + "dataActions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of data actions that are allowed." + }, + "notDataActions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An array of data actions that are denied." + } + }, + "description": "The set of data plane operations permitted through this Role Definition." + }, + "SqlRoleDefinitionListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SqlRoleDefinitionGetResults" + }, + "description": "List of Role Definitions and their properties." + } + }, + "description": "The relevant Role Definitions." + }, + "SqlRoleAssignmentResource": { + "type": "object", + "properties": { + "roleDefinitionId": { + "type": "string", + "description": "The unique identifier for the associated Role Definition." + }, + "scope": { + "type": "string", + "description": "The data plane resource path for which access is being granted through this Role Assignment." + }, + "principalId": { + "type": "string", + "description": "The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription." + } + }, + "description": "Azure Cosmos DB SQL Role Assignment resource object." + }, + "SqlRoleAssignmentCreateUpdateParameters": { + "description": "Parameters to create and update an Azure Cosmos DB SQL Role Assignment.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update an Azure Cosmos DB SQL Role Assignment.", + "$ref": "#/definitions/SqlRoleAssignmentResource" + } + } + }, + "SqlRoleAssignmentGetResults": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SqlRoleAssignmentResource", + "description": "Properties related to the Role Assignment." + } + }, + "allOf": [ + { + "$ref": "cosmos-db.json#/definitions/ARMProxyResource" + } + ], + "description": "An Azure Cosmos DB Role Assignment" + }, + "SqlRoleAssignmentListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SqlRoleAssignmentGetResults" + }, + "description": "List of Role Assignments and their properties" + } + }, + "description": "The relevant Role Assignments." + } + }, + "parameters": { + "roleDefinitionIdParameter": { + "name": "roleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The GUID for the Role Definition." + }, + "roleAssignmentIdParameter": { + "name": "roleAssignmentId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The GUID for the Role Assignment." + } + } +} diff --git a/specification/cosmos-db/resource-manager/readme.md b/specification/cosmos-db/resource-manager/readme.md index 7adb905df487..80054f71a6e8 100644 --- a/specification/cosmos-db/resource-manager/readme.md +++ b/specification/cosmos-db/resource-manager/readme.md @@ -38,6 +38,7 @@ These settings apply only when `--tag=package-2020-06-preview` is specified on t input-file: - Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json - Microsoft.DocumentDB/preview/2020-06-01-preview/notebook.json +- Microsoft.DocumentDB/preview/2020-06-01-preview/rbac.json - Microsoft.DocumentDB/preview/2019-08-01-preview/privateLinkResources.json - Microsoft.DocumentDB/preview/2019-08-01-preview/privateEndpointConnection.json ``` @@ -220,6 +221,9 @@ directive: - suppress: PathResourceProviderNamePascalCase from: privateLinkResources.json reason: The name of the provider is Microsoft.DocumentDB + - suppress: PathResourceProviderNamePascalCase + from: rbac.json + reason: The name of the provider is Microsoft.DocumentDB ``` --- @@ -273,3 +277,43 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) +## Multi-API/Profile support for AutoRest v3 generators + +AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. + +This block is updated by an automatic script. Edits may be lost! + +``` yaml $(tag) == 'all-api-versions' /* autogenerated */ +# include the azure profile definitions from the standard location +require: $(this-folder)/../../../profiles/readme.md + +# all the input files across all versions +input-file: + - $(this-folder)/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json + - $(this-folder)/Microsoft.DocumentDB/preview/2020-06-01-preview/notebook.json + - $(this-folder)/Microsoft.DocumentDB/preview/2020-06-01-preview/rbac.json + - $(this-folder)/Microsoft.DocumentDB/preview/2019-08-01-preview/privateLinkResources.json + - $(this-folder)/Microsoft.DocumentDB/preview/2019-08-01-preview/privateEndpointConnection.json + - $(this-folder)/Microsoft.DocumentDB/stable/2020-04-01/cosmos-db.json + - $(this-folder)/Microsoft.DocumentDB/stable/2020-04-01/notebook.json + - $(this-folder)/Microsoft.DocumentDB/stable/2020-03-01/cosmos-db.json + - $(this-folder)/Microsoft.DocumentDB/stable/2020-03-01/notebook.json + - $(this-folder)/Microsoft.DocumentDB/stable/2019-12-12/cosmos-db.json + - $(this-folder)/Microsoft.DocumentDB/stable/2019-12-12/notebook.json + - $(this-folder)/Microsoft.DocumentDB/stable/2019-08-01/cosmos-db.json + - $(this-folder)/Microsoft.DocumentDB/stable/2019-08-01/notebook.json + - $(this-folder)/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json + - $(this-folder)/Microsoft.DocumentDB/stable/2014-04-01/cosmos-db.json + - $(this-folder)/Microsoft.DocumentDB/stable/2015-11-06/cosmos-db.json + - $(this-folder)/Microsoft.DocumentDB/stable/2016-03-19/cosmos-db.json + - $(this-folder)/Microsoft.DocumentDB/stable/2016-03-31/cosmos-db.json + +``` + +If there are files that should not be in the `all-api-versions` set, +uncomment the `exclude-file` section below and add the file paths. + +``` yaml $(tag) == 'all-api-versions' +#exclude-file: +# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json +``` From 30832c2b6e4a6c87d9d7e19f3404ede95fbdff87 Mon Sep 17 00:00:00 2001 From: Frank Gao <4760010+gtxistxgao@users.noreply.github.com> Date: Thu, 24 Sep 2020 01:28:29 -0700 Subject: [PATCH 133/164] upgradeNodeImageVersion should be an agent pools operation (#10879) --- .../stable/2020-07-01/managedClusters.json | 2 +- .../stable/2020-09-01/managedClusters.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-07-01/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-07-01/managedClusters.json index 14b7db1b5c8d..5a07097c6d67 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-07-01/managedClusters.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-07-01/managedClusters.json @@ -1232,7 +1232,7 @@ "tags": [ "AgentPools" ], - "operationId": "ManagedClusters_UpgradeNodeImageVersion", + "operationId": "AgentPools_UpgradeNodeImageVersion", "summary": "Upgrade node image version of an agent pool to the latest.", "description": "Upgrade node image version of an agent pool to the latest.", "parameters": [ diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/managedClusters.json index 3ef7b8c1035b..be924c99384f 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/managedClusters.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-09-01/managedClusters.json @@ -1323,7 +1323,7 @@ "tags": [ "AgentPools" ], - "operationId": "ManagedClusters_UpgradeNodeImageVersion", + "operationId": "AgentPools_UpgradeNodeImageVersion", "summary": "Upgrade node image version of an agent pool to the latest.", "description": "Upgrade node image version of an agent pool to the latest.", "parameters": [ From 5e6812131f1917b18da94c499052c99362c8a1c9 Mon Sep 17 00:00:00 2001 From: yig Date: Thu, 24 Sep 2020 17:08:45 +0800 Subject: [PATCH 134/164] Support create storage account with extendedLocation (#10900) --- .../examples/StorageAccountCreate.json | 8 +++++ .../preview/2020-08-01-preview/storage.json | 32 +++++++++++++++++++ 2 files changed, 40 insertions(+) diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCreate.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCreate.json index f560f583aac1..220209545654 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCreate.json +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/examples/StorageAccountCreate.json @@ -10,6 +10,10 @@ }, "kind": "Storage", "location": "eastus", + "extendedLocation": { + "type": "EdgeZone", + "name": "losangeles001" + }, "properties": { "isHnsEnabled": true, "allowBlobPublicAccess": false, @@ -47,6 +51,10 @@ "kind": "Storage", "location": "eastus", "name": "sto4445", + "extendedLocation": { + "type": "EdgeZone", + "name": "losangeles001" + }, "properties": { "isHnsEnabled": true, "allowBlobPublicAccess": false, diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/storage.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/storage.json index e91a7d63f20d..d8a18901b502 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2020-08-01-preview/storage.json @@ -2287,6 +2287,30 @@ ], "description": "Identity for the resource." }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "EdgeZone" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "ExtendedLocation": { + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, "StorageAccountCreateParameters": { "properties": { "sku": { @@ -2312,6 +2336,10 @@ "type": "string", "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Optional. Set the extended location of the resource. If not set, the storage account will be created in Azure main region. Otherwise it will be created in the specified extended location" + }, "tags": { "type": "object", "additionalProperties": { @@ -2782,6 +2810,10 @@ "$ref": "#/definitions/Identity", "description": "The identity of the resource." }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/StorageAccountProperties", From bc527638520f305e53ea106e57b24427c370978e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Magdalena=20Bia=C5=82ecka?= <2598290+mbialecka@users.noreply.github.com> Date: Thu, 24 Sep 2020 02:41:55 -0700 Subject: [PATCH 135/164] Fix operations API (#10731) --- .../2020-03-01-preview/azurestackhci.json | 54 ++++++++++++------- 1 file changed, 35 insertions(+), 19 deletions(-) diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2020-03-01-preview/azurestackhci.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2020-03-01-preview/azurestackhci.json index de3d90772ef0..f68062eb0abc 100644 --- a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2020-03-01-preview/azurestackhci.json +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/preview/2020-03-01-preview/azurestackhci.json @@ -50,7 +50,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/OperationList" + "$ref": "#/definitions/AvailableOperations" } }, "default": { @@ -545,60 +545,76 @@ } } }, - "OperationList": { - "description": "List of available operations.", + "AvailableOperations": { + "description": "Available operations of the service", "type": "object", "properties": { "value": { - "description": "List of operations.", + "description": "Collection of available operation details", + "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/Operation" + "$ref": "#/definitions/OperationDetail" } }, "nextLink": { - "description": "Link to the next set of results.", - "type": "string", - "readOnly": true + "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" } } }, - "Operation": { - "description": "Operation details.", + "OperationDetail": { + "description": "Operation detail payload", "type": "object", "properties": { "name": { - "description": "Name of the operation.", - "type": "string", - "readOnly": true + "description": "Name of the operation", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" }, "display": { "$ref": "#/definitions/OperationDisplay", - "description": "Operation properties." + "description": "Display of the operation" + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Properties of the operation" } } }, "OperationDisplay": { - "description": "Operation properties.", + "description": "Operation display payload", "type": "object", "properties": { "provider": { - "description": "Resource provider name.", + "description": "Resource provider of the operation", "type": "string" }, "resource": { - "description": "Resource type name.", + "description": "Resource of the operation", "type": "string" }, "operation": { - "description": "Operation name.", + "description": "Localized friendly name for the operation", "type": "string" }, "description": { - "description": "Operation description.", + "description": "Localized friendly description for the operation", "type": "string" } } + }, + "OperationProperties": { + "description": "Operation properties.", + "type": "object", + "properties": {} } }, "parameters": { From 405df4e852f8fca8246db1904357397235f54e92 Mon Sep 17 00:00:00 2001 From: Andrew <30499261+areddish@users.noreply.github.com> Date: Thu, 24 Sep 2020 12:09:24 -0400 Subject: [PATCH 136/164] Computer Vision v3.1 (#10782) * Computer Vision 3.1 API version - Changes include model updates only, no API surface change * Update version * Fix readme.go.md * Fix sample version * Fix spelling --- .../data-plane/ComputerVision/readme.go.md | 12 +- .../data-plane/ComputerVision/readme.md | 13 +- .../data-plane/ComputerVision/readme.ruby.md | 11 + .../stable/v3.1/ComputerVision.json | 1840 +++++++++++++++++ .../ComputerVision/stable/v3.1/Ocr.json | 452 ++++ ...cessfulAnalyzeImageByDomainWithStream.json | 34 + ...SuccessfulAnalyzeImageByDomainWithUrl.json | 36 + .../SuccessfulAnalyzeImageWithStream.json | 176 ++ .../SuccessfulAnalyzeImageWithUrl.json | 184 ++ .../SuccessfulDescribeImageWithStream.json | 44 + .../SuccessfulDescribeImageWithUrl.json | 46 + .../SuccessfulDetectObjectsWithStream.json | 35 + .../SuccessfulDetectObjectsWithUrl.json | 37 + ...SuccessfulGenerateThumbnailWithStream.json | 16 + .../SuccessfulGenerateThumbnailWithUrl.json | 18 + ...SuccessfulGetAreaOfInterestWithStream.json | 26 + .../SuccessfulGetAreaOfInterestWithUrl.json | 28 + .../examples/SuccessfulGetReadResult.json | 369 ++++ .../v3.1/examples/SuccessfulListModels.json | 27 + .../examples/SuccessfulReadWithStream.json | 15 + .../v3.1/examples/SuccessfulReadWithUrl.json | 17 + ...cessfulRecognizePrintedTextWithStream.json | 77 + ...SuccessfulRecognizePrintedTextWithUrl.json | 79 + .../SuccessfulTagImageWithStream.json | 53 + .../examples/SuccessfulTagImageWithUrl.json | 55 + 25 files changed, 3697 insertions(+), 3 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/ComputerVision.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/Ocr.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageByDomainWithStream.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageByDomainWithUrl.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageWithStream.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageWithUrl.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDescribeImageWithStream.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDescribeImageWithUrl.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDetectObjectsWithStream.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDetectObjectsWithUrl.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGenerateThumbnailWithStream.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGenerateThumbnailWithUrl.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGetAreaOfInterestWithStream.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGetAreaOfInterestWithUrl.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGetReadResult.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulListModels.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulReadWithStream.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulReadWithUrl.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulRecognizePrintedTextWithStream.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulRecognizePrintedTextWithUrl.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulTagImageWithStream.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulTagImageWithUrl.json diff --git a/specification/cognitiveservices/data-plane/ComputerVision/readme.go.md b/specification/cognitiveservices/data-plane/ComputerVision/readme.go.md index 97861eeff941..1386894f71a3 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/readme.go.md +++ b/specification/cognitiveservices/data-plane/ComputerVision/readme.go.md @@ -16,6 +16,7 @@ batch: - tag: release_2_0 - tag: release_2_1 - tag: release_3_0 + - tag: release_3_1 ``` ### Tag: release_2_0 and go @@ -45,11 +46,20 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'release_3_1_preview_2' && $(go) +output-folder: $(go-sdk-folder)/services/preview/cognitiveservices/v3.1-preview.2/$(namespace) +``` + ### Tag: release_3_1 and go These settings apply only when `--tag=release_3_1 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'release_3_1' && $(go) -output-folder: $(go-sdk-folder)/services/preview/cognitiveservices/v3.1-preview.2/$(namespace) +output-folder: $(go-sdk-folder)/services/cognitiveservices/v3.1/$(namespace) ``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/readme.md b/specification/cognitiveservices/data-plane/ComputerVision/readme.md index af1edea7aad7..aa285d970a63 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/readme.md +++ b/specification/cognitiveservices/data-plane/ComputerVision/readme.md @@ -4,11 +4,11 @@ Configuration for generating Computer Vision SDK. -The current release is `release_3_0`. +The current release is `release_3_1`. ``` yaml -tag: release_3_0 +tag: release_3_1 add-credentials: true openapi-type: data-plane ``` @@ -57,6 +57,15 @@ input-file: - preview/v3.1-preview.2/Ocr.json ``` +### Release 3.1 +These settings apply only when `--tag=release_3_1` is specified on the command line. + +``` yaml $(tag) == 'release_3_1' +input-file: + - stable/v3.1/ComputerVision.json + - stable/v3.1/Ocr.json +``` + ## Swagger to SDK This section describes what SDK should be generated by the automatic system. diff --git a/specification/cognitiveservices/data-plane/ComputerVision/readme.ruby.md b/specification/cognitiveservices/data-plane/ComputerVision/readme.ruby.md index 019525023fad..b93a320d0992 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/readme.ruby.md +++ b/specification/cognitiveservices/data-plane/ComputerVision/readme.ruby.md @@ -41,4 +41,15 @@ Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'release_3_1' && $(ruby) +namespace: "Azure::CognitiveServices::ComputerVision::V3_1" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_computervision/lib +title: "ComputerVisionClient" ``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/ComputerVision.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/ComputerVision.json new file mode 100644 index 000000000000..35ef27a5a632 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/ComputerVision.json @@ -0,0 +1,1840 @@ +{ + "swagger": "2.0", + "info": { + "version": "3.1", + "title": "Computer Vision Client", + "description": "The Computer Vision API provides state-of-the-art algorithms to process images and return information. For example, it can be used to determine if an image contains mature content, or it can be used to find all the faces in an image. It also has other features like estimating dominant and accent colors, categorizing the content of images, and describing an image with complete English sentences. Additionally, it can also intelligently generate images thumbnails for displaying large images effectively." + }, + "securityDefinitions": { + "apim_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "host": "westcentralus.api.cognitive.microsoft.com", + "basePath": "/vision/v3.1", + "schemes": [ + "https" + ], + "paths": { + "/analyze": { + "post": { + "description": "This operation extracts a rich set of visual features based on the image content.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", + "operationId": "AnalyzeImage", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/VisualFeatures" + }, + { + "name": "details", + "in": "query", + "description": "A string indicating which domain-specific details to return. Multiple values should be comma-separated. Valid visual feature types include: Celebrities - identifies celebrities if detected in the image, Landmarks - identifies notable landmarks in the image.", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "Celebrities", + "Landmarks" + ], + "x-nullable": false, + "x-ms-enum": { + "name": "Details", + "modelAsString": false + } + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "$ref": "#/parameters/ServiceLanguage" + }, + { + "$ref": "#/parameters/DescriptionExclude" + }, + { + "$ref": "#/parameters/ImageUrl" + } + ], + "responses": { + "200": { + "description": "The response include the extracted features in JSON format. Here is the definitions for enumeration types:\r\n ClipartType\r\n Non - clipart = 0, ambiguous = 1, normal - clipart = 2, good - clipart = 3. LineDrawingTypeNon - LineDrawing = 0, LineDrawing = 1.", + "schema": { + "$ref": "#/definitions/ImageAnalysis" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful AnalyzeImage request": { + "$ref": "./examples/SuccessfulAnalyzeImageWithUrl.json" + } + } + } + }, + "/describe": { + "post": { + "description": "This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. Descriptions may include results from celebrity and landmark domain models, if applicable.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", + "operationId": "DescribeImage", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "maxCandidates", + "in": "query", + "description": "Maximum number of candidate descriptions to be returned. The default is 1.", + "required": false, + "type": "integer", + "format": "int32", + "default": 1, + "x-nullable": true + }, + { + "$ref": "#/parameters/ServiceLanguage" + }, + { + "$ref": "#/parameters/DescriptionExclude" + }, + { + "$ref": "#/parameters/ImageUrl" + } + ], + "responses": { + "200": { + "description": "Image description object.", + "schema": { + "$ref": "#/definitions/ImageDescription" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful DescribeImage request": { + "$ref": "./examples/SuccessfulDescribeImageWithUrl.json" + } + } + } + }, + "/detect": { + "post": { + "description": "Performs object detection on the specified image.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", + "operationId": "DetectObjects", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ImageUrl" + } + ], + "responses": { + "200": { + "description": "The response include the detected objects in JSON format.", + "schema": { + "$ref": "#/definitions/DetectResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful DetectObjects request": { + "$ref": "./examples/SuccessfulDetectObjectsWithUrl.json" + } + } + } + }, + "/models": { + "get": { + "description": "This operation returns the list of domain-specific models that are supported by the Computer Vision API. Currently, the API supports following domain-specific models: celebrity recognizer, landmark recognizer.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", + "operationId": "ListModels", + "consumes": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "List of available domain models.", + "schema": { + "$ref": "#/definitions/ListModelsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful ListModels request": { + "$ref": "./examples/SuccessfulListModels.json" + } + } + } + }, + "/models/{model}/analyze": { + "post": { + "description": "This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON.\r\nIf the request failed, the response will contain an error code and a message to help understand what went wrong.", + "operationId": "AnalyzeImageByDomain", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "model", + "in": "path", + "description": "The domain-specific content to recognize.", + "required": true, + "type": "string", + "x-nullable": true + }, + { + "$ref": "#/parameters/ServiceLanguage" + }, + { + "$ref": "#/parameters/ImageUrl" + } + ], + "responses": { + "200": { + "description": "Analysis result based on the domain model.", + "schema": { + "$ref": "#/definitions/DomainModelResults" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful AnalyzeImageByDomain request": { + "$ref": "./examples/SuccessfulAnalyzeImageByDomainWithUrl.json" + } + } + } + }, + "/ocr": { + "post": { + "description": "Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream.\r\nUpon success, the OCR results will be returned.\r\nUpon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.", + "operationId": "RecognizePrintedText", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/DetectOrientation" + }, + { + "$ref": "#/parameters/OcrLanguage" + }, + { + "$ref": "#/parameters/ImageUrl" + } + ], + "responses": { + "200": { + "description": "The OCR results in the hierarchy of region/line/word. The results include text, bounding box for regions, lines and words. The angle, in radians, of the detected text with respect to the closest horizontal or vertical direction. After rotating the input image clockwise by this angle, the recognized text lines become horizontal or vertical. In combination with the orientation property it can be used to overlay recognition results correctly on the original image, by rotating either the original image or recognition results by a suitable angle around the center of the original image. If the angle cannot be confidently detected, this property is not present. If the image contains text at different angles, only part of the text will be recognized correctly.", + "schema": { + "$ref": "#/definitions/OcrResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful RecognizePrintedText request": { + "$ref": "./examples/SuccessfulRecognizePrintedTextWithUrl.json" + } + } + } + }, + "/tag": { + "post": { + "description": "This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag \"ascomycete\" may be accompanied by the hint \"fungus\".\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", + "operationId": "TagImage", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ServiceLanguage" + }, + { + "$ref": "#/parameters/ImageUrl" + } + ], + "responses": { + "200": { + "description": "Image tags object.", + "schema": { + "$ref": "#/definitions/TagResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful TagImage request": { + "$ref": "./examples/SuccessfulTagImageWithUrl.json" + } + } + } + }, + "/generateThumbnail": { + "post": { + "description": "This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image.\r\nA successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong.\r\nUpon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.", + "operationId": "GenerateThumbnail", + "consumes": [ + "application/json" + ], + "produces": [ + "application/octet-stream" + ], + "parameters": [ + { + "name": "width", + "in": "query", + "description": "Width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.", + "required": true, + "type": "integer", + "format": "int32", + "maximum": 1024, + "minimum": 1, + "x-nullable": false + }, + { + "name": "height", + "in": "query", + "description": "Height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.", + "required": true, + "type": "integer", + "format": "int32", + "maximum": 1024, + "minimum": 1, + "x-nullable": false + }, + { + "name": "smartCropping", + "in": "query", + "description": "Boolean flag for enabling smart cropping.", + "required": false, + "type": "boolean", + "default": false, + "x-nullable": true + }, + { + "$ref": "#/parameters/ImageUrl" + } + ], + "responses": { + "200": { + "description": "The generated thumbnail in binary format.", + "schema": { + "type": "file" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful GenerateThumbnail request": { + "$ref": "./examples/SuccessfulGenerateThumbnailWithUrl.json" + } + } + } + }, + "/areaOfInterest": { + "post": { + "description": "This operation returns a bounding box around the most important area of the image.\r\nA successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong.\r\nUpon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.", + "operationId": "GetAreaOfInterest", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ImageUrl" + } + ], + "responses": { + "200": { + "description": "The response includes the extracted area of interest in JSON format.", + "schema": { + "$ref": "#/definitions/AreaOfInterestResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetAreaOfInterest request": { + "$ref": "./examples/SuccessfulGetAreaOfInterestWithUrl.json" + } + } + } + } + }, + "definitions": { + "ImageAnalysis": { + "description": "Result of AnalyzeImage operation.", + "type": "object", + "properties": { + "categories": { + "description": "An array indicating identified categories.", + "type": "array", + "items": { + "$ref": "#/definitions/Category" + }, + "x-nullable": true + }, + "adult": { + "$ref": "#/definitions/AdultInfo", + "description": "An object describing whether the image contains adult-oriented content and/or is racy." + }, + "color": { + "$ref": "#/definitions/ColorInfo", + "description": "An object providing additional metadata describing color attributes." + }, + "imageType": { + "$ref": "#/definitions/ImageType", + "description": "An object providing possible image types and matching confidence levels." + }, + "tags": { + "description": "A list of tags with confidence level.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageTag" + }, + "x-nullable": true + }, + "description": { + "$ref": "#/definitions/ImageDescriptionDetails", + "description": "A collection of content tags, along with a list of captions sorted by confidence level, and image metadata." + }, + "faces": { + "description": "An array of possible faces within the image.", + "type": "array", + "items": { + "$ref": "#/definitions/FaceDescription" + }, + "x-nullable": true + }, + "objects": { + "description": "Array of objects describing what was detected in the image.", + "type": "array", + "items": { + "$ref": "#/definitions/DetectedObject" + }, + "x-nullable": true + }, + "brands": { + "description": "Array of brands detected in the image.", + "type": "array", + "items": { + "$ref": "#/definitions/DetectedBrand" + }, + "x-nullable": true + }, + "requestId": { + "description": "Id of the REST API request.", + "type": "string", + "x-nullable": true + }, + "metadata": { + "$ref": "#/definitions/ImageMetadata" + } + }, + "x-nullable": true + }, + "Category": { + "description": "An object describing identified category.", + "type": "object", + "properties": { + "name": { + "description": "Name of the category.", + "type": "string", + "x-nullable": true + }, + "score": { + "format": "double", + "description": "Scoring of the category.", + "type": "number", + "x-nullable": false + }, + "detail": { + "$ref": "#/definitions/CategoryDetail", + "description": "Details of the identified category." + } + }, + "x-nullable": true + }, + "AdultInfo": { + "description": "An object describing whether the image contains adult-oriented content and/or is racy.", + "type": "object", + "properties": { + "isAdultContent": { + "description": "A value indicating if the image contains adult-oriented content.", + "type": "boolean", + "x-nullable": false + }, + "isRacyContent": { + "description": "A value indicating if the image is racy.", + "type": "boolean", + "x-nullable": false + }, + "isGoryContent": { + "description": "A value indicating if the image is gory.", + "type": "boolean", + "x-nullable": false + }, + "adultScore": { + "format": "double", + "description": "Score from 0 to 1 that indicates how much the content is considered adult-oriented within the image.", + "type": "number", + "x-nullable": false + }, + "racyScore": { + "format": "double", + "description": "Score from 0 to 1 that indicates how suggestive is the image.", + "type": "number", + "x-nullable": false + }, + "goreScore": { + "format": "double", + "description": "Score from 0 to 1 that indicates how gory is the image.", + "type": "number", + "x-nullable": false + } + }, + "x-nullable": true + }, + "ColorInfo": { + "description": "An object providing additional metadata describing color attributes.", + "type": "object", + "properties": { + "dominantColorForeground": { + "description": "Possible dominant foreground color.", + "type": "string", + "x-nullable": true + }, + "dominantColorBackground": { + "description": "Possible dominant background color.", + "type": "string", + "x-nullable": true + }, + "dominantColors": { + "description": "An array of possible dominant colors.", + "type": "array", + "items": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "accentColor": { + "description": "Possible accent color.", + "type": "string", + "x-nullable": true + }, + "isBWImg": { + "description": "A value indicating if the image is black and white.", + "type": "boolean", + "x-nullable": false + } + }, + "x-nullable": true + }, + "ImageType": { + "description": "An object providing possible image types and matching confidence levels.", + "type": "object", + "properties": { + "clipArtType": { + "format": "int32", + "description": "Confidence level that the image is a clip art.", + "type": "integer", + "x-nullable": false + }, + "lineDrawingType": { + "format": "int32", + "description": "Confidence level that the image is a line drawing.", + "type": "integer", + "x-nullable": false + } + }, + "x-nullable": true + }, + "ImageTag": { + "description": "An entity observation in the image, along with the confidence score.", + "type": "object", + "properties": { + "name": { + "description": "Name of the entity.", + "type": "string", + "x-nullable": true + }, + "confidence": { + "format": "double", + "description": "The level of confidence that the entity was observed.", + "type": "number", + "x-nullable": false + }, + "hint": { + "description": "Optional hint/details for this tag.", + "type": "string", + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageDescriptionDetails": { + "description": "A collection of content tags, along with a list of captions sorted by confidence level, and image metadata.", + "type": "object", + "properties": { + "tags": { + "description": "A collection of image tags.", + "type": "array", + "items": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "captions": { + "description": "A list of captions, sorted by confidence level.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageCaption" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "FaceDescription": { + "description": "An object describing a face identified in the image.", + "type": "object", + "properties": { + "age": { + "format": "int32", + "description": "Possible age of the face.", + "type": "integer", + "x-nullable": false + }, + "gender": { + "description": "Possible gender of the face.", + "enum": [ + "Male", + "Female" + ], + "type": "string", + "x-ms-enum": { + "name": "Gender", + "modelAsString": false + }, + "x-nullable": true + }, + "faceRectangle": { + "$ref": "#/definitions/FaceRectangle", + "description": "Rectangle in the image containing the identified face." + } + }, + "x-nullable": true + }, + "DetectedObject": { + "description": "An object detected in an image.", + "type": "object", + "properties": { + "rectangle": { + "$ref": "#/definitions/BoundingRect", + "description": "Approximate location of the detected object.", + "readOnly": true + }, + "object": { + "description": "Label for the object.", + "type": "string", + "x-nullable": true + }, + "confidence": { + "format": "double", + "description": "Confidence score of having observed the object in the image, as a value ranging from 0 to 1.", + "type": "number", + "x-nullable": false + }, + "parent": { + "$ref": "#/definitions/ObjectHierarchy", + "description": "The parent object, from a taxonomy perspective.\r\nThe parent object is a more generic form of this object. For example, a 'bulldog' would have a parent of 'dog'." + } + }, + "x-nullable": true + }, + "DetectedBrand": { + "description": "A brand detected in an image.", + "type": "object", + "properties": { + "name": { + "description": "Label for the brand.", + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "confidence": { + "format": "double", + "description": "Confidence score of having observed the brand in the image, as a value ranging from 0 to 1.", + "type": "number", + "readOnly": true, + "x-nullable": false + }, + "rectangle": { + "$ref": "#/definitions/BoundingRect", + "description": "Approximate location of the detected brand.", + "readOnly": true + } + }, + "x-nullable": true + }, + "ImageMetadata": { + "description": "Image metadata.", + "type": "object", + "properties": { + "width": { + "format": "int32", + "description": "Image width, in pixels.", + "type": "integer", + "x-nullable": false + }, + "height": { + "format": "int32", + "description": "Image height, in pixels.", + "type": "integer", + "x-nullable": false + }, + "format": { + "description": "Image format.", + "type": "string", + "x-nullable": true + } + }, + "x-nullable": true + }, + "CategoryDetail": { + "description": "An object describing additional category details.", + "type": "object", + "properties": { + "celebrities": { + "description": "An array of celebrities if any identified.", + "type": "array", + "items": { + "$ref": "#/definitions/CelebritiesModel" + }, + "x-nullable": true + }, + "landmarks": { + "description": "An array of landmarks if any identified.", + "type": "array", + "items": { + "$ref": "#/definitions/LandmarksModel" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageCaption": { + "description": "An image caption, i.e. a brief description of what the image depicts.", + "type": "object", + "properties": { + "text": { + "description": "The text of the caption.", + "type": "string", + "x-nullable": true + }, + "confidence": { + "format": "double", + "description": "The level of confidence the service has in the caption.", + "type": "number", + "x-nullable": false + } + }, + "x-nullable": true + }, + "FaceRectangle": { + "description": "An object describing face rectangle.", + "type": "object", + "properties": { + "left": { + "format": "int32", + "description": "X-coordinate of the top left point of the face, in pixels.", + "type": "integer", + "x-nullable": false + }, + "top": { + "format": "int32", + "description": "Y-coordinate of the top left point of the face, in pixels.", + "type": "integer", + "x-nullable": false + }, + "width": { + "format": "int32", + "description": "Width measured from the top-left point of the face, in pixels.", + "type": "integer", + "x-nullable": false + }, + "height": { + "format": "int32", + "description": "Height measured from the top-left point of the face, in pixels.", + "type": "integer", + "x-nullable": false + } + }, + "x-nullable": true + }, + "BoundingRect": { + "description": "A bounding box for an area inside an image.", + "type": "object", + "properties": { + "x": { + "format": "int32", + "description": "X-coordinate of the top left point of the area, in pixels.", + "type": "integer", + "x-nullable": false + }, + "y": { + "format": "int32", + "description": "Y-coordinate of the top left point of the area, in pixels.", + "type": "integer", + "x-nullable": false + }, + "w": { + "format": "int32", + "description": "Width measured from the top-left point of the area, in pixels.", + "type": "integer", + "x-nullable": false + }, + "h": { + "format": "int32", + "description": "Height measured from the top-left point of the area, in pixels.", + "type": "integer", + "x-nullable": false + } + }, + "x-nullable": false + }, + "ObjectHierarchy": { + "description": "An object detected inside an image.", + "type": "object", + "properties": { + "object": { + "description": "Label for the object.", + "type": "string", + "x-nullable": true + }, + "confidence": { + "format": "double", + "description": "Confidence score of having observed the object in the image, as a value ranging from 0 to 1.", + "type": "number", + "x-nullable": false + }, + "parent": { + "$ref": "#/definitions/ObjectHierarchy", + "description": "The parent object, from a taxonomy perspective.\r\nThe parent object is a more generic form of this object. For example, a 'bulldog' would have a parent of 'dog'." + } + }, + "x-nullable": true + }, + "CelebritiesModel": { + "description": "An object describing possible celebrity identification.", + "type": "object", + "properties": { + "name": { + "description": "Name of the celebrity.", + "type": "string", + "x-nullable": true + }, + "confidence": { + "format": "double", + "description": "Confidence level for the celebrity recognition as a value ranging from 0 to 1.", + "type": "number", + "x-nullable": false + }, + "faceRectangle": { + "$ref": "#/definitions/FaceRectangle", + "description": "Location of the identified face in the image." + } + }, + "x-nullable": true + }, + "LandmarksModel": { + "description": "A landmark recognized in the image.", + "type": "object", + "properties": { + "name": { + "description": "Name of the landmark.", + "type": "string", + "x-nullable": true + }, + "confidence": { + "format": "double", + "description": "Confidence level for the landmark recognition as a value ranging from 0 to 1.", + "type": "number", + "x-nullable": false + } + }, + "x-nullable": true + }, + "ImageDescription": { + "description": "A collection of content tags, along with a list of captions sorted by confidence level, and image metadata.", + "type": "object", + "properties": { + "description": { + "$ref": "#/definitions/ImageDescriptionDetails", + "description": "A collection of content tags, along with a list of captions sorted by confidence level, and image metadata.", + "x-ms-client-flatten": true + }, + "requestId": { + "description": "Id of the REST API request.", + "type": "string", + "x-nullable": true + }, + "metadata": { + "$ref": "#/definitions/ImageMetadata" + } + }, + "x-nullable": true + }, + "DetectResult": { + "description": "Result of a DetectImage call.", + "type": "object", + "properties": { + "objects": { + "description": "An array of detected objects.", + "type": "array", + "items": { + "$ref": "#/definitions/DetectedObject" + }, + "readOnly": true, + "x-nullable": true + }, + "requestId": { + "description": "Id of the REST API request.", + "type": "string", + "x-nullable": true + }, + "metadata": { + "$ref": "#/definitions/ImageMetadata" + } + }, + "x-nullable": true + }, + "ListModelsResult": { + "description": "Result of the List Domain Models operation.", + "type": "object", + "properties": { + "models": { + "description": "An array of supported models.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelDescription" + }, + "readOnly": true, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ModelDescription": { + "description": "An object describing supported model by name and categories.", + "type": "object", + "properties": { + "name": { + "description": "The name of the model.", + "type": "string", + "x-nullable": true + }, + "categories": { + "description": "Categories of the model.", + "type": "array", + "items": { + "type": "string", + "x-nullable": true + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "DomainModelResults": { + "description": "Result of image analysis using a specific domain model including additional metadata.", + "type": "object", + "properties": { + "result": { + "description": "Model-specific response.", + "type": "object", + "x-ms-client-flatten": true + }, + "requestId": { + "description": "Id of the REST API request.", + "type": "string", + "x-nullable": true + }, + "metadata": { + "$ref": "#/definitions/ImageMetadata" + } + }, + "x-nullable": true + }, + "OcrResult": { + "type": "object", + "properties": { + "language": { + "description": "The BCP-47 language code of the text in the image.", + "type": "string", + "x-nullable": true + }, + "textAngle": { + "format": "double", + "description": "The angle, in radians, of the detected text with respect to the closest horizontal or vertical direction. After rotating the input image clockwise by this angle, the recognized text lines become horizontal or vertical. In combination with the orientation property it can be used to overlay recognition results correctly on the original image, by rotating either the original image or recognition results by a suitable angle around the center of the original image. If the angle cannot be confidently detected, this property is not present. If the image contains text at different angles, only part of the text will be recognized correctly.", + "type": "number", + "x-nullable": false + }, + "orientation": { + "description": "Orientation of the text recognized in the image, if requested. The value (up, down, left, or right) refers to the direction that the top of the recognized text is facing, after the image has been rotated around its center according to the detected text angle (see textAngle property).\r\nIf detection of the orientation was not requested, or no text is detected, the value is 'NotDetected'.", + "type": "string", + "x-nullable": true + }, + "regions": { + "description": "An array of objects, where each object represents a region of recognized text.", + "type": "array", + "items": { + "$ref": "#/definitions/OcrRegion" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "OcrRegion": { + "description": "A region consists of multiple lines (e.g. a column of text in a multi-column document).", + "type": "object", + "properties": { + "boundingBox": { + "description": "Bounding box of a recognized region. The four integers represent the x-coordinate of the left edge, the y-coordinate of the top edge, width, and height of the bounding box, in the coordinate system of the input image, after it has been rotated around its center according to the detected text angle (see textAngle property), with the origin at the top-left corner, and the y-axis pointing down.", + "type": "string", + "x-nullable": true + }, + "lines": { + "description": "An array of recognized lines of text.", + "type": "array", + "items": { + "$ref": "#/definitions/OcrLine" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "OcrLine": { + "description": "An object describing a single recognized line of text.", + "type": "object", + "properties": { + "boundingBox": { + "description": "Bounding box of a recognized line. The four integers represent the x-coordinate of the left edge, the y-coordinate of the top edge, width, and height of the bounding box, in the coordinate system of the input image, after it has been rotated around its center according to the detected text angle (see textAngle property), with the origin at the top-left corner, and the y-axis pointing down.", + "type": "string", + "x-nullable": true + }, + "words": { + "description": "An array of objects, where each object represents a recognized word.", + "type": "array", + "items": { + "$ref": "#/definitions/OcrWord" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "OcrWord": { + "description": "Information on a recognized word.", + "type": "object", + "properties": { + "boundingBox": { + "description": "Bounding box of a recognized word. The four integers represent the x-coordinate of the left edge, the y-coordinate of the top edge, width, and height of the bounding box, in the coordinate system of the input image, after it has been rotated around its center according to the detected text angle (see textAngle property), with the origin at the top-left corner, and the y-axis pointing down.", + "type": "string", + "x-nullable": true + }, + "text": { + "description": "String value of a recognized word.", + "type": "string", + "x-nullable": true + } + }, + "x-nullable": true + }, + "TagResult": { + "description": "The results of a image tag operation, including any tags and image metadata.", + "type": "object", + "properties": { + "tags": { + "description": "A list of tags with confidence level.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageTag" + }, + "x-nullable": true + }, + "requestId": { + "description": "Id of the REST API request.", + "type": "string", + "x-nullable": true + }, + "metadata": { + "$ref": "#/definitions/ImageMetadata" + } + }, + "x-nullable": true + }, + "AreaOfInterestResult": { + "description": "Result of AreaOfInterest operation.", + "type": "object", + "properties": { + "areaOfInterest": { + "$ref": "#/definitions/BoundingRect", + "description": "A bounding box for an area of interest inside an image.", + "readOnly": true + }, + "requestId": { + "description": "Id of the REST API request.", + "type": "string", + "x-nullable": true + }, + "metadata": { + "$ref": "#/definitions/ImageMetadata" + } + }, + "x-nullable": true + }, + "ImageUrl": { + "required": [ + "url" + ], + "type": "object", + "properties": { + "url": { + "description": "Publicly reachable URL of an image.", + "type": "string" + } + } + }, + "ComputerVisionError": { + "description": "Details about the API request error.", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "enum": [ + "InvalidImageFormat", + "UnsupportedMediaType", + "InvalidImageUrl", + "NotSupportedFeature", + "NotSupportedImage", + "Timeout", + "InternalServerError", + "InvalidImageSize", + "BadArgument", + "DetectFaceError", + "NotSupportedLanguage", + "InvalidThumbnailSize", + "InvalidDetails", + "InvalidModel", + "CancelledRequest", + "NotSupportedVisualFeature", + "FailedToProcess", + "Unspecified", + "StorageException" + ], + "x-ms-enum": { + "name": "ComputerVisionErrorCodes", + "modelAsString": true + } + }, + "message": { + "description": "A message explaining the error reported by the service.", + "type": "string" + }, + "requestId": { + "description": "A unique request identifier.", + "type": "string" + } + } + }, + "LandmarkResults": { + "description": "Result of domain-specific classifications for the domain of landmarks.", + "type": "object", + "properties": { + "landmarks": { + "description": "List of landmarks recognized in the image.", + "type": "array", + "items": { + "$ref": "#/definitions/LandmarksModel" + }, + "x-nullable": true + }, + "requestId": { + "description": "Id of the REST API request.", + "type": "string", + "x-nullable": true + }, + "metadata": { + "$ref": "#/definitions/ImageMetadata" + } + }, + "x-nullable": true + }, + "CelebrityResults": { + "description": "Result of domain-specific classifications for the domain of celebrities.", + "type": "object", + "properties": { + "celebrities": { + "description": "List of celebrities recognized in the image.", + "type": "array", + "items": { + "$ref": "#/definitions/CelebritiesModel" + }, + "x-nullable": true + }, + "requestId": { + "description": "Id of the REST API request.", + "type": "string", + "x-nullable": true + }, + "metadata": { + "$ref": "#/definitions/ImageMetadata" + } + }, + "x-nullable": true + } + }, + "parameters": { + "Endpoint": { + "name": "Endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoints.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "x-ms-skip-url-encoding": true + }, + "ImageStream": { + "name": "Image", + "in": "body", + "description": "An image stream.", + "required": true, + "schema": { + "format": "file", + "type": "object" + }, + "x-ms-parameter-location": "method" + }, + "ImageUrl": { + "name": "ImageUrl", + "in": "body", + "description": "A JSON document with a URL pointing to the image that is to be analyzed.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUrl" + }, + "x-ms-parameter-location": "method", + "x-ms-client-flatten": true + }, + "ServiceLanguage": { + "name": "language", + "in": "query", + "description": "The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.", + "required": false, + "type": "string", + "default": "en", + "enum": [ + "en", + "es", + "ja", + "pt", + "zh" + ], + "x-ms-parameter-location": "method", + "x-nullable": false + }, + "DescriptionExclude": { + "name": "descriptionExclude", + "in": "query", + "description": "Turn off specified domain models when generating the description.", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "Celebrities", + "Landmarks" + ], + "x-nullable": false, + "x-ms-enum": { + "name": "DescriptionExclude", + "modelAsString": false + } + }, + "collectionFormat": "csv", + "x-nullable": true, + "x-ms-parameter-location": "method" + }, + "OcrLanguage": { + "name": "language", + "in": "query", + "description": "The BCP-47 language code of the text to be detected in the image. The default value is 'unk'.", + "required": false, + "type": "string", + "default": "unk", + "enum": [ + "unk", + "zh-Hans", + "zh-Hant", + "cs", + "da", + "nl", + "en", + "fi", + "fr", + "de", + "el", + "hu", + "it", + "ja", + "ko", + "nb", + "pl", + "pt", + "ru", + "es", + "sv", + "tr", + "ar", + "ro", + "sr-Cyrl", + "sr-Latn", + "sk" + ], + "x-ms-parameter-location": "method", + "x-nullable": false, + "x-ms-enum": { + "name": "OcrLanguages", + "modelAsString": false + } + }, + "VisualFeatures": { + "name": "visualFeatures", + "in": "query", + "description": "A string indicating what visual feature types to return. Multiple values should be comma-separated. Valid visual feature types include: Categories - categorizes image content according to a taxonomy defined in documentation. Tags - tags the image with a detailed list of words related to the image content. Description - describes the image content with a complete English sentence. Faces - detects if faces are present. If present, generate coordinates, gender and age. ImageType - detects if image is clipart or a line drawing. Color - determines the accent color, dominant color, and whether an image is black&white. Adult - detects if the image is pornographic in nature (depicts nudity or a sex act), or is gory (depicts extreme violence or blood). Sexually suggestive content (aka racy content) is also detected. Objects - detects various objects within an image, including the approximate location. The Objects argument is only available in English. Brands - detects various brands within an image, including the approximate location. The Brands argument is only available in English.", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "ImageType", + "Faces", + "Adult", + "Categories", + "Color", + "Tags", + "Description", + "Objects", + "Brands" + ], + "x-nullable": false, + "x-ms-enum": { + "name": "VisualFeatureTypes", + "modelAsString": false + } + }, + "collectionFormat": "csv", + "x-ms-parameter-location": "method" + }, + "DetectOrientation": { + "name": "detectOrientation", + "in": "query", + "description": "Whether detect the text orientation in the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it's upside-down).", + "required": true, + "type": "boolean", + "default": true, + "x-ms-parameter-location": "method" + } + }, + "x-ms-paths": { + "/analyze?overload=stream": { + "post": { + "description": "This operation extracts a rich set of visual features based on the image content.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", + "operationId": "AnalyzeImageInStream", + "consumes": [ + "application/octet-stream", + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/VisualFeatures" + }, + { + "name": "details", + "in": "query", + "description": "A string indicating which domain-specific details to return. Multiple values should be comma-separated. Valid visual feature types include: Celebrities - identifies celebrities if detected in the image, Landmarks - identifies notable landmarks in the image.", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "Celebrities", + "Landmarks" + ], + "x-nullable": false, + "x-ms-enum": { + "name": "Details", + "modelAsString": false + } + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "$ref": "#/parameters/ServiceLanguage" + }, + { + "$ref": "#/parameters/DescriptionExclude" + }, + { + "$ref": "#/parameters/ImageStream" + } + ], + "responses": { + "200": { + "description": "The response include the extracted features in JSON format. Here is the definitions for enumeration types:\r\n ClipartType\r\n Non - clipart = 0, ambiguous = 1, normal - clipart = 2, good - clipart = 3. LineDrawingTypeNon - LineDrawing = 0, LineDrawing = 1.", + "schema": { + "$ref": "#/definitions/ImageAnalysis" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful AnalyzeImage request": { + "$ref": "./examples/SuccessfulAnalyzeImageWithStream.json" + } + } + } + }, + "/areaOfInterest?overload=stream": { + "post": { + "description": "This operation returns a bounding box around the most important area of the image.\r\nA successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong.\r\nUpon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.", + "operationId": "GetAreaOfInterestInStream", + "consumes": [ + "application/octet-stream", + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ImageStream" + } + ], + "responses": { + "200": { + "description": "The response includes the extracted area of interest in JSON format.", + "schema": { + "$ref": "#/definitions/AreaOfInterestResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetAreaOfInterest request": { + "$ref": "./examples/SuccessfulGetAreaOfInterestWithStream.json" + } + } + } + }, + "/describe?overload=stream": { + "post": { + "description": "This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. Descriptions may include results from celebrity and landmark domain models, if applicable.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", + "operationId": "DescribeImageInStream", + "consumes": [ + "application/octet-stream", + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "maxCandidates", + "in": "query", + "description": "Maximum number of candidate descriptions to be returned. The default is 1.", + "required": false, + "type": "integer", + "format": "int32", + "default": 1, + "x-nullable": true + }, + { + "$ref": "#/parameters/ServiceLanguage" + }, + { + "$ref": "#/parameters/DescriptionExclude" + }, + { + "$ref": "#/parameters/ImageStream" + } + ], + "responses": { + "200": { + "description": "Image description object.", + "schema": { + "$ref": "#/definitions/ImageDescription" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful DescribeImage request": { + "$ref": "./examples/SuccessfulDescribeImageWithStream.json" + } + } + } + }, + "/detect?overload=stream": { + "post": { + "description": "Performs object detection on the specified image.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", + "operationId": "DetectObjectsInStream", + "consumes": [ + "application/octet-stream", + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ImageStream" + } + ], + "responses": { + "200": { + "description": "The response include the detected objects in JSON format.", + "schema": { + "$ref": "#/definitions/DetectResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful DetectObjects request": { + "$ref": "./examples/SuccessfulDetectObjectsWithStream.json" + } + } + } + }, + "/generateThumbnail?overload=stream": { + "post": { + "description": "This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image.\r\nA successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong.\r\nUpon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.", + "operationId": "GenerateThumbnailInStream", + "consumes": [ + "application/octet-stream", + "multipart/form-data" + ], + "produces": [ + "application/octet-stream" + ], + "parameters": [ + { + "name": "width", + "in": "query", + "description": "Width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.", + "required": true, + "type": "integer", + "format": "int32", + "maximum": 1024, + "minimum": 1, + "x-nullable": false + }, + { + "name": "height", + "in": "query", + "description": "Height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.", + "required": true, + "type": "integer", + "format": "int32", + "maximum": 1024, + "minimum": 1, + "x-nullable": false + }, + { + "name": "smartCropping", + "in": "query", + "description": "Boolean flag for enabling smart cropping.", + "required": false, + "type": "boolean", + "default": false, + "x-nullable": true + }, + { + "$ref": "#/parameters/ImageStream" + } + ], + "responses": { + "200": { + "description": "The generated thumbnail in binary format.", + "schema": { + "type": "file" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful GenerateThumbnail request": { + "$ref": "./examples/SuccessfulGenerateThumbnailWithStream.json" + } + } + } + }, + "/models/{model}/analyze?overload=stream": { + "post": { + "description": "This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON.\r\nIf the request failed, the response will contain an error code and a message to help understand what went wrong.", + "operationId": "AnalyzeImageByDomainInStream", + "consumes": [ + "application/octet-stream", + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "model", + "in": "path", + "description": "The domain-specific content to recognize.", + "required": true, + "type": "string", + "x-nullable": true + }, + { + "$ref": "#/parameters/ServiceLanguage" + }, + { + "$ref": "#/parameters/ImageStream" + } + ], + "responses": { + "200": { + "description": "Analysis result based on the domain model.", + "schema": { + "$ref": "#/definitions/DomainModelResults" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful AnalyzeImageByDomain request": { + "$ref": "./examples/SuccessfulAnalyzeImageByDomainWithStream.json" + } + } + } + }, + "/ocr?overload=stream": { + "post": { + "description": "Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream.\r\nUpon success, the OCR results will be returned.\r\nUpon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.", + "operationId": "RecognizePrintedTextInStream", + "consumes": [ + "application/octet-stream", + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/DetectOrientation" + }, + { + "$ref": "#/parameters/OcrLanguage" + }, + { + "$ref": "#/parameters/ImageStream" + } + ], + "responses": { + "200": { + "description": "The OCR results in the hierarchy of region/line/word. The results include text, bounding box for regions, lines and words. The angle, in radians, of the detected text with respect to the closest horizontal or vertical direction. After rotating the input image clockwise by this angle, the recognized text lines become horizontal or vertical. In combination with the orientation property it can be used to overlay recognition results correctly on the original image, by rotating either the original image or recognition results by a suitable angle around the center of the original image. If the angle cannot be confidently detected, this property is not present. If the image contains text at different angles, only part of the text will be recognized correctly.", + "schema": { + "$ref": "#/definitions/OcrResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful RecognizePrintedText request": { + "$ref": "./examples/SuccessfulRecognizePrintedTextWithStream.json" + } + } + } + }, + "/tag?overload=stream": { + "post": { + "description": "This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag \"ascomycete\" may be accompanied by the hint \"fungus\".\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", + "operationId": "TagImageInStream", + "consumes": [ + "application/octet-stream", + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ServiceLanguage" + }, + { + "$ref": "#/parameters/ImageStream" + } + ], + "responses": { + "200": { + "description": "Image tags object.", + "schema": { + "$ref": "#/definitions/TagResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful TagImage request": { + "$ref": "./examples/SuccessfulTagImageWithStream.json" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/Ocr.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/Ocr.json new file mode 100644 index 000000000000..9d0e2df9700a --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/Ocr.json @@ -0,0 +1,452 @@ +{ + "swagger": "2.0", + "info": { + "version": "3.1", + "title": "Computer Vision Client", + "description": "The Computer Vision API provides state-of-the-art algorithms to process images and return information. For example, it can be used to determine if an image contains mature content, or it can be used to find all the faces in an image. It also has other features like estimating dominant and accent colors, categorizing the content of images, and describing an image with complete English sentences. Additionally, it can also intelligently generate images thumbnails for displaying large images effectively." + }, + "securityDefinitions": { + "apim_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "host": "westcentralus.api.cognitive.microsoft.com", + "basePath": "/vision/v3.1", + "schemes": [ + "https" + ], + "paths": { + "/read/analyze": { + "post": { + "description": "Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadResult' operation to access OCR results.​", + "operationId": "Read", + "parameters": [ + { + "$ref": "#/parameters/OcrDetectionLanguage" + }, + { + "$ref": "#/parameters/ImageUrl" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "The service has accepted the request and will start processing later.", + "headers": { + "Operation-Location": { + "description": "URL to query for status of the operation. The operation ID will expire in 48 hours. ", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful Analyze request": { + "$ref": "./examples/SuccessfulReadWithUrl.json" + } + } + } + }, + "/read/analyzeResults/{operationId}": { + "get": { + "description": "This interface is used for getting OCR results of Read operation. The URL to this interface should be retrieved from 'Operation-Location' field returned from Read interface.", + "operationId": "GetReadResult", + "parameters": [ + { + "name": "operationId", + "in": "path", + "description": "Id of read operation returned in the response of the 'Read' interface.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Returns the read operation status.", + "schema": { + "$ref": "#/definitions/ReadOperationResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful Get Read Result request": { + "$ref": "./examples/SuccessfulGetReadResult.json" + } + } + } + } + }, + "x-ms-paths": { + "/read/analyze?overload=stream": { + "post": { + "description": "Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadResult' operation to access OCR results.​", + "operationId": "ReadInStream", + "parameters": [ + { + "$ref": "#/parameters/OcrDetectionLanguage" + }, + { + "$ref": "#/parameters/ImageStream" + } + ], + "consumes": [ + "application/octet-stream" + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "The service has accepted the request and will start processing later.", + "headers": { + "Operation-Location": { + "description": "URL to query for status of the operation. The operation ID will expire in 48 hours. ", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful Analyze request": { + "$ref": "./examples/SuccessfulReadWithStream.json" + } + } + } + } + }, + "definitions": { + "ReadOperationResult": { + "type": "object", + "description": "OCR result of the read operation.", + "properties": { + "status": { + "description": "Status of the read operation.", + "$ref": "#/definitions/OperationStatus" + }, + "createdDateTime": { + "type": "string", + "description": "Get UTC date time the batch operation was submitted.", + "x-nullable": false + }, + "lastUpdatedDateTime": { + "type": "string", + "description": "Get last updated UTC date time of this batch operation.", + "x-nullable": false + }, + "analyzeResult": { + "description": "Analyze batch operation result.", + "type": "object", + "$ref": "#/definitions/analyzeResults" + } + } + }, + "OperationStatus": { + "type": "string", + "description": "Status code of the text operation.", + "enum": [ + "notStarted", + "running", + "failed", + "succeeded" + ], + "x-ms-enum": { + "name": "OperationStatusCodes", + "modelAsString": false + }, + "x-nullable": false + }, + "ReadResult": { + "description": "Text extracted from a page in the input document.", + "type": "object", + "required": [ + "page", + "angle", + "width", + "height", + "unit", + "lines" + ], + "properties": { + "page": { + "description": "The 1-based page number of the recognition result.", + "type": "integer" + }, + "language": { + "description": "The BCP-47 language code of the recognized text page.", + "type": "string" + }, + "angle": { + "description": "The orientation of the image in degrees in the clockwise direction. Range between [-180, 180).", + "type": "number" + }, + "width": { + "description": "The width of the image in pixels or the PDF in inches.", + "type": "number" + }, + "height": { + "description": "The height of the image in pixels or the PDF in inches.", + "type": "number" + }, + "unit": { + "description": "The unit used in the Width, Height and BoundingBox. For images, the unit is 'pixel'. For PDF, the unit is 'inch'.", + "type": "string", + "enum": [ + "pixel", + "inch" + ], + "x-ms-enum": { + "name": "TextRecognitionResultDimensionUnit", + "modelAsString": false + }, + "x-nullable": false + }, + "lines": { + "description": "A list of recognized text lines.", + "type": "array", + "items": { + "$ref": "#/definitions/Line" + } + } + } + }, + "analyzeResults": { + "description": "Analyze batch operation result.", + "type": "object", + "required": [ + "version", + "readResults" + ], + "properties": { + "version": { + "description": "Version of schema used for this result.", + "type": "string" + }, + "readResults": { + "description": "Text extracted from the input.", + "type": "array", + "items": { + "$ref": "#/definitions/ReadResult" + } + } + } + }, + "Line": { + "description": "An object representing a recognized text line.", + "type": "object", + "required": [ + "boundingBox", + "text", + "words" + ], + "properties": { + "language": { + "description": "The BCP-47 language code of the recognized text line. Only provided where the language of the line differs from the page's.", + "type": "string" + }, + "boundingBox": { + "description": "Bounding box of a recognized line.", + "$ref": "#/definitions/BoundingBox" + }, + "text": { + "description": "The text content of the line.", + "type": "string" + }, + "words": { + "description": "List of words in the text line.", + "type": "array", + "items": { + "$ref": "#/definitions/Word" + } + } + } + }, + "Word": { + "description": "An object representing a recognized word.", + "type": "object", + "required": [ + "boundingBox", + "text", + "confidence" + ], + "properties": { + "boundingBox": { + "description": "Bounding box of a recognized word.", + "$ref": "#/definitions/BoundingBox" + }, + "text": { + "description": "The text content of the word.", + "type": "string" + }, + "confidence": { + "description": "Qualitative confidence measure.", + "type": "number", + "format": "float" + } + } + }, + "BoundingBox": { + "description": "Quadrangle bounding box, with coordinates in original image. The eight numbers represent the four points (x-coordinate, y-coordinate from the left-top corner of the image) of the detected rectangle from the left-top corner in the clockwise direction. For images, coordinates are in pixels. For PDF, coordinates are in inches.", + "type": "array", + "items": { + "type": "number", + "x-nullable": false + } + }, + "ComputerVisionError": { + "description": "Details about the API request error.", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "enum": [ + "InvalidImageFormat", + "UnsupportedMediaType", + "InvalidImageUrl", + "NotSupportedFeature", + "NotSupportedImage", + "Timeout", + "InternalServerError", + "InvalidImageSize", + "BadArgument", + "DetectFaceError", + "NotSupportedLanguage", + "InvalidThumbnailSize", + "InvalidDetails", + "InvalidModel", + "CancelledRequest", + "NotSupportedVisualFeature", + "FailedToProcess", + "Unspecified", + "StorageException" + ], + "x-ms-enum": { + "name": "ComputerVisionErrorCodes", + "modelAsString": true + } + }, + "message": { + "description": "A message explaining the error reported by the service.", + "type": "string" + }, + "requestId": { + "description": "A unique request identifier.", + "type": "string" + } + } + }, + "ImageUrl": { + "type": "object", + "required": [ + "url" + ], + "properties": { + "url": { + "description": "Publicly reachable URL of an image.", + "type": "string" + } + } + } + }, + "parameters": { + "OcrDetectionLanguage": { + "name": "language", + "in": "query", + "description": "The BCP-47 language code of the text in the document. Currently, only English ('en'), Dutch (‘nl’), French (‘fr’), German (‘de’), Italian (‘it’), Portuguese (‘pt), and Spanish ('es') are supported. Read supports auto language identification and multi-language documents, so only provide a language code if you would like to force the documented to be processed as that specific language.", + "required": false, + "default": "en", + "x-ms-parameter-location": "method", + "type": "string", + "x-ms-enum": { + "name": "OcrDetectionLanguage", + "modelAsString": true + }, + "enum": [ + "en", + "es", + "fr", + "de", + "it", + "nl", + "pt" + ] + }, + "ImageUrl": { + "name": "ImageUrl", + "in": "body", + "required": true, + "x-ms-parameter-location": "method", + "x-ms-client-flatten": true, + "description": "A JSON document with a URL pointing to the image that is to be analyzed.", + "schema": { + "$ref": "#/definitions/ImageUrl" + } + }, + "ImageStream": { + "name": "Image", + "in": "body", + "required": true, + "x-ms-parameter-location": "method", + "description": "An image stream.", + "schema": { + "type": "object", + "format": "file" + } + }, + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoints.", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageByDomainWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageByDomainWithStream.json new file mode 100644 index 000000000000..a3cd00555cc6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageByDomainWithStream.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "model": "Celebrities", + "Image": "{binary}" + }, + "responses": { + "200": { + "body": { + "requestId": "f0027b4b-dc0d-4082-9228-1545ed246b03", + "metadata": { + "width": 1500, + "height": 1000, + "format": "Jpeg" + }, + "result": { + "celebrities": [ + { + "name": "Satya Nadella", + "faceRectangle": { + "left": 597, + "top": 162, + "width": 248, + "height": 248 + }, + "confidence": 0.999028444 + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageByDomainWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageByDomainWithUrl.json new file mode 100644 index 000000000000..92ead72b5f8f --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageByDomainWithUrl.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "model": "Celebrities", + "ImageUrl": { + "url": "{url}" + } + }, + "responses": { + "200": { + "body": { + "requestId": "f0027b4b-dc0d-4082-9228-1545ed246b03", + "metadata": { + "width": 1500, + "height": 1000, + "format": "Jpeg" + }, + "result": { + "celebrities": [ + { + "name": "Satya Nadella", + "faceRectangle": { + "left": 597, + "top": 162, + "width": 248, + "height": 248 + }, + "confidence": 0.999028444 + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageWithStream.json new file mode 100644 index 000000000000..ba86791a7e36 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageWithStream.json @@ -0,0 +1,176 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "visualFeatures": [ + "Categories", + "Adult", + "Tags", + "Description", + "Faces", + "Color", + "ImageType", + "Objects", + "Brands" + ], + "details": [ + "Celebrities", + "Landmarks" + ], + "language": "en", + "Image": "{binary}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "categories": [ + { + "name": "abstract_", + "score": 0.00390625 + }, + { + "name": "people_", + "score": 0.83984375, + "detail": { + "celebrities": [ + { + "name": "Satya Nadella", + "faceRectangle": { + "left": 597, + "top": 162, + "width": 248, + "height": 248 + }, + "confidence": 0.999028444 + } + ], + "landmarks": [ + { + "name": "Forbidden City", + "confidence": 0.9978346 + } + ] + } + } + ], + "adult": { + "isAdultContent": false, + "isRacyContent": false, + "isGoryContent": false, + "adultScore": 0.0934349000453949, + "racyScore": 0.068613491952419281, + "goreScore": 0.012872257380997575 + }, + "tags": [ + { + "name": "person", + "confidence": 0.98979085683822632 + }, + { + "name": "man", + "confidence": 0.94493889808654785 + }, + { + "name": "outdoor", + "confidence": 0.938492476940155 + }, + { + "name": "window", + "confidence": 0.89513939619064331 + }, + { + "name": "pangolin", + "confidence": 0.7250059783791661, + "hint": "mammal" + } + ], + "description": { + "tags": [ + "person", + "man", + "outdoor", + "window", + "glasses" + ], + "captions": [ + { + "text": "Satya Nadella sitting on a bench", + "confidence": 0.48293603002174407 + } + ] + }, + "requestId": "0dbec5ad-a3d3-4f7e-96b4-dfd57efe967d", + "metadata": { + "width": 1500, + "height": 1000, + "format": "Jpeg" + }, + "faces": [ + { + "age": 44, + "gender": "Male", + "faceRectangle": { + "left": 593, + "top": 160, + "width": 250, + "height": 250 + } + } + ], + "color": { + "dominantColorForeground": "Brown", + "dominantColorBackground": "Brown", + "dominantColors": [ + "Brown", + "Black" + ], + "accentColor": "873B59", + "isBWImg": false + }, + "imageType": { + "clipArtType": 0, + "lineDrawingType": 0 + }, + "objects": [ + { + "rectangle": { + "x": 0, + "y": 0, + "w": 50, + "h": 50 + }, + "object": "tree", + "confidence": 0.9, + "parent": { + "object": "plant", + "confidence": 0.95 + } + } + ], + "brands": [ + { + "name": "Pepsi", + "confidence": 0.857, + "rectangle": { + "x": 489, + "y": 79, + "w": 161, + "h": 177 + } + }, + { + "name": "Coca-Cola", + "confidence": 0.893, + "rectangle": { + "x": 216, + "y": 55, + "w": 171, + "h": 372 + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageWithUrl.json new file mode 100644 index 000000000000..be78226e0e16 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulAnalyzeImageWithUrl.json @@ -0,0 +1,184 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "visualFeatures": [ + "Categories", + "Adult", + "Tags", + "Description", + "Faces", + "Color", + "ImageType", + "Objects", + "Brands" + ], + "details": [ + "Celebrities", + "Landmarks" + ], + "language": "en", + "ImageUrl": { + "url": "{url}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "categories": [ + { + "name": "abstract_", + "score": 0.00390625 + }, + { + "name": "people_", + "score": 0.83984375, + "detail": { + "celebrities": [ + { + "name": "Satya Nadella", + "faceRectangle": { + "left": 597, + "top": 162, + "width": 248, + "height": 248 + }, + "confidence": 0.999028444 + } + ] + } + }, + { + "name": "building_", + "score": 0.984375, + "detail": { + "landmarks": [ + { + "name": "Forbidden City", + "confidence": 0.98290169239044189 + } + ] + } + } + ], + "adult": { + "isAdultContent": false, + "isRacyContent": false, + "isGoryContent": false, + "adultScore": 0.0934349000453949, + "racyScore": 0.068613491952419281, + "goreScore": 0.012872257380997575 + }, + "tags": [ + { + "name": "person", + "confidence": 0.98979085683822632 + }, + { + "name": "man", + "confidence": 0.94493889808654785 + }, + { + "name": "outdoor", + "confidence": 0.938492476940155 + }, + { + "name": "window", + "confidence": 0.89513939619064331 + }, + { + "name": "pangolin", + "confidence": 0.7250059783791661, + "hint": "mammal" + } + ], + "description": { + "tags": [ + "person", + "man", + "outdoor", + "window", + "glasses" + ], + "captions": [ + { + "text": "Satya Nadella sitting on a bench", + "confidence": 0.48293603002174407 + } + ] + }, + "requestId": "0dbec5ad-a3d3-4f7e-96b4-dfd57efe967d", + "metadata": { + "width": 1500, + "height": 1000, + "format": "Jpeg" + }, + "faces": [ + { + "age": 44, + "gender": "Male", + "faceRectangle": { + "left": 593, + "top": 160, + "width": 250, + "height": 250 + } + } + ], + "color": { + "dominantColorForeground": "Brown", + "dominantColorBackground": "Brown", + "dominantColors": [ + "Brown", + "Black" + ], + "accentColor": "873B59", + "isBWImg": false + }, + "imageType": { + "clipArtType": 0, + "lineDrawingType": 0 + }, + "objects": [ + { + "rectangle": { + "x": 0, + "y": 0, + "w": 50, + "h": 50 + }, + "object": "tree", + "confidence": 0.9, + "parent": { + "object": "plant", + "confidence": 0.95 + } + } + ], + "brands": [ + { + "name": "Pepsi", + "confidence": 0.857, + "rectangle": { + "x": 489, + "y": 79, + "w": 161, + "h": 177 + } + }, + { + "name": "Coca-Cola", + "confidence": 0.893, + "rectangle": { + "x": 216, + "y": 55, + "w": 171, + "h": 372 + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDescribeImageWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDescribeImageWithStream.json new file mode 100644 index 000000000000..071248140600 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDescribeImageWithStream.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "maxCandidates": 1, + "Image": "{binary}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "description": { + "tags": [ + "person", + "man", + "outdoor", + "window", + "glasses" + ], + "captions": [ + { + "text": "Satya Nadella sitting on a bench", + "confidence": 0.48293603002174407 + }, + { + "text": "Satya Nadella is sitting on a bench", + "confidence": 0.40037006815422832 + }, + { + "text": "Satya Nadella sitting in front of a building", + "confidence": 0.38035155997373377 + } + ] + }, + "requestId": "ed2de1c6-fb55-4686-b0da-4da6e05d283f", + "metadata": { + "width": 1500, + "height": 1000, + "format": "Jpeg" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDescribeImageWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDescribeImageWithUrl.json new file mode 100644 index 000000000000..087ac0515231 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDescribeImageWithUrl.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "maxCandidates": 1, + "ImageUrl": { + "url": "{url}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "description": { + "tags": [ + "person", + "man", + "outdoor", + "window", + "glasses" + ], + "captions": [ + { + "text": "Satya Nadella sitting on a bench", + "confidence": 0.48293603002174407 + }, + { + "text": "Satya Nadella is sitting on a bench", + "confidence": 0.40037006815422832 + }, + { + "text": "Satya Nadella sitting in front of a building", + "confidence": 0.38035155997373377 + } + ] + }, + "requestId": "ed2de1c6-fb55-4686-b0da-4da6e05d283f", + "metadata": { + "width": 1500, + "height": 1000, + "format": "Jpeg" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDetectObjectsWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDetectObjectsWithStream.json new file mode 100644 index 000000000000..8f4ad7fd73aa --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDetectObjectsWithStream.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "Image": "{binary}" + }, + "responses": { + "200": { + "body": { + "objects": [ + { + "rectangle": { + "x": 0, + "y": 0, + "w": 50, + "h": 50 + }, + "object": "tree", + "confidence": 0.9, + "parent": { + "object": "plant", + "confidence": 0.95 + } + } + ], + "requestId": "1ad0e45e-b7b4-4be3-8042-53be96103337", + "metadata": { + "width": 100, + "height": 100, + "format": "Jpeg" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDetectObjectsWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDetectObjectsWithUrl.json new file mode 100644 index 000000000000..7ea387eb41be --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulDetectObjectsWithUrl.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "ImageUrl": { + "url": "{url}" + } + }, + "responses": { + "200": { + "body": { + "objects": [ + { + "rectangle": { + "x": 0, + "y": 0, + "w": 50, + "h": 50 + }, + "object": "tree", + "confidence": 0.9, + "parent": { + "object": "plant", + "confidence": 0.95 + } + } + ], + "requestId": "1ad0e45e-b7b4-4be3-8042-53be96103337", + "metadata": { + "width": 100, + "height": 100, + "format": "Jpeg" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGenerateThumbnailWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGenerateThumbnailWithStream.json new file mode 100644 index 000000000000..22d52fbe7644 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGenerateThumbnailWithStream.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "width": "500", + "height": "500", + "smartCropping": true, + "Image": "{binary}" + }, + "responses": { + "200": { + "headers": {}, + "body": "{binary}" + } + } +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGenerateThumbnailWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGenerateThumbnailWithUrl.json new file mode 100644 index 000000000000..28744179ecb8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGenerateThumbnailWithUrl.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "width": "500", + "height": "500", + "smartCropping": true, + "ImageUrl": { + "url": "{url}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": "{Binary}" + } + } +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGetAreaOfInterestWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGetAreaOfInterestWithStream.json new file mode 100644 index 000000000000..ae32a21a551e --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGetAreaOfInterestWithStream.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "Image": "{binary}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "areaOfInterest": { + "h": 951, + "w": 950, + "x": 160, + "y": 0 + }, + "requestId": "ed2de1c6-fb55-4686-b0da-4da6e05d283f", + "metadata": { + "format": "Jpeg", + "height": 951, + "width": 1378 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGetAreaOfInterestWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGetAreaOfInterestWithUrl.json new file mode 100644 index 000000000000..7d6d08208836 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGetAreaOfInterestWithUrl.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "ImageUrl": { + "url": "{url}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "areaOfInterest": { + "h": 951, + "w": 950, + "x": 160, + "y": 0 + }, + "requestId": "ed2de1c6-fb55-4686-b0da-4da6e05d283f", + "metadata": { + "format": "Jpeg", + "height": 951, + "width": 1378 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGetReadResult.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGetReadResult.json new file mode 100644 index 000000000000..944e52b9d113 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulGetReadResult.json @@ -0,0 +1,369 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "operationId": "e56ffa6e-1ee4-4042-bc07-993db706c95f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "status": "succeeded", + "createdDateTime": "2019-10-03T14:32:04.236Z", + "lastUpdatedDateTime": "2019-10-03T14:38:14.852Z", + "analyzeResult": { + "version": "v3.1", + "readResults": [ + { + "page": 1, + "language": "en", + "angle": 49.59, + "width": 600, + "height": 400, + "unit": "pixel", + "lines": [ + { + "boundingBox": [ + 202, + 618, + 2047, + 643, + 2046, + 840, + 200, + 813 + ], + "text": "Our greatest glory is not", + "words": [ + { + "boundingBox": [ + 204, + 627, + 481, + 628, + 481, + 830, + 204, + 829 + ], + "text": "Our", + "confidence": 0.164 + }, + { + "boundingBox": [ + 519, + 628, + 1057, + 630, + 1057, + 832, + 518, + 830 + ], + "text": "greatest", + "confidence": 0.164 + }, + { + "boundingBox": [ + 1114, + 630, + 1549, + 631, + 1548, + 833, + 1114, + 832 + ], + "text": "glory", + "confidence": 0.164 + }, + { + "boundingBox": [ + 1586, + 631, + 1785, + 632, + 1784, + 834, + 1586, + 833 + ], + "text": "is", + "confidence": 0.164 + }, + { + "boundingBox": [ + 1822, + 632, + 2115, + 633, + 2115, + 835, + 1822, + 834 + ], + "text": "not", + "confidence": 0.164 + } + ] + }, + { + "boundingBox": [ + 420, + 1273, + 2954, + 1250, + 2958, + 1488, + 422, + 1511 + ], + "text": "but in rising every time we fall", + "words": [ + { + "boundingBox": [ + 423, + 1269, + 634, + 1268, + 635, + 1507, + 424, + 1508 + ], + "text": "but", + "confidence": 0.164 + }, + { + "boundingBox": [ + 667, + 1268, + 808, + 1268, + 809, + 1506, + 668, + 1507 + ], + "text": "in", + "confidence": 0.164 + }, + { + "boundingBox": [ + 874, + 1267, + 1289, + 1265, + 1290, + 1504, + 875, + 1506 + ], + "text": "rising", + "confidence": 0.164 + }, + { + "boundingBox": [ + 1331, + 1265, + 1771, + 1263, + 1772, + 1502, + 1332, + 1504 + ], + "text": "every", + "confidence": 0.164 + }, + { + "boundingBox": [ + 1812, + 1263, + 2178, + 1261, + 2179, + 1500, + 1813, + 1502 + ], + "text": "time", + "confidence": 0.164 + }, + { + "boundingBox": [ + 2219, + 1261, + 2510, + 1260, + 2511, + 1498, + 2220, + 1500 + ], + "text": "we", + "confidence": 0.164 + }, + { + "boundingBox": [ + 2551, + 1260, + 3016, + 1258, + 3017, + 1496, + 2552, + 1498 + ], + "text": "fall", + "confidence": 0.164 + } + ] + }, + { + "language": "es", + "boundingBox": [ + 1612, + 903, + 2744, + 935, + 2738, + 1139, + 1607, + 1107 + ], + "text": "Viva la vida", + "words": [ + { + "boundingBox": [ + 323, + 454, + 416, + 449, + 418, + 494, + 325, + 501 + ], + "text": "Viva", + "confidence": 0.164 + }, + { + "boundingBox": [ + 92, + 550, + 429, + 541, + 430, + 591, + 94, + 600 + ], + "text": "la", + "confidence": 0.164 + }, + { + "boundingBox": [ + 58, + 466, + 268, + 458, + 270, + 505, + 161, + 512 + ], + "text": "vida", + "confidence": 0.164 + } + ] + } + ] + }, + { + "page": 2, + "language": "en", + "angle": 1.32, + "width": 600, + "height": 400, + "unit": "pixel", + "lines": [ + { + "boundingBox": [ + 1612, + 903, + 2744, + 935, + 2738, + 1139, + 1607, + 1107 + ], + "text": "in never failing ,", + "words": [ + { + "boundingBox": [ + 1611, + 934, + 1707, + 933, + 1708, + 1147, + 1613, + 1147 + ], + "text": "in", + "confidence": 0.164 + }, + { + "boundingBox": [ + 1753, + 933, + 2132, + 930, + 2133, + 1144, + 1754, + 1146 + ], + "text": "never", + "confidence": 0.999 + }, + { + "boundingBox": [ + 2162, + 930, + 2673, + 927, + 2674, + 1140, + 2164, + 1144 + ], + "text": "failing", + "confidence": 0.164 + }, + { + "boundingBox": [ + 2703, + 926, + 2788, + 926, + 2790, + 1139, + 2705, + 1140 + ], + "text": ",", + "confidence": 0.164 + } + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulListModels.json new file mode 100644 index 000000000000..54e72d376431 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulListModels.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "models": [ + { + "name": "celebrities", + "categories": [ + "people_" + ] + }, + { + "name": "landmarks", + "categories": [ + "building_" + ] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulReadWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulReadWithStream.json new file mode 100644 index 000000000000..a9728b640867 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulReadWithStream.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "language": "en", + "Image": "{binary}" + }, + "responses": { + "202": { + "header": { + "location": "https://{domain}/vision/v3.1/read/e56ffa6e-1ee4-4042-bc07-993db706c95f" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulReadWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulReadWithUrl.json new file mode 100644 index 000000000000..60c4dc56a96c --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulReadWithUrl.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "language": "en", + "ImageUrl": { + "url": "{url}" + } + }, + "responses": { + "202": { + "header": { + "Operation-Location": "https://{domain}/vision/v3.1/read/e56ffa6e-1ee4-4042-bc07-993db706c95f" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulRecognizePrintedTextWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulRecognizePrintedTextWithStream.json new file mode 100644 index 000000000000..201d0fe48254 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulRecognizePrintedTextWithStream.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "detectOrientation": "true", + "language": "en", + "Image": "{binary}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "language": "en", + "textAngle": -2.0000000000000338, + "orientation": "Up", + "regions": [ + { + "boundingBox": "462,379,497,258", + "lines": [ + { + "boundingBox": "462,379,497,74", + "words": [ + { + "boundingBox": "462,379,41,73", + "text": "A" + }, + { + "boundingBox": "523,379,153,73", + "text": "GOAL" + }, + { + "boundingBox": "694,379,265,74", + "text": "WITHOUT" + } + ] + }, + { + "boundingBox": "565,471,289,74", + "words": [ + { + "boundingBox": "565,471,41,73", + "text": "A" + }, + { + "boundingBox": "626,471,150,73", + "text": "PLAN" + }, + { + "boundingBox": "801,472,53,73", + "text": "IS" + } + ] + }, + { + "boundingBox": "519,563,375,74", + "words": [ + { + "boundingBox": "519,563,149,74", + "text": "JUST" + }, + { + "boundingBox": "683,564,41,72", + "text": "A" + }, + { + "boundingBox": "741,564,153,73", + "text": "WISH" + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulRecognizePrintedTextWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulRecognizePrintedTextWithUrl.json new file mode 100644 index 000000000000..a0b8bc84e37b --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulRecognizePrintedTextWithUrl.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "detectOrientation": "true", + "language": "en", + "ImageUrl": { + "url": "{url}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "language": "en", + "textAngle": -2.0000000000000338, + "orientation": "Up", + "regions": [ + { + "boundingBox": "462,379,497,258", + "lines": [ + { + "boundingBox": "462,379,497,74", + "words": [ + { + "boundingBox": "462,379,41,73", + "text": "A" + }, + { + "boundingBox": "523,379,153,73", + "text": "GOAL" + }, + { + "boundingBox": "694,379,265,74", + "text": "WITHOUT" + } + ] + }, + { + "boundingBox": "565,471,289,74", + "words": [ + { + "boundingBox": "565,471,41,73", + "text": "A" + }, + { + "boundingBox": "626,471,150,73", + "text": "PLAN" + }, + { + "boundingBox": "801,472,53,73", + "text": "IS" + } + ] + }, + { + "boundingBox": "519,563,375,74", + "words": [ + { + "boundingBox": "519,563,149,74", + "text": "JUST" + }, + { + "boundingBox": "683,564,41,72", + "text": "A" + }, + { + "boundingBox": "741,564,153,73", + "text": "WISH" + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulTagImageWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulTagImageWithStream.json new file mode 100644 index 000000000000..813a645d0086 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulTagImageWithStream.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "Image": "{binary}" + }, + "responses": { + "200": { + "body": { + "tags": [ + { + "name": "grass", + "confidence": 0.9999997615814209 + }, + { + "name": "outdoor", + "confidence": 0.99997067451477051 + }, + { + "name": "sky", + "confidence": 0.99928975105285645 + }, + { + "name": "building", + "confidence": 0.99646323919296265 + }, + { + "name": "house", + "confidence": 0.99279803037643433 + }, + { + "name": "lawn", + "confidence": 0.82268029451370239 + }, + { + "name": "green", + "confidence": 0.64122253656387329 + }, + { + "name": "residential", + "confidence": 0.31403225660324097 + } + ], + "requestId": "1ad0e45e-b7b4-4be3-8042-53be96103337", + "metadata": { + "width": 400, + "height": 400, + "format": "Jpeg" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulTagImageWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulTagImageWithUrl.json new file mode 100644 index 000000000000..0dcf0304a33a --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v3.1/examples/SuccessfulTagImageWithUrl.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "ImageUrl": { + "url": "{url}" + } + }, + "responses": { + "200": { + "body": { + "tags": [ + { + "name": "grass", + "confidence": 0.9999997615814209 + }, + { + "name": "outdoor", + "confidence": 0.99997067451477051 + }, + { + "name": "sky", + "confidence": 0.99928975105285645 + }, + { + "name": "building", + "confidence": 0.99646323919296265 + }, + { + "name": "house", + "confidence": 0.99279803037643433 + }, + { + "name": "lawn", + "confidence": 0.82268029451370239 + }, + { + "name": "green", + "confidence": 0.64122253656387329 + }, + { + "name": "residential", + "confidence": 0.31403225660324097 + } + ], + "requestId": "1ad0e45e-b7b4-4be3-8042-53be96103337", + "metadata": { + "width": 400, + "height": 400, + "format": "Jpeg" + } + } + } + } +} From e0bd28458b2b78a1f6ab4fea5a32a3719ef5af64 Mon Sep 17 00:00:00 2001 From: Pradeep Kintali <50682039+pradeepkintali@users.noreply.github.com> Date: Thu, 24 Sep 2020 19:07:36 -0700 Subject: [PATCH 137/164] PostgreSQL Flexible Server Preview Swagger API changes (#10770) * PostgreSql Flexible Server Preview Swagger API changes * updated the readme.md file. * Updated the Python Cli changes for Preview. * Updated the csharp generated sdk output path folder * revert mysql changes * Fixed mysql path issue. * updated the output folder * updated the postgresql output folder path * Fixed lint error * Added data action to the operation. --- .../mysql/resource-manager/readme.md | 2 +- .../examples/CapabilitiesByLocation.json | 180 ++ .../examples/CheckNameAvailability.json | 20 + .../examples/ConfigurationGet.json | 26 + .../examples/ConfigurationListByServer.json | 1902 +++++++++++++++++ .../examples/ConfigurationUpdate.json | 33 + .../examples/FirewallRuleCreate.json | 40 + .../examples/FirewallRuleDelete.json | 14 + .../examples/FirewallRuleGet.json | 22 + .../examples/FirewallRuleListByServer.json | 35 + .../examples/OperationList.json | 176 ++ .../examples/ServerCreate.json | 115 + .../ServerCreatePointInTimeRestore.json | 81 + .../examples/ServerDelete.json | 13 + .../examples/ServerGet.json | 47 + .../examples/ServerGetWithVnet.json | 42 + .../examples/ServerList.json | 153 ++ .../examples/ServerListByResourceGroup.json | 113 + .../examples/ServerRestart.json | 12 + .../examples/ServerStart.json | 12 + .../examples/ServerStop.json | 12 + .../examples/ServerUpdate.json | 56 + ...erUpdateWithCustomerMaintenanceWindow.json | 59 + .../examples/VirtualNetworkSubnetUsage.json | 26 + .../2020-02-14-preview/postgresql.json | 1788 ++++++++++++++++ .../postgresql/resource-manager/readme.go.md | 6 +- .../postgresql/resource-manager/readme.md | 45 +- .../resource-manager/readme.python.md | 10 +- 28 files changed, 5030 insertions(+), 10 deletions(-) create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/CapabilitiesByLocation.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/CheckNameAvailability.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ConfigurationGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ConfigurationListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ConfigurationUpdate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleCreate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleDelete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/OperationList.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreatePointInTimeRestore.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerDelete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGetWithVnet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerList.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerListByResourceGroup.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerRestart.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerStart.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerStop.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/VirtualNetworkSubnetUsage.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json diff --git a/specification/mysql/resource-manager/readme.md b/specification/mysql/resource-manager/readme.md index f9385b4bab5a..db837a0271c1 100644 --- a/specification/mysql/resource-manager/readme.md +++ b/specification/mysql/resource-manager/readme.md @@ -161,7 +161,7 @@ csharp: azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: Microsoft.Azure.Management.MySQL - output-folder: $(csharp-sdks-folder)/mysql/Microsoft.Azure.Management.MySQL/src/Generated + output-folder: $(csharp-sdks-folder)/mysql/Microsoft.Azure.Management.MySQL/src/mysql/Generated clear-output-folder: true ``` diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/CapabilitiesByLocation.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/CapabilitiesByLocation.json new file mode 100644 index 000000000000..53ba1079a3a2 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/CapabilitiesByLocation.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "locationName": "WestUS" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "zone": "none", + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768 + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536 + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072 + } + ] + } + ], + "supportedServerVersions": [ + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_B1s", + "vCores": 1, + "supportedIops": 320, + "supportedMemoryPerVcoreMB": 1024 + }, + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048 + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048 + } + ] + } + ] + } + ] + }, + { + "zone": "1", + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768 + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536 + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072 + } + ] + } + ], + "supportedServerVersions": [ + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_B1s", + "vCores": 1, + "supportedIops": 320, + "supportedMemoryPerVcoreMB": 1024 + }, + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048 + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048 + } + ] + } + ] + } + ] + }, + { + "zone": "2", + "supportedFlexibleServerEditions": [ + { + "name": "Burstable", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "supportedStorageMB": [ + { + "name": "32768", + "supportedIops": 120, + "storageSizeMB": 32768 + }, + { + "name": "65536", + "supportedIops": 240, + "storageSizeMB": 65536 + }, + { + "name": "131072", + "supportedIops": 500, + "storageSizeMB": 131072 + } + ] + } + ], + "supportedServerVersions": [ + { + "name": "12", + "supportedVcores": [ + { + "name": "Standard_B1s", + "vCores": 1, + "supportedIops": 320, + "supportedMemoryPerVcoreMB": 1024 + }, + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMB": 2048 + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMB": 2048 + } + ] + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/CheckNameAvailability.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..2f20c8dbd88f --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "nameAvailabilityRequest": { + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "message": "", + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ConfigurationGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ConfigurationGet.json new file mode 100644 index 000000000000..af66828533e3 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ConfigurationGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "configurationName": "array_nulls", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "properties": { + "value": "on", + "description": "Enable input of NULL elements in arrays.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/array_nulls", + "name": "array_nulls", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ConfigurationListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ConfigurationListByServer.json new file mode 100644 index 000000000000..f91e08d1bc30 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ConfigurationListByServer.json @@ -0,0 +1,1902 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff//resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations?api-version=2020-02-14-privatepreview&$top=200&$skiptoken=skiptoken", + "value": [ + { + "properties": { + "value": "", + "description": "Sets the application name to be reported in statistics and logs.", + "defaultValue": "", + "dataType": "String", + "allowedValues": "[A-Za-z0-9._-]*", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/application_name", + "name": "application_name", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables input of NULL elements in arrays.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/array_nulls", + "name": "array_nulls", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Starts the autovacuum subprocess.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum", + "name": "autovacuum", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.1", + "description": "Number of tuple inserts, updates, or deletes prior to analyze as a fraction of reltuples.", + "defaultValue": "0.1", + "dataType": "Numeric", + "allowedValues": "0-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_analyze_scale_factor", + "name": "autovacuum_analyze_scale_factor", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "50", + "description": "Minimum number of tuple inserts, updates, or deletes prior to analyze.", + "defaultValue": "50", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_analyze_threshold", + "name": "autovacuum_analyze_threshold", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "60", + "description": "Time to sleep between autovacuum runs.", + "defaultValue": "60", + "dataType": "Integer", + "allowedValues": "1-2147483", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_naptime", + "name": "autovacuum_naptime", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Vacuum cost delay in milliseconds, for autovacuum.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "-1-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_cost_delay", + "name": "autovacuum_vacuum_cost_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Vacuum cost amount available before napping, for autovacuum.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_cost_limit", + "name": "autovacuum_vacuum_cost_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.2", + "description": "Number of tuple updates or deletes prior to vacuum as a fraction of reltuples.", + "defaultValue": "0.2", + "dataType": "Numeric", + "allowedValues": "0-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_scale_factor", + "name": "autovacuum_vacuum_scale_factor", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "50", + "description": "Minimum number of tuple updates or deletes prior to vacuum.", + "defaultValue": "50", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_threshold", + "name": "autovacuum_vacuum_threshold", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Sets the maximum memory to be used by each autovacuum worker process.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_work_mem", + "name": "autovacuum_work_mem", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Number of pages after which previously performed writes are flushed to disk.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-256", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/backend_flush_after", + "name": "backend_flush_after", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "safe_encoding", + "description": "Sets whether \"\\'\" is allowed in string literals.", + "defaultValue": "safe_encoding", + "dataType": "Enumeration", + "allowedValues": "safe_encoding,on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/backslash_quote", + "name": "backslash_quote", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "200", + "description": "Background writer sleep time between rounds.", + "defaultValue": "200", + "dataType": "Integer", + "allowedValues": "10-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_delay", + "name": "bgwriter_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "64", + "description": "Number of pages after which previously performed writes are flushed to disk.", + "defaultValue": "64", + "dataType": "Integer", + "allowedValues": "0-256", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_flush_after", + "name": "bgwriter_flush_after", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "100", + "description": "Background writer maximum number of LRU pages to flush per round.", + "defaultValue": "100", + "dataType": "Integer", + "allowedValues": "0-1073741823", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_lru_maxpages", + "name": "bgwriter_lru_maxpages", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Multiple of the average buffer usage to free per round.", + "defaultValue": "2", + "dataType": "Numeric", + "allowedValues": "0-10", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_lru_multiplier", + "name": "bgwriter_lru_multiplier", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "hex", + "description": "Sets the output format for bytea.", + "defaultValue": "hex", + "dataType": "Enumeration", + "allowedValues": "escape,hex", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bytea_output", + "name": "bytea_output", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Checks function bodies during CREATE FUNCTION.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/check_function_bodies", + "name": "check_function_bodies", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.5", + "description": "Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval.", + "defaultValue": "0.5", + "dataType": "Numeric", + "allowedValues": "0-1", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/checkpoint_completion_target", + "name": "checkpoint_completion_target", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "300", + "description": "Sets the maximum time between automatic WAL checkpoints.", + "defaultValue": "300", + "dataType": "Integer", + "allowedValues": "30-86400", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/checkpoint_timeout", + "name": "checkpoint_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30", + "description": "Enables warnings if checkpoint segments are filled more frequently than this.", + "defaultValue": "30", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/checkpoint_warning", + "name": "checkpoint_warning", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "sql_ascii", + "description": "Sets the client's character set encoding.", + "defaultValue": "sql_ascii", + "dataType": "Enumeration", + "allowedValues": "BIG5,EUC_CN,EUC_JP,EUC_JIS_2004,EUC_KR,EUC_TW,GB18030,GBK,ISO_8859_5,ISO_8859_6,ISO_8859_7,ISO_8859_8,JOHAB,KOI8R,KOI8U,LATIN1,LATIN2,LATIN3,LATIN4,LATIN5,LATIN6,LATIN7,LATIN8,LATIN9,LATIN10,MULE_INTERNAL,SJIS,SHIFT_JIS_2004,SQL_ASCII,UHC,UTF8,WIN866,WIN874,WIN1250,WIN1251,WIN1252,WIN1253,WIN1254,WIN1255,WIN1256,WIN1257,WIN1258", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/client_encoding", + "name": "client_encoding", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "notice", + "description": "Sets the message levels that are sent to the client.", + "defaultValue": "notice", + "dataType": "Enumeration", + "allowedValues": "debug5,debug4,debug3,debug2,debug1,log,notice,warning,error", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/client_min_messages", + "name": "client_min_messages", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the delay in microseconds between transaction commit and flushing WAL to disk.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-100000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/commit_delay", + "name": "commit_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "5", + "description": "Sets the minimum concurrent open transactions before performing commit_delay.", + "defaultValue": "5", + "dataType": "Integer", + "allowedValues": "0-1000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/commit_siblings", + "name": "commit_siblings", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "partition", + "description": "Enables the planner to use constraints to optimize queries.", + "defaultValue": "partition", + "dataType": "Enumeration", + "allowedValues": "partition,on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/constraint_exclusion", + "name": "constraint_exclusion", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.005", + "description": "Sets the planner's estimate of the cost of processing each index entry during an index scan.", + "defaultValue": "0.005", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cpu_index_tuple_cost", + "name": "cpu_index_tuple_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.0025", + "description": "Sets the planner's estimate of the cost of processing each operator or function call.", + "defaultValue": "0.0025", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cpu_operator_cost", + "name": "cpu_operator_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.01", + "description": "Sets the planner's estimate of the cost of processing each tuple (row).", + "defaultValue": "0.01", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cpu_tuple_cost", + "name": "cpu_tuple_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.1", + "description": "Sets the planner's estimate of the fraction of a cursor's rows that will be retrieved.", + "defaultValue": "0.1", + "dataType": "Numeric", + "allowedValues": "0-1", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cursor_tuple_fraction", + "name": "cursor_tuple_fraction", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "ISO, MDY", + "description": "Sets the display format for date and time values.", + "defaultValue": "ISO, MDY", + "dataType": "String", + "allowedValues": "(ISO|POSTGRES|SQL|GERMAN)(, (DMY|MDY|YMD))?", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/DateStyle", + "name": "DateStyle", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1000", + "description": "Sets the amount of time, in milliseconds, to wait on a lock before checking for deadlock.", + "defaultValue": "1000", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/deadlock_timeout", + "name": "deadlock_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Indents parse and plan tree displays.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_pretty_print", + "name": "debug_pretty_print", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each query's parse tree.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_print_parse", + "name": "debug_print_parse", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each query's execution plan.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_print_plan", + "name": "debug_print_plan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each query's rewritten parse tree.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_print_rewritten", + "name": "debug_print_rewritten", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "100", + "description": "Sets the default statistics target.", + "defaultValue": "100", + "dataType": "Integer", + "allowedValues": "1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_statistics_target", + "name": "default_statistics_target", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "", + "description": "Sets the default tablespace to create tables and indexes in.", + "defaultValue": "", + "dataType": "String", + "allowedValues": "[A-Za-z._]*", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_tablespace", + "name": "default_tablespace", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "pg_catalog.english", + "description": "Sets default text search configuration.", + "defaultValue": "pg_catalog.english", + "dataType": "String", + "allowedValues": "[A-Za-z._]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_text_search_config", + "name": "default_text_search_config", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Sets the default deferrable status of new transactions.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_transaction_deferrable", + "name": "default_transaction_deferrable", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "read committed", + "description": "Sets the transaction isolation level of each new transaction.", + "defaultValue": "read committed", + "dataType": "Enumeration", + "allowedValues": "serializable,repeatable read,read committed,read uncommitted", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_transaction_isolation", + "name": "default_transaction_isolation", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Sets the default read-only status of new transactions.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_transaction_read_only", + "name": "default_transaction_read_only", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Creates new tables with OIDs by default.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_with_oids", + "name": "default_with_oids", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "3145728", + "description": "Sets the planner's assumption about the size of the disk cache.", + "defaultValue": "3145728", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/effective_cache_size", + "name": "effective_cache_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of bitmap-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_bitmapscan", + "name": "enable_bitmapscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of gather merge plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_gathermerge", + "name": "enable_gathermerge", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of hashed aggregation plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_hashagg", + "name": "enable_hashagg", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of hash join plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_hashjoin", + "name": "enable_hashjoin", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of index-only-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_indexonlyscan", + "name": "enable_indexonlyscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of index-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_indexscan", + "name": "enable_indexscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of materialization.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_material", + "name": "enable_material", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of merge join plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_mergejoin", + "name": "enable_mergejoin", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of nested loop join plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_nestloop", + "name": "enable_nestloop", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of sequential-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_seqscan", + "name": "enable_seqscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of explicit sort steps.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_sort", + "name": "enable_sort", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of TID scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_tidscan", + "name": "enable_tidscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Warns about backslash escapes in ordinary string literals.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/escape_string_warning", + "name": "escape_string_warning", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Terminates session on any error.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/exit_on_error", + "name": "exit_on_error", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1", + "description": "Sets the number of digits displayed for floating-point values.", + "defaultValue": "1", + "dataType": "Integer", + "allowedValues": "-15-3", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/extra_float_digits", + "name": "extra_float_digits", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Forces use of parallel query facilities.", + "defaultValue": "off", + "dataType": "Enumeration", + "allowedValues": "off,on,regress", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/force_parallel_mode", + "name": "force_parallel_mode", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "8", + "description": "Sets the FROM-list size beyond which subqueries are not collapsed.", + "defaultValue": "8", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/from_collapse_limit", + "name": "from_collapse_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables genetic query optimization.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo", + "name": "geqo", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "5", + "description": "GEQO: effort is used to set the default for other GEQO parameters.", + "defaultValue": "5", + "dataType": "Integer", + "allowedValues": "1-10", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_effort", + "name": "geqo_effort", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "GEQO: number of iterations of the algorithm.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_generations", + "name": "geqo_generations", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "GEQO: number of individuals in the population.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_pool_size", + "name": "geqo_pool_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "GEQO: seed for random path selection.", + "defaultValue": "0", + "dataType": "Numeric", + "allowedValues": "0-1", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_seed", + "name": "geqo_seed", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "GEQO: selective pressure within the population.", + "defaultValue": "2", + "dataType": "Numeric", + "allowedValues": "1.5-2", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_selection_bias", + "name": "geqo_selection_bias", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "12", + "description": "Sets the threshold of FROM items beyond which GEQO is used.", + "defaultValue": "12", + "dataType": "Integer", + "allowedValues": "2-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_threshold", + "name": "geqo_threshold", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed result for exact search by GIN.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/gin_fuzzy_search_limit", + "name": "gin_fuzzy_search_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "4096", + "description": "Sets the maximum size of the pending list for GIN index.", + "defaultValue": "4096", + "dataType": "Integer", + "allowedValues": "64-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/gin_pending_list_limit", + "name": "gin_pending_list_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed duration of any idling transaction.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/idle_in_transaction_session_timeout", + "name": "idle_in_transaction_session_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "postgres", + "description": "Sets the display format for interval values.", + "defaultValue": "postgres", + "dataType": "Enumeration", + "allowedValues": "postgres,postgres_verbose,sql_standard,iso_8601", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/IntervalStyle", + "name": "IntervalStyle", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "8", + "description": "Sets the FROM-list size beyond which JOIN constructs are not flattened.", + "defaultValue": "8", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/join_collapse_limit", + "name": "join_collapse_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "en_US.utf-8", + "description": "Sets the locale for formatting monetary amounts.", + "defaultValue": "en_US.utf-8", + "dataType": "String", + "allowedValues": "[A-Za-z0-9._ -]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lc_monetary", + "name": "lc_monetary", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "en_US.utf-8", + "description": "Sets the locale for formatting numbers.", + "defaultValue": "en_US.utf-8", + "dataType": "String", + "allowedValues": "[A-Za-z0-9._ -]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lc_numeric", + "name": "lc_numeric", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Enables backward compatibility mode for privilege checks on large objects.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lo_compat_privileges", + "name": "lo_compat_privileges", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed duration (in milliseconds) of any wait for a lock. 0 turns this off.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lock_timeout", + "name": "lock_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Sets the minimum execution time above which autovacuum actions will be logged.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_autovacuum_min_duration", + "name": "log_autovacuum_min_duration", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Logs each checkpoint.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_checkpoints", + "name": "log_checkpoints", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Logs each successful connection.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_connections", + "name": "log_connections", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "stderr", + "description": "Sets the destination for server log output.", + "defaultValue": "stderr", + "dataType": "Enumeration", + "allowedValues": "stderr,csvlog", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_destination", + "name": "log_destination", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs end of a session, including duration.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_disconnections", + "name": "log_disconnections", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs the duration of each completed SQL statement.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_duration", + "name": "log_duration", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "default", + "description": "Sets the verbosity of logged messages.", + "defaultValue": "default", + "dataType": "Enumeration", + "allowedValues": "terse,default,verbose", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_error_verbosity", + "name": "log_error_verbosity", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs long lock waits.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_lock_waits", + "name": "log_lock_waits", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Sets the minimum execution time (in milliseconds) above which statements will be logged. -1 disables logging statement durations.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_min_duration_statement", + "name": "log_min_duration_statement", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "error", + "description": "Causes all statements generating error at or above this level to be logged.", + "defaultValue": "error", + "dataType": "Enumeration", + "allowedValues": "debug5,debug4,debug3,debug2,debug1,info,notice,warning,error,log,fatal,panic", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_min_error_statement", + "name": "log_min_error_statement", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "warning", + "description": "Sets the message levels that are logged.", + "defaultValue": "warning", + "dataType": "Enumeration", + "allowedValues": "debug5,debug4,debug3,debug2,debug1,info,notice,warning,error,log,fatal,panic", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_min_messages", + "name": "log_min_messages", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each replication command.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_replication_commands", + "name": "log_replication_commands", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "none", + "description": "Sets the type of statements logged.", + "defaultValue": "none", + "dataType": "Enumeration", + "allowedValues": "none,ddl,mod,all", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_statement", + "name": "log_statement", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "For each query, writes cumulative performance statistics to the server log.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_statement_stats", + "name": "log_statement_stats", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Logs the use of temporary files larger than this number of kilobytes.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_temp_files", + "name": "log_temp_files", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "332800", + "description": "Sets the maximum memory to be used for maintenance operations.", + "defaultValue": "332800", + "dataType": "Integer", + "allowedValues": "1024-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/maintenance_work_mem", + "name": "maintenance_work_mem", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "8", + "description": "Sets the maximum number of parallel workers than can be active at one time.", + "defaultValue": "8", + "dataType": "Integer", + "allowedValues": "0-1024", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_parallel_workers", + "name": "max_parallel_workers", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Sets the maximum number of parallel processes per executor node.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "0-1024", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_parallel_workers_per_gather", + "name": "max_parallel_workers_per_gather", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Sets the maximum number of predicate-locked tuples per page.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_pred_locks_per_page", + "name": "max_pred_locks_per_page", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-2", + "description": "Sets the maximum number of predicate-locked pages and tuples per relation.", + "defaultValue": "-2", + "dataType": "Integer", + "allowedValues": "-2147483648-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_pred_locks_per_relation", + "name": "max_pred_locks_per_relation", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30000", + "description": "Sets the maximum delay before canceling queries when a hot standby server is processing archived WAL data.", + "defaultValue": "30000", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_standby_archive_delay", + "name": "max_standby_archive_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30000", + "description": "Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data.", + "defaultValue": "30000", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_standby_streaming_delay", + "name": "max_standby_streaming_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Maximum number of table synchronization workers per subscription.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "0-262143", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_sync_workers_per_subscription", + "name": "max_sync_workers_per_subscription", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1024", + "description": "Sets the WAL size that triggers a checkpoint.", + "defaultValue": "1024", + "dataType": "Integer", + "allowedValues": "2-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_wal_size", + "name": "max_wal_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "64", + "description": "Sets the minimum amount of index data for a parallel scan.", + "defaultValue": "64", + "dataType": "Integer", + "allowedValues": "0-715827882", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/min_parallel_index_scan_size", + "name": "min_parallel_index_scan_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1024", + "description": "Sets the minimum amount of table data for a parallel scan.", + "defaultValue": "1024", + "dataType": "Integer", + "allowedValues": "0-715827882", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/min_parallel_table_scan_size", + "name": "min_parallel_table_scan_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "80", + "description": "Sets the minimum size to shrink the WAL to.", + "defaultValue": "80", + "dataType": "Integer", + "allowedValues": "2-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/min_wal_size", + "name": "min_wal_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Emits a warning for constructs that changed meaning since PostgreSQL 9.4.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/operator_precedence_warning", + "name": "operator_precedence_warning", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1000", + "description": "Sets the planner's estimate of the cost of starting up worker processes for parallel query.", + "defaultValue": "1000", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/parallel_setup_cost", + "name": "parallel_setup_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.1", + "description": "Sets the planner's estimate of the cost of passing each tuple (row) from worker to master backend.", + "defaultValue": "0.1", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/parallel_tuple_cost", + "name": "parallel_tuple_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "When generating SQL fragments, quotes all identifiers.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/quote_all_identifiers", + "name": "quote_all_identifiers", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "4", + "description": "Sets the planner's estimate of the cost of a nonsequentially fetched disk page.", + "defaultValue": "4", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/random_page_cost", + "name": "random_page_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables row security.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/row_security", + "name": "row_security", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "\"$user\", public", + "description": "Sets the schema search order for names that are not schema-qualified.", + "defaultValue": "\"$user\", public", + "dataType": "String", + "allowedValues": "[A-Za-z.\"$, ]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/search_path", + "name": "search_path", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1", + "description": "Sets the planner's estimate of the cost of a sequentially fetched disk page.", + "defaultValue": "1", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/seq_page_cost", + "name": "seq_page_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "origin", + "description": "Sets the session's behavior for triggers and rewrite rules.", + "defaultValue": "origin", + "dataType": "Enumeration", + "allowedValues": "origin,replica,local", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/session_replication_role", + "name": "session_replication_role", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Causes '...' strings to treat backslashes literally.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/standard_conforming_strings", + "name": "standard_conforming_strings", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed duration (in milliseconds) of any statement. 0 turns this off.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/statement_timeout", + "name": "statement_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables synchronized sequential scans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/synchronize_seqscans", + "name": "synchronize_seqscans", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Sets the current transaction's synchronization level.", + "defaultValue": "on", + "dataType": "Enumeration", + "allowedValues": "local,remote_write,on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/synchronous_commit", + "name": "synchronous_commit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "9", + "description": "Maximum number of TCP keepalive retransmits.", + "defaultValue": "9", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/tcp_keepalives_count", + "name": "tcp_keepalives_count", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "120", + "description": "Time between issuing TCP keepalives.", + "defaultValue": "120", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/tcp_keepalives_idle", + "name": "tcp_keepalives_idle", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30", + "description": "Time between TCP keepalive retransmits.", + "defaultValue": "30", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/tcp_keepalives_interval", + "name": "tcp_keepalives_interval", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1024", + "description": "Sets the maximum number of temporary buffers used by each database session.", + "defaultValue": "1024", + "dataType": "Integer", + "allowedValues": "100-1073741823", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/temp_buffers", + "name": "temp_buffers", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "", + "description": "Sets the tablespace(s) to use for temporary tables and sort files.", + "defaultValue": "", + "dataType": "String", + "allowedValues": "[A-Za-z._]*", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/temp_tablespaces", + "name": "temp_tablespaces", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "UTC", + "description": "Sets the time zone for displaying and interpreting time stamps.", + "defaultValue": "UTC", + "dataType": "String", + "allowedValues": "[A-Za-z0-9/+_-]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/TimeZone", + "name": "TimeZone", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Collects information about executing commands.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_activities", + "name": "track_activities", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Collects statistics on database activity.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_counts", + "name": "track_counts", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "none", + "description": "Collects function-level statistics on database activity.", + "defaultValue": "none", + "dataType": "Enumeration", + "allowedValues": "none,pl,all", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_functions", + "name": "track_functions", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Collects timing statistics for database I/O activity.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_io_timing", + "name": "track_io_timing", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Treats \"expr=NULL\" as \"expr IS NULL\".", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/transform_null_equals", + "name": "transform_null_equals", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Vacuum cost delay in milliseconds.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_delay", + "name": "vacuum_cost_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "200", + "description": "Vacuum cost amount available before napping.", + "defaultValue": "200", + "dataType": "Integer", + "allowedValues": "1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_limit", + "name": "vacuum_cost_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "20", + "description": "Vacuum cost for a page dirtied by vacuum.", + "defaultValue": "20", + "dataType": "Integer", + "allowedValues": "0-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_page_dirty", + "name": "vacuum_cost_page_dirty", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1", + "description": "Vacuum cost for a page found in the buffer cache.", + "defaultValue": "1", + "dataType": "Integer", + "allowedValues": "0-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_page_hit", + "name": "vacuum_cost_page_hit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "10", + "description": "Vacuum cost for a page not found in the buffer cache.", + "defaultValue": "10", + "dataType": "Integer", + "allowedValues": "0-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_page_miss", + "name": "vacuum_cost_page_miss", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Number of transactions by which VACUUM and HOT cleanup should be deferred, if any.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-1000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_defer_cleanup_age", + "name": "vacuum_defer_cleanup_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "50000000", + "description": "Minimum age at which VACUUM should freeze a table row.", + "defaultValue": "50000000", + "dataType": "Integer", + "allowedValues": "0-1000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_freeze_min_age", + "name": "vacuum_freeze_min_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "150000000", + "description": "Age at which VACUUM should scan whole table to freeze tuples.", + "defaultValue": "150000000", + "dataType": "Integer", + "allowedValues": "0-2000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_freeze_table_age", + "name": "vacuum_freeze_table_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "5000000", + "description": "Minimum age at which VACUUM should freeze a MultiXactId in a table row.", + "defaultValue": "5000000", + "dataType": "Integer", + "allowedValues": "0-1000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_multixact_freeze_min_age", + "name": "vacuum_multixact_freeze_min_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "150000000", + "description": "Multixact age at which VACUUM should scan whole table to freeze tuples.", + "defaultValue": "150000000", + "dataType": "Integer", + "allowedValues": "0-2000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_multixact_freeze_table_age", + "name": "vacuum_multixact_freeze_table_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "10", + "description": "Sets the maximum interval between WAL receiver status reports to the primary.", + "defaultValue": "10", + "dataType": "Integer", + "allowedValues": "0-2147483", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/wal_receiver_status_interval", + "name": "wal_receiver_status_interval", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "200", + "description": "Time between WAL flushes performed in the WAL writer.", + "defaultValue": "200", + "dataType": "Integer", + "allowedValues": "1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/wal_writer_delay", + "name": "wal_writer_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "128", + "description": "Amount of WAL written out by WAL writer that triggers a flush.", + "defaultValue": "128", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/wal_writer_flush_after", + "name": "wal_writer_flush_after", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "115712", + "description": "Sets the amount of memory to be used by internal sort operations and hash tables before writing to temporary disk files.", + "defaultValue": "115712", + "dataType": "Integer", + "allowedValues": "4096-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/work_mem", + "name": "work_mem", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "base64", + "description": "Sets how binary values are to be encoded in XML.", + "defaultValue": "base64", + "dataType": "Enumeration", + "allowedValues": "base64,hex", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/xmlbinary", + "name": "xmlbinary", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "content", + "description": "Sets whether XML data in implicit parsing and serialization operations is to be considered as documents or content fragments.", + "defaultValue": "content", + "dataType": "Enumeration", + "allowedValues": "content,document", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/xmloption", + "name": "xmloption", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ConfigurationUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ConfigurationUpdate.json new file mode 100644 index 000000000000..fe1ffbb8c42a --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ConfigurationUpdate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "serverName": "testserver", + "configurationName": "event_scheduler", + "resourceGroupName": "testrg", + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "value": "on", + "source": "user-override" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "value": "ON", + "description": "Indicates the status of the Event Scheduler.", + "defaultValue": "OFF", + "dataType": "Enumeration", + "allowedValues": "ON,OFF,DISABLED", + "source": "user-override" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/event_scheduler", + "name": "event_scheduler", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleCreate.json new file mode 100644 index 000000000000..6cb0471d8f0c --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleDelete.json new file mode 100644 index 000000000000..37cdd35b0e54 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleGet.json new file mode 100644 index 000000000000..afbe99290ead --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleListByServer.json new file mode 100644 index 000000000000..53acea0b30a1 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/FirewallRuleListByServer.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff//resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/firewallRules?api-version=2020-02-14-privatepreview&$top=2&$skiptoken=skiptoken", + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + }, + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/firewallRules/rule2", + "name": "rule2", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "1.0.0.0", + "endIpAddress": "255.0.0.0" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/OperationList.json new file mode 100644 index 000000000000..034fdc616edd --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/OperationList.json @@ -0,0 +1,176 @@ +{ + "parameters": { + "api-version": "2020-02-14-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "PostgreSQL Server", + "operation": "List/Get PostgreSQL Servers", + "description": "Return the list of servers or gets the properties for the specified server." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/write", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "PostgreSQL Server", + "operation": "Create/Update PostgreSQL Server", + "description": "Creates a server with the specified parameters or update the properties or tags for the specified server." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/delete", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "PostgreSQL Server", + "operation": "Delete PostgreSQL Server", + "description": "Deletes an existing server." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Firewall Rules", + "operation": "List/Get Firewall Rules", + "description": "Return the list of firewall rules for a server or gets the properties for the specified firewall rule." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/write", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Firewall Rules", + "operation": "Create/Update Firewall Rule", + "description": "Creates a firewall rule with the specified parameters or update an existing rule." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/delete", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Firewall Rules", + "operation": "Delete Firewall Rule", + "description": "Deletes an existing firewall rule." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Database Metric Definition", + "operation": "Get database metric definitions", + "description": "Return types of metrics that are available for databases" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "cpu_percent", + "displayName": "CPU percent", + "displayDescription": "CPU percent", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "compute_limit", + "displayName": "Compute Unit limit", + "displayDescription": "Compute Unit limit", + "unit": "Count", + "aggregationType": "Average" + }, + { + "name": "compute_consumption_percent", + "displayName": "Compute Unit percentage", + "displayDescription": "Compute Unit percentage", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "memory_percent", + "displayName": "Memory percent", + "displayDescription": "Memory percent", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "io_consumption_percent", + "displayName": "IO percent", + "displayDescription": "IO percent", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "storage_percent", + "displayName": "Storage percentage", + "displayDescription": "Storage percentage", + "unit": "Percent", + "aggregationType": "Average" + }, + { + "name": "storage_used", + "displayName": "Storage used", + "displayDescription": "Storage used", + "unit": "Bytes", + "aggregationType": "Average" + }, + { + "name": "storage_limit", + "displayName": "Storage limit", + "displayDescription": "Storage limit", + "unit": "Bytes", + "aggregationType": "Average" + }, + { + "name": "active_connections", + "displayName": "Total active connections", + "displayDescription": "Total active connections", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "connections_failed", + "displayName": "Total failed connections", + "displayDescription": "Total failed connections", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": true + } + ] + } + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Database Metric Definition", + "operation": "Read diagnostic setting", + "description": "Gets the disagnostic setting for the resource" + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Database Metric Definition", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreate.json new file mode 100644 index 000000000000..6f8e66d7030e --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreate.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "administratorLoginPassword": "password", + "version": "12", + "haEnabled": "Enabled", + "delegatedSubnetArguments": { + "subnetArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet" + }, + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 7 + }, + "availabilityZone": "1" + }, + "tags": { + "ElasticServer": "1" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "version": "12", + "state": "Ready", + "haState": "NotEnabled", + "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", + "displayName": "demosingleserver", + "publicNetworkAccess": "Enabled", + "haEnabled": "Enabled", + "delegatedSubnetArguments": { + "subnetArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet" + }, + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 7 + }, + "availabilityZone": "1", + "standbyAvailabilityZone": "2", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0, + "customWindow": "Disabled" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "version": "12", + "state": "Ready", + "haState": "NotEnabled", + "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", + "displayName": "demosingleserver", + "publicNetworkAccess": "Enabled", + "haEnabled": "Enabled", + "delegatedSubnetArguments": { + "subnetArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet" + }, + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 7 + }, + "availabilityZone": "1", + "standbyAvailabilityZone": "2", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0, + "customWindow": "Disabled" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreatePointInTimeRestore.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreatePointInTimeRestore.json new file mode 100644 index 000000000000..bb1f9c485e7d --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerCreatePointInTimeRestore.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "TestGroup", + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "properties": { + "createMode": "PointInTimeRestore", + "sourceServerName": "sourcePgServerName", + "pointInTimeUTC": "2020-06-30T23:41:49.000Z" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "version": "12", + "state": "Ready", + "haState": "NotEnabled", + "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", + "displayName": "demosingleserver", + "publicNetworkAccess": "Enabled", + "haEnabled": "Disabled", + "delegatedSubnetArguments": {}, + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 7 + }, + "availabilityZone": "1" + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "version": "12", + "state": "Ready", + "haState": "NotEnabled", + "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", + "displayName": "demosingleserver", + "publicNetworkAccess": "Enabled", + "haEnabled": "Disabled", + "delegatedSubnetArguments": {}, + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 7 + }, + "availabilityZone": "1" + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerDelete.json new file mode 100644 index 000000000000..5ccafe7a9954 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGet.json new file mode 100644 index 000000000000..b28535f615a1 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "serverName": "pgtestsvc1", + "resourceGroupName": "testrg", + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "version": "12", + "state": "Ready", + "haState": "NotEnabled", + "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", + "displayName": "demosingleserver", + "publicNetworkAccess": "Enabled", + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 7 + }, + "haEnabled": "Enabled", + "availabilityZone": "1", + "standbyAvailabilityZone": "2", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0, + "customWindow": "Disabled" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1", + "name": "pgtestsvc1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGetWithVnet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGetWithVnet.json new file mode 100644 index 000000000000..9c8216593f4c --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerGetWithVnet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "serverName": "pgtestsvc1", + "resourceGroupName": "testrg", + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "version": "12", + "state": "Ready", + "haState": "NotEnabled", + "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", + "displayName": "demosingleserver", + "publicNetworkAccess": "Disabled", + "delegatedSubnetArguments": { + "subnetArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet" + }, + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 7 + }, + "availabilityZone": "1" + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1", + "name": "pgtestsvc1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerList.json new file mode 100644 index 000000000000..d8917699f069 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerList.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/flexibleServers?api-version=2020-02-14-privatepreview&$top=3&$skiptoken=skiptoken", + "value": [ + { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "version": "12", + "state": "Ready", + "haState": "NotEnabled", + "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com", + "displayName": "demosingleserver", + "publicNetworkAccess": "Enabled", + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 7 + }, + "haEnabled": "Enabled", + "availabilityZone": "1", + "standbyAvailabilityZone": "2", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0, + "customWindow": "Disabled" + } + }, + "location": "westus", + "tags": { + "Server": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1", + "name": "pgtestsvc1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + }, + { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "version": "12", + "state": "Ready", + "haState": "Healthy", + "fullyQualifiedDomainName": "pgtestsvc2.postgres.database.azure.com", + "displayName": "demosingleserver", + "publicNetworkAccess": "Enabled", + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 7 + }, + "haEnabled": "Disabled", + "availabilityZone": "2", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 10, + "startMinute": 30, + "customWindow": "Enabled" + } + }, + "location": "westus", + "tags": { + "Server": "2" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc2", + "name": "pgtestsvc2", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + }, + { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "version": "12", + "state": "Ready", + "haState": "FailingOver", + "fullyQualifiedDomainName": "pgtestsvc3.postgres.database.azure.com", + "displayName": "demosingleserver", + "publicNetworkAccess": "Enabled", + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 7 + }, + "haEnabled": "Disabled", + "availabilityZone": "3", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0, + "customWindow": "Disabled" + } + }, + "location": "westus", + "tags": { + "Server": "3" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc3", + "name": "pgtestsvc3", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + }, + { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "version": "12", + "state": "Ready", + "haState": "ReplicatingData", + "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", + "displayName": "demosingleserver", + "publicNetworkAccess": "Enabled", + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 7 + }, + "haEnabled": "Enabled", + "availabilityZone": "1", + "standbyAvailabilityZone": "2", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0, + "customWindow": "Disabled" + } + }, + "location": "westus", + "tags": { + "Server": "4" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerListByResourceGroup.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerListByResourceGroup.json new file mode 100644 index 000000000000..276e20cb04d8 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerListByResourceGroup.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff//resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers?api-version=2020-02-14-privatepreview&$top=3&$skiptoken=skiptoken", + "value": [ + { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "testuser", + "version": "12", + "state": "Ready", + "haState": "NotEnabled", + "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", + "displayName": "demosingleserver", + "publicNetworkAccess": "Enabled", + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 7 + }, + "haEnabled": "Enabled", + "availabilityZone": "1", + "standbyAvailabilityZone": "2", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 10, + "startMinute": 30, + "customWindow": "Enabled" + } + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/pgtestsvc1", + "name": "pgtestsvc1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + }, + { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "testuser", + "version": "12", + "state": "Ready", + "haState": "Healthy", + "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", + "displayName": "demosingleserver", + "publicNetworkAccess": "Enabled", + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 7 + }, + "haEnabled": "Disabled", + "availabilityZone": "2", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0, + "customWindow": "Disabled" + } + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc2", + "name": "pgtestsvc2", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + }, + { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "testuser", + "version": "12", + "state": "Ready", + "haState": "Healthy", + "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", + "displayName": "demosingleserver", + "publicNetworkAccess": "Enabled", + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 7 + }, + "haEnabled": "Disabled", + "availabilityZone": "3", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 10, + "startMinute": 30, + "customWindow": "Enabled" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerRestart.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerRestart.json new file mode 100644 index 000000000000..3b73691fcba8 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerRestart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerStart.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerStart.json new file mode 100644 index 000000000000..3b73691fcba8 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerStart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerStop.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerStop.json new file mode 100644 index 000000000000..3b73691fcba8 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerStop.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdate.json new file mode 100644 index 000000000000..08994e49f0ba --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdate.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "TestGroup", + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLoginPassword": "newpassword", + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 20 + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "version": "12", + "state": "Ready", + "haState": "NotEnabled", + "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", + "displayName": "demosingleserver", + "publicNetworkAccess": "Enabled", + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 20 + }, + "delegatedSubnetArguments": {}, + "haEnabled": "Disabled", + "availabilityZone": "1" + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json new file mode 100644 index 000000000000..bcd94b4eeae5 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/ServerUpdateWithCustomerMaintenanceWindow.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "properties": { + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 8, + "startMinute": 0, + "customWindow": "Enabled" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "version": "12", + "state": "Ready", + "haState": "NotEnabled", + "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", + "displayName": "demosingleserver", + "publicNetworkAccess": "Enabled", + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 20 + }, + "delegatedSubnetArguments": {}, + "haEnabled": "Disabled", + "availabilityZone": "1", + "maintenanceWindow": { + "dayOfWeek": 0, + "startHour": 8, + "startMinute": 0, + "customWindow": "Enabled" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/VirtualNetworkSubnetUsage.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/VirtualNetworkSubnetUsage.json new file mode 100644 index 000000000000..c35f70ea13f8 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/VirtualNetworkSubnetUsage.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2020-02-14-preview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "locationName": "WestUS", + "parameters": { + "virtualNetworkArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/testvnet" + } + }, + "responses": { + "200": { + "body": { + "delegatedSubnetsUsage": [ + { + "subnetName": "test-subnet-1", + "usage": 2 + }, + { + "subnetName": "test-subnet-2", + "usage": 3 + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json new file mode 100644 index 000000000000..689e6b053dd1 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json @@ -0,0 +1,1788 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2020-02-14-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/flexibleServers/{serverName}": { + "put": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Create", + "x-ms-examples": { + "Create a new server": { + "$ref": "./examples/ServerCreate.json" + }, + "Create a database as a point in time restore": { + "$ref": "./examples/ServerCreatePointInTimeRestore.json" + } + }, + "description": "Creates a new server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Server" + }, + "description": "The required parameters for creating or updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Update", + "x-ms-examples": { + "ServerUpdate": { + "$ref": "./examples/ServerUpdate.json" + }, + "ServerUpdateWithCustomerMaintenanceWindow": { + "$ref": "./examples/ServerUpdateWithCustomerMaintenanceWindow.json" + } + }, + "description": "Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServerForUpdate" + }, + "description": "The required parameters for updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Delete", + "x-ms-examples": { + "ServerDelete": { + "$ref": "./examples/ServerDelete.json" + } + }, + "description": "Deletes a server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Get", + "x-ms-examples": { + "ServerGet": { + "$ref": "./examples/ServerGet.json" + }, + "ServerGetWithVnet": { + "$ref": "./examples/ServerGetWithVnet.json" + } + }, + "description": "Gets information about a server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/flexibleServers": { + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_ListByResourceGroup", + "x-ms-examples": { + "ServerListByResourceGroup": { + "$ref": "./examples/ServerListByResourceGroup.json" + } + }, + "description": "List all the servers in a given resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSql/flexibleServers": { + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_List", + "x-ms-examples": { + "ServerList": { + "$ref": "./examples/ServerList.json" + } + }, + "description": "List all the servers in a given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/flexibleServers/{serverName}/restart": { + "post": { + "tags": [ + "ServerRestart" + ], + "operationId": "Servers_Restart", + "x-ms-examples": { + "ServerRestart": { + "$ref": "./examples/ServerRestart.json" + } + }, + "description": "Restarts a server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + } + ], + "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 + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/flexibleServers/{serverName}/start": { + "post": { + "tags": [ + "ServerStart" + ], + "operationId": "Servers_Start", + "x-ms-examples": { + "ServerStart": { + "$ref": "./examples/ServerStart.json" + } + }, + "description": "Starts a server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + } + ], + "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 + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/flexibleServers/{serverName}/stop": { + "post": { + "tags": [ + "ServerStop" + ], + "operationId": "Servers_Stop", + "x-ms-examples": { + "ServerStop": { + "$ref": "./examples/ServerStop.json" + } + }, + "description": "Stops a server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + } + ], + "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 + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/flexibleServers/{serverName}/firewallRules/{firewallRuleName}": { + "put": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_CreateOrUpdate", + "x-ms-examples": { + "FirewallRuleCreate": { + "$ref": "./examples/FirewallRuleCreate.json" + } + }, + "description": "Creates a new firewall rule or updates an existing firewall rule.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "The required parameters for creating or updating a firewall rule." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_Delete", + "x-ms-examples": { + "FirewallRuleDelete": { + "$ref": "./examples/FirewallRuleDelete.json" + } + }, + "description": "Deletes a PostgreSQL server firewall rule.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_Get", + "x-ms-examples": { + "FirewallRuleList": { + "$ref": "./examples/FirewallRuleGet.json" + } + }, + "description": "List all the firewall rules in a given server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/flexibleServers/{serverName}/firewallRules": { + "get": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_ListByServer", + "x-ms-examples": { + "FirewallRuleList": { + "$ref": "./examples/FirewallRuleListByServer.json" + } + }, + "description": "List all the firewall rules in a given PostgreSQL server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/flexibleServers/{serverName}/configurations": { + "get": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_ListByServer", + "x-ms-examples": { + "ConfigurationList": { + "$ref": "./examples/ConfigurationListByServer.json" + } + }, + "description": "List all the configurations in a given server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/flexibleServers/{serverName}/configurations/{configurationName}": { + "get": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Get", + "x-ms-examples": { + "ConfigurationGet": { + "$ref": "./examples/ConfigurationGet.json" + } + }, + "description": "Gets information about a configuration of server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Update", + "x-ms-examples": { + "Update a user configuration": { + "$ref": "./examples/ConfigurationUpdate.json" + } + }, + "description": "Updates a configuration of a server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Configuration" + }, + "description": "The required parameters for updating a server configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSql/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "operationId": "CheckNameAvailability_Execute", + "x-ms-examples": { + "NameAvailability": { + "$ref": "./examples/CheckNameAvailability.json" + } + }, + "description": "Check the availability of name for resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "nameAvailabilityRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NameAvailabilityRequest" + }, + "description": "The required parameters for checking if resource name is available." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NameAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSql/locations/{locationName}/capabilities": { + "get": { + "tags": [ + "LocationBasedCapabilities" + ], + "operationId": "LocationBasedCapabilities_Execute", + "x-ms-examples": { + "CapabilitiesList": { + "$ref": "./examples/CapabilitiesByLocation.json" + } + }, + "description": "Get capabilities at specified location in a given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapabilitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSql/locations/{locationName}/checkVirtualNetworkSubnetUsage": { + "post": { + "tags": [ + "VirtualNetworkSubnetUsage" + ], + "operationId": "VirtualNetworkSubnetUsage_Execute", + "x-ms-examples": { + "VirtualNetworkSubnetUsageList": { + "$ref": "./examples/VirtualNetworkSubnetUsage.json" + } + }, + "description": "Get virtual network subnet usage for a given vNet resource id.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkSubnetUsageParameter" + }, + "description": "The required parameters for creating or updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualNetworkSubnetUsageResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/Microsoft.DBForPostgreSql/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationList": { + "$ref": "./examples/OperationList.json" + } + }, + "description": "Lists all of the available REST API operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "VirtualNetworkSubnetUsageParameter": { + "type": "object", + "properties": { + "virtualNetworkArmResourceId": { + "type": "string", + "description": "Virtual network resource id." + } + }, + "description": "Virtual network subnet usage parameter" + }, + "VirtualNetworkSubnetUsageResult": { + "type": "object", + "properties": { + "delegatedSubnetsUsage": { + "type": "array", + "items": { + "$ref": "#/definitions/DelegatedSubnetUsage" + }, + "readOnly": true + } + }, + "description": "Virtual network subnet usage data." + }, + "DelegatedSubnetUsage": { + "type": "object", + "properties": { + "subnetName": { + "type": "string", + "readOnly": true, + "description": "name of the subnet" + }, + "usage": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Number of used delegated subnets" + } + }, + "description": "Delegated subnet usage data." + }, + "StorageMBCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "storage MB name", + "readOnly": true + }, + "supportedIops": { + "type": "integer", + "format": "int64", + "description": "supported IOPS", + "readOnly": true + }, + "storageSizeMB": { + "type": "integer", + "format": "int64", + "description": "storage size in MB", + "readOnly": true + } + }, + "description": "storage size in MB capability" + }, + "VcoreCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "vCore name", + "readOnly": true + }, + "vCores": { + "type": "integer", + "format": "int64", + "description": "supported vCores", + "readOnly": true + }, + "supportedIops": { + "type": "integer", + "format": "int64", + "description": "supported IOPS", + "readOnly": true + }, + "supportedMemoryPerVcoreMB": { + "type": "integer", + "format": "int64", + "description": "supported memory per vCore in MB", + "readOnly": true + } + }, + "description": "Vcores capability" + }, + "ServerVersionCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "server version", + "readOnly": true + }, + "supportedVcores": { + "type": "array", + "items": { + "$ref": "#/definitions/VcoreCapability" + }, + "readOnly": true + } + }, + "description": "Server version capabilities." + }, + "StorageEditionCapability": { + "properties": { + "name": { + "type": "string", + "description": "storage edition name", + "readOnly": true + }, + "supportedStorageMB": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageMBCapability" + }, + "readOnly": true + } + }, + "description": "storage edition capability" + }, + "ServerEditionCapability": { + "properties": { + "name": { + "type": "string", + "description": "Server edition name", + "readOnly": true + }, + "supportedStorageEditions": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageEditionCapability" + }, + "readOnly": true + }, + "supportedServerVersions": { + "type": "array", + "items": { + "$ref": "#/definitions/ServerVersionCapability" + }, + "readOnly": true + } + }, + "description": "Server edition capabilities." + }, + "CapabilityProperties": { + "properties": { + "zone": { + "type": "string", + "description": "zone name", + "readOnly": true + }, + "supportedFlexibleServerEditions": { + "type": "array", + "items": { + "$ref": "#/definitions/ServerEditionCapability" + }, + "readOnly": true + } + }, + "description": "Location capabilities." + }, + "CapabilitiesListResult": { + "type": "object", + "properties": { + "value": { + "description": "A list of supported capabilities.", + "type": "array", + "items": { + "$ref": "#/definitions/CapabilityProperties" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + }, + "description": "location capability" + }, + "ServerVersion": { + "type": "string", + "description": "The version of a server.", + "enum": [ + "12", + "11" + ], + "x-ms-enum": { + "name": "ServerVersion", + "modelAsString": true + } + }, + "ServerProperties": { + "properties": { + "administratorLogin": { + "type": "string", + "description": "The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "administratorLoginPassword": { + "type": "string", + "description": "The administrator login password (required for server creation).", + "x-ms-secret": true, + "format": "password", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "version": { + "$ref": "#/definitions/ServerVersion", + "description": "PostgreSQL Server version." + }, + "state": { + "type": "string", + "description": "A state of a server that is visible to user.", + "readOnly": true, + "enum": [ + "Ready", + "Dropping", + "Disabled", + "Starting", + "Stopping", + "Stopped", + "Updating" + ], + "x-ms-enum": { + "name": "ServerState", + "modelAsString": true + } + }, + "haState": { + "type": "string", + "description": "A state of a HA server that is visible to user.", + "enum": [ + "NotEnabled", + "CreatingStandby", + "ReplicatingData", + "FailingOver", + "Healthy", + "RemovingStandby" + ], + "readOnly": true, + "x-ms-enum": { + "name": "ServerHAState", + "modelAsString": true + } + }, + "fullyQualifiedDomainName": { + "type": "string", + "description": "The fully qualified domain name of a server.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The display name of a server." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Storage profile of a server." + }, + "publicNetworkAccess": { + "type": "string", + "description": "public network access is enabled or not", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ServerPublicNetworkAccessState", + "modelAsString": true + }, + "readOnly": true + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window of a server." + }, + "haEnabled": { + "type": "string", + "description": "stand by count value can be either enabled or disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "HAEnabledEnum", + "modelAsString": false + } + }, + "sourceServerName": { + "type": "string", + "description": "The source PostgreSQL server name to restore from." + }, + "pointInTimeUTC": { + "type": "string", + "format": "date-time", + "description": "Restore point creation time (ISO8601 format), specifying the time to restore from." + }, + "availabilityZone": { + "type": "string", + "description": "availability Zone information of the server." + }, + "standbyAvailabilityZone": { + "type": "string", + "description": "availability Zone information of the server.", + "readOnly": true + }, + "byokEnforcement": { + "type": "string", + "description": "Status showing whether the data encryption is enabled with customer-managed keys.", + "readOnly": true + }, + "delegatedSubnetArguments": { + "properties": { + "subnetArmResourceId": { + "type": "string", + "description": "delegated subnet arm resource id." + } + } + }, + "createMode": { + "type": "string", + "description": "The mode to create a new PostgreSQL server.", + "enum": [ + "Default", + "PointInTimeRestore" + ], + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": true + }, + "x-ms-mutability": [ + "create" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-specific metadata in the form of key-value pairs." + } + }, + "description": "The properties of a server." + }, + "Server": { + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Identity", + "description": "The Azure Active Directory identity of the server." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU (pricing tier) of the server." + }, + "properties": { + "$ref": "#/definitions/ServerProperties", + "x-ms-client-flatten": true, + "description": "Properties of the server." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "description": "Represents a server." + }, + "MaintenanceWindow": { + "type": "object", + "description": "Maintenance window of a server.", + "properties": { + "customWindow": { + "type": "string", + "description": "indicates whether custom window is enabled or disabled" + }, + "startHour": { + "type": "integer", + "format": "int32", + "description": "start hour for maintenance window" + }, + "startMinute": { + "type": "integer", + "format": "int32", + "description": "start minute for maintenance window" + }, + "dayOfWeek": { + "type": "integer", + "format": "int32", + "description": "day of week for maintenance window" + } + } + }, + "ServerPropertiesForUpdate": { + "properties": { + "administratorLoginPassword": { + "type": "string", + "format": "password", + "description": "The password of the administrator login." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Storage profile of a server." + }, + "haEnabled": { + "type": "string", + "description": "stand by count value can be either enabled or disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "HAEnabledEnum", + "modelAsString": false + } + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window of a server." + } + } + }, + "ServerForUpdate": { + "properties": { + "location": { + "type": "string", + "description": "The location the resource resides in." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU (pricing tier) of the server." + }, + "properties": { + "$ref": "#/definitions/ServerPropertiesForUpdate", + "x-ms-client-flatten": true, + "description": "Properties of the server." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-specific metadata in the form of key-value pairs." + } + }, + "description": "Represents a server to be updated." + }, + "ServerListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Server" + }, + "description": "The list of flexible servers" + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of servers." + }, + "StorageProfile": { + "properties": { + "backupRetentionDays": { + "type": "integer", + "format": "int32", + "description": "Backup retention days for the server." + }, + "storageMB": { + "type": "integer", + "format": "int32", + "description": "Max storage allowed for a server." + } + }, + "description": "Storage Profile properties of a server" + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3." + }, + "tier": { + "type": "string", + "description": "The tier of the particular SKU, e.g. Burstable.", + "enum": [ + "Burstable", + "GeneralPurpose", + "MemoryOptimized" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + } + }, + "required": [ + "name", + "tier" + ], + "description": "Sku information related properties of a server." + }, + "FirewallRuleProperties": { + "properties": { + "startIpAddress": { + "type": "string", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", + "description": "The start IP address of the server firewall rule. Must be IPv4 format." + }, + "endIpAddress": { + "type": "string", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", + "description": "The end IP address of the server firewall rule. Must be IPv4 format." + } + }, + "required": [ + "startIpAddress", + "endIpAddress" + ], + "description": "The properties of a server firewall rule." + }, + "FirewallRule": { + "properties": { + "properties": { + "$ref": "#/definitions/FirewallRuleProperties", + "x-ms-client-flatten": true, + "description": "The properties of a firewall rule." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "required": [ + "properties" + ], + "description": "Represents a server firewall rule." + }, + "FirewallRuleListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "The list of firewall rules in a server." + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of firewall rules." + }, + "ConfigurationProperties": { + "properties": { + "value": { + "type": "string", + "description": "Value of the configuration." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Description of the configuration." + }, + "defaultValue": { + "type": "string", + "readOnly": true, + "description": "Default value of the configuration." + }, + "dataType": { + "type": "string", + "readOnly": true, + "description": "Data type of the configuration.", + "enum": [ + "Boolean", + "Numeric", + "Integer", + "Enumeration" + ], + "x-ms-enum": { + "name": "ConfigurationDataType", + "modelAsString": true + } + }, + "allowedValues": { + "type": "string", + "readOnly": true, + "description": "Allowed values of the configuration." + }, + "source": { + "type": "string", + "description": "Source of the configuration." + } + }, + "description": "The properties of a configuration." + }, + "Configuration": { + "properties": { + "properties": { + "$ref": "#/definitions/ConfigurationProperties", + "x-ms-client-flatten": true, + "description": "The properties of a configuration." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a Configuration." + }, + "ConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Configuration" + }, + "description": "The list of server configurations." + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of server configurations." + }, + "OperationDisplay": { + "properties": { + "provider": { + "type": "string", + "readOnly": true, + "description": "Operation resource provider name." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "Resource on which the operation is performed." + }, + "operation": { + "type": "string", + "readOnly": true, + "description": "Localized friendly name for the operation." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Operation description." + } + }, + "description": "Display metadata associated with the operation." + }, + "Operation": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the operation being performed on this particular object." + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "readOnly": true, + "description": "The localized display information for this particular operation or action." + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "origin": { + "type": "string", + "readOnly": true, + "description": "The intended executor of the operation.", + "enum": [ + "NotSpecified", + "user", + "system" + ], + "x-ms-enum": { + "name": "OperationOrigin", + "modelAsString": true + } + }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "readOnly": true, + "x-ms-client-flatten": false, + "description": "Additional descriptions for the operation." + } + }, + "description": "REST API operation definition." + }, + "OperationListResult": { + "description": "A list of resource provider operations.", + "type": "object", + "properties": { + "value": { + "description": "Collection of available operation details", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "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" + } + } + }, + "NameAvailabilityRequest": { + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Resource name to verify." + }, + "type": { + "type": "string", + "description": "Resource type used for verification." + } + }, + "description": "Request from client to check resource name availability." + }, + "NameAvailability": { + "properties": { + "message": { + "type": "string", + "description": "Error Message." + }, + "nameAvailable": { + "type": "boolean", + "description": "Indicates whether the resource name is available." + }, + "name": { + "type": "string", + "description": "name of the PostgreSQL server." + }, + "type": { + "type": "string", + "description": "type of the server" + } + }, + "description": "Represents a resource name availability." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + } + }, + "description": "An error response from the Batch service." + } + }, + "parameters": { + "LocationNameParameter": { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the location.", + "x-ms-parameter-location": "method" + }, + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server.", + "x-ms-parameter-location": "method" + }, + "FirewallRuleNameParameter": { + "name": "firewallRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server firewall rule.", + "x-ms-parameter-location": "method" + }, + "ConfigurationNameParameter": { + "name": "configurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server configuration.", + "x-ms-parameter-location": "method" + }, + "MaintenanceWindowNameParameter": { + "name": "maintenanceWindowName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance window.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/readme.go.md b/specification/postgresql/resource-manager/readme.go.md index 76ec7d9c39f1..371cc48113e3 100644 --- a/specification/postgresql/resource-manager/readme.go.md +++ b/specification/postgresql/resource-manager/readme.go.md @@ -12,7 +12,7 @@ go: ``` yaml $(go) && $(multiapi) batch: - - tag: package-2020-02-14-privatepreview + - tag: package-2020-02-14-preview - tag: package-2020-01-01 - tag: package-2017-12-01-preview - tag: package-2017-12-01 @@ -20,10 +20,10 @@ batch: ### Tag: package-2020-02-14 and go -These settings apply only when `--tag=package-2020-02-14-privatepreview --go` is specified on the command line. +These settings apply only when `--tag=package-2020-02-14-preview --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag) == 'package-2020-02-14-privatepreview' && $(go) +``` yaml $(tag) == 'package-2020-02-14-preview' && $(go) rpname: postgresql namespace: postgresqlflexibleservers output-folder: $(go-sdk-folder)/services/preview/$(rpname)/mgmt/2020-02-14-preview/$(namespace) diff --git a/specification/postgresql/resource-manager/readme.md b/specification/postgresql/resource-manager/readme.md index 583f1c230d97..9ec87bd2f7a0 100644 --- a/specification/postgresql/resource-manager/readme.md +++ b/specification/postgresql/resource-manager/readme.md @@ -30,6 +30,16 @@ description: The Microsoft Azure management API provides create, read, update, a openapi-type: arm tag: package-2020-01-01 ``` +### Tag: package-2020-02-14-preview + +These settings apply only when `--tag=package-2020-02-14-preview` is specified on the command line. + + +``` yaml $(tag) == 'package-2020-02-14-preview' +input-file: +- Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json +``` + ### Tag: package-2020-02-14-privatepreview @@ -154,7 +164,7 @@ csharp: azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION namespace: Microsoft.Azure.Management.PostgreSQL - output-folder: $(csharp-sdks-folder)/postgresql/Microsoft.Azure.Management.PostgreSQL/src/Generated + output-folder: $(csharp-sdks-folder)/postgresql/Microsoft.Azure.Management.PostgreSQL/src/postgresql/Generated clear-output-folder: true ``` @@ -174,3 +184,36 @@ See configuration in [readme.java.md](./readme.java.md) See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md) +## Multi-API/Profile support for AutoRest v3 generators + +AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. + +This block is updated by an automatic script. Edits may be lost! + +``` yaml $(tag) == 'all-api-versions' /* autogenerated */ +# include the azure profile definitions from the standard location +require: $(this-folder)/../../../profiles/readme.md + +# all the input files across all versions +input-file: + - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/postgresql.json + - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/postgresql.json + - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2020-01-01-privatepreview/DataEncryptionKeys.json + - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json + - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2017-12-01/ServerSecurityAlertPolicies.json + - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2018-06-01/PrivateEndpointConnections.json + - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2018-06-01/PrivateLinkResources.json + - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2020-01-01/DataEncryptionKeys.json + - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json + - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2018-06-01-privatepreview/PrivateLinkResources.json + - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json + +``` + +If there are files that should not be in the `all-api-versions` set, +uncomment the `exclude-file` section below and add the file paths. + +``` yaml $(tag) == 'all-api-versions' +#exclude-file: +# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json +``` diff --git a/specification/postgresql/resource-manager/readme.python.md b/specification/postgresql/resource-manager/readme.python.md index 29ba59d0973c..a0c7fe2f1884 100644 --- a/specification/postgresql/resource-manager/readme.python.md +++ b/specification/postgresql/resource-manager/readme.python.md @@ -30,14 +30,14 @@ Generate all API versions currently shipped for this package ```yaml !$(track2) batch: - tag: package-2020-01-01 - - tag: package-2020-02-14-privatepreview + - tag: package-2020-02-14-preview ``` ```yaml $(track2) clear-output-folder: true batch: - tag: package-2020-01-01 - - tag: package-2020-02-14-privatepreview + - tag: package-2020-02-14-preview ``` ### Tag: package-2020-01-01 and python @@ -53,12 +53,12 @@ python: output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/postgresql ``` -### Tag: package-2020-02-14-privatepreview and python +### Tag: package-2020-02-14-preview and python -These settings apply only when `--tag=package-2020-02-14-privatepreview --python` is specified on the command line. +These settings apply only when `--tag=package-2020-02-14-preview --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2020-02-14-privatepreview' && $(python) +``` yaml $(tag) == 'package-2020-02-14-preview' && $(python) namespace: azure.mgmt.rdbms.postgresql_flexibleservers output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/postgresql_flexibleservers python: From 55df33f914aaf832198165ec3cfe0037f1166666 Mon Sep 17 00:00:00 2001 From: Phoenix He Date: Fri, 25 Sep 2020 11:53:19 +0800 Subject: [PATCH 138/164] Remove unnecessary folder (#10865) --- azure-rest-api-specs | 1 - 1 file changed, 1 deletion(-) delete mode 160000 azure-rest-api-specs diff --git a/azure-rest-api-specs b/azure-rest-api-specs deleted file mode 160000 index f83281b2fed8..000000000000 --- a/azure-rest-api-specs +++ /dev/null @@ -1 +0,0 @@ -Subproject commit f83281b2fed8011962c4e91b7b0270f6391a0832 From dbf54f4094b809ba6acb24820774bd3b565cb97d Mon Sep 17 00:00:00 2001 From: Xwang0515 Date: Fri, 25 Sep 2020 14:14:51 +0800 Subject: [PATCH 139/164] Add orc compression codec (#10886) Co-authored-by: Xiaojin Wang --- .../stable/2018-06-01/entityTypes/Dataset.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json index a573ecd8bde4..91ba33f55b96 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json @@ -908,7 +908,8 @@ "enum": [ "none", "zlib", - "snappy" + "snappy", + "lzo" ], "x-ms-enum": { "name": "orcCompressionCodec", From ca5ae6feebfd1333e9d3c1df9b17e44cb48698e2 Mon Sep 17 00:00:00 2001 From: JiaxingSong Date: Fri, 25 Sep 2020 15:16:47 +0800 Subject: [PATCH 140/164] Add MongoDbAtlas Source Connector in DataFactory (#10890) * mongodb atlas source * update Co-authored-by: Jiaxing Song --- .../2018-06-01/entityTypes/Dataset.json | 32 ++++++++++++++++ .../2018-06-01/entityTypes/LinkedService.json | 37 +++++++++++++++++++ .../2018-06-01/entityTypes/Pipeline.json | 34 +++++++++++++++++ 3 files changed, 103 insertions(+) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json index 91ba33f55b96..f822291740b8 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json @@ -1521,6 +1521,38 @@ "collectionName" ] }, + "MongoDbAtlasCollectionDataset": { + "x-ms-discriminator-value": "MongoDbAtlasCollection", + "description": "The MongoDB Atlas database dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "MongoDB Atlas database dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MongoDbAtlasCollectionDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MongoDbAtlasCollectionDatasetTypeProperties": { + "description": "MongoDB Atlas database dataset properties.", + "properties": { + "collection": { + "type": "object", + "description": "The collection name of the MongoDB Atlas database. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "collection" + ] + }, "MongoDbV2CollectionDataset": { "x-ms-discriminator-value": "MongoDbV2Collection", "description": "The MongoDB database dataset.", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index ac022366955a..adc9894777c5 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -2042,6 +2042,43 @@ "databaseName" ] }, + "MongoDbAtlasLinkedService": { + "x-ms-discriminator-value": "MongoDbAtlas", + "description": "Linked service for MongoDB Atlas data source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "MongoDB Atlas linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/MongoDbAtlasLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "MongoDbAtlasLinkedServiceTypeProperties": { + "description": "MongoDB Atlas linked service properties.", + "properties": { + "connectionString": { + "description": "The MongoDB Atlas connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "database": { + "type": "object", + "description": "The name of the MongoDB Atlas database that you want to access. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "connectionString", + "database" + ] + }, "MongoDbV2LinkedService": { "x-ms-discriminator-value": "MongoDbV2", "description": "Linked service for MongoDB data source.", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index 35aa8392c78c..7b100ca81dbd 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -2770,6 +2770,40 @@ } } }, + "MongoDbAtlasSource": { + "description": "A copy activity source for a MongoDB Atlas database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "filter": { + "type": "object", + "description": "Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string)." + }, + "cursorMethods": { + "description": "Cursor methods for Mongodb query", + "$ref": "#/definitions/MongoDbCursorMethodsProperties" + }, + "batchSize": { + "type": "object", + "description": "Specifies the number of documents to return in each batch of the response from MongoDB Atlas instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer)." + }, + "queryTimeout": { + "type": "object", + "description": "Query timeout. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, "MongoDbV2Source": { "description": "A copy activity source for a MongoDB database.", "type": "object", From 2a2233b0baf0246cd881711511802584efb92bd4 Mon Sep 17 00:00:00 2001 From: bganapa Date: Fri, 25 Sep 2020 00:19:07 -0700 Subject: [PATCH 141/164] Updating eventhub/resources specs path in profile (#10846) * Updating eventhub specs path in profile * removing checknamespaceavaialbility as there is no swagger spec * Updating resources api version --- profile/2020-09-01-hybrid.json | 68 ++++++++++++++++------------------ 1 file changed, 31 insertions(+), 37 deletions(-) diff --git a/profile/2020-09-01-hybrid.json b/profile/2020-09-01-hybrid.json index 9e91801fb7f8..4ba660dc88c7 100644 --- a/profile/2020-09-01-hybrid.json +++ b/profile/2020-09-01-hybrid.json @@ -212,37 +212,31 @@ "2017-04-01": [ { "resourceType": "checkNameAvailability", - "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json" + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/CheckNameAvailability.json" }, { "resourceType": "namespaces/authorizationRules", - "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json" + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/AuthorizationRules.json" }, { "resourceType": "namespaces/eventhubs", - "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json" + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/eventhubs.json" }, { "resourceType": "namespaces/eventhubs/authorizationRules", - "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json" + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/AuthorizationRules.json" }, { "resourceType": "namespaces/eventhubs/consumerGroups", - "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json" + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/consumergroups.json" }, { "resourceType": "operations", - "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json" + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/operations.json" }, { "resourceType": "sku", - "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json" - } - ], - "2015-08-01": [ - { - "resourceType": "checkNamespaceAvailability", - "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/EventHub.json" + "path":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/sku.json" } ] }, @@ -365,80 +359,80 @@ ] }, "microsoft.resources": { - "2019-10-01": [ + "2016-06-01": [ { - "resourceType": "subscriptions", - "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-06-01/subscriptions.json" + "resourceType": "subscriptions", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2016-06-01/subscriptions.json" }, { - "resourceType": "subscriptions/locations", - "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-06-01/subscriptions.json" + "resourceType": "subscriptions/locations", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2016-06-01/subscriptions.json" }, { - "resourceType": "tenants", - "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-06-01/subscriptions.json" + "resourceType": "tenants", + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2016-06-01/subscriptions.json" } - ], - "2018-05-01": [ + ], + "2019-10-01": [ { "resourceType": "deployments", - "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json" }, { "resourceType": "deployments/operations", - "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json" }, { "resourceType": "links", - "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json" }, { "resourceType": "locations", - "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json" }, { "resourceType": "operations", - "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json" }, { "resourceType": "providers", - "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json" }, { "resourceType": "resourceGroups", - "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json" }, { "resourceType": "resources", - "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json" }, { "resourceType": "subscriptions/operationresults", - "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json" }, { "resourceType": "subscriptions/providers", - "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json" }, { "resourceType": "subscriptions/resourceGroups", - "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json" }, { "resourceType": "subscriptions/resourceGroups/resources", - "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json" }, { "resourceType": "subscriptions/resources", - "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json" }, { "resourceType": "subscriptions/tagNames", - "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json" }, { "resourceType": "subscriptions/tagNames/tagValues", - "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json" + "path": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json" } ] }, From d5c85e954a6298bbf5a7db2eeb2d8c1bac1ffb24 Mon Sep 17 00:00:00 2001 From: Arcturus Date: Fri, 25 Sep 2020 16:23:55 +0800 Subject: [PATCH 142/164] Fix some bad output-folder (#10842) --- .../appconfiguration/resource-manager/readme.go.md | 2 +- .../baremetalinfrastructure/resource-manager/readme.go.md | 2 +- specification/billing/resource-manager/readme.go.md | 2 +- specification/cdn/resource-manager/readme.go.md | 2 +- .../containerservice/resource-manager/readme.go.md | 2 +- specification/cosmos-db/resource-manager/readme.go.md | 6 +++--- specification/hdinsight/resource-manager/readme.go.md | 2 +- specification/keyvault/data-plane/readme.go.md | 2 +- .../operationalinsights/resource-manager/readme.go.md | 2 +- specification/policyinsights/resource-manager/readme.go.md | 2 +- specification/servicefabric/resource-manager/readme.go.md | 2 +- specification/storage/resource-manager/readme.go.md | 2 +- specification/trafficmanager/resource-manager/readme.go.md | 2 +- 13 files changed, 15 insertions(+), 15 deletions(-) diff --git a/specification/appconfiguration/resource-manager/readme.go.md b/specification/appconfiguration/resource-manager/readme.go.md index 169e554cc7cc..8b9ca1624935 100644 --- a/specification/appconfiguration/resource-manager/readme.go.md +++ b/specification/appconfiguration/resource-manager/readme.go.md @@ -25,7 +25,7 @@ These settings apply only when `--tag=package-2020-06-01 --go` is specified on t Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2020-06-01' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-06-01/$(namespace) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-06-01/$(namespace) ``` ### Tag: package-2019-11-01-preview and go diff --git a/specification/baremetalinfrastructure/resource-manager/readme.go.md b/specification/baremetalinfrastructure/resource-manager/readme.go.md index 1157b0905cb3..1677cc7854ec 100644 --- a/specification/baremetalinfrastructure/resource-manager/readme.go.md +++ b/specification/baremetalinfrastructure/resource-manager/readme.go.md @@ -15,5 +15,5 @@ Please also specify `--go-sdks-folder=`. ``` yaml $(tag) == 'package-2020-05' && $(go) -output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-05-01/$(namespace) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-05-01-preview/$(namespace) ``` ### Tag: package-2018-11-preview and go diff --git a/specification/cdn/resource-manager/readme.go.md b/specification/cdn/resource-manager/readme.go.md index b53dccbfb0c7..a660c2a5dd61 100644 --- a/specification/cdn/resource-manager/readme.go.md +++ b/specification/cdn/resource-manager/readme.go.md @@ -29,7 +29,7 @@ These settings apply only when `--tag=package-2020-04 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2020-04' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-04-15/$(namespace) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-04-15/$(namespace) ``` ### Tag: package-2019-04 and go diff --git a/specification/containerservice/resource-manager/readme.go.md b/specification/containerservice/resource-manager/readme.go.md index 4ce9ad0f6647..6e2f1df6402d 100644 --- a/specification/containerservice/resource-manager/readme.go.md +++ b/specification/containerservice/resource-manager/readme.go.md @@ -171,7 +171,7 @@ Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2020-04' && $(go) -output-folder: $(go-sdk-folder)/services/cosmos-db/mgmt/2020-04-01/$(namespace) +output-folder: $(go-sdk-folder)/services/preview/cosmos-db/mgmt/2020-04-01-preview/$(namespace) ``` ### Tag: package-2020-03 and go @@ -45,7 +45,7 @@ These settings apply only when `--tag=package-2020-03 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2020-03' && $(go) -output-folder: $(go-sdk-folder)/services/cosmos-db/mgmt/2020-03-01/$(namespace) +output-folder: $(go-sdk-folder)/services/preview/cosmos-db/mgmt/2020-03-01/$(namespace) ``` ### Tag: package-2019-12 and go @@ -54,7 +54,7 @@ These settings apply only when `--tag=package-2019-12 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2019-12' && $(go) -output-folder: $(go-sdk-folder)/services/cosmos-db/mgmt/2019-12-12/$(namespace) +output-folder: $(go-sdk-folder)/services/preview/cosmos-db/mgmt/2019-12-12/$(namespace) ``` ### Tag: package-2019-08 and go diff --git a/specification/hdinsight/resource-manager/readme.go.md b/specification/hdinsight/resource-manager/readme.go.md index 0f22247259b0..c0639958fa2e 100644 --- a/specification/hdinsight/resource-manager/readme.go.md +++ b/specification/hdinsight/resource-manager/readme.go.md @@ -23,7 +23,7 @@ These settings apply only when `--tag=package-2018-06-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2018-06-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-06-01-preview/$(namespace) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-06-01/$(namespace) ``` ### Tag: package-2015-03-preview and go diff --git a/specification/keyvault/data-plane/readme.go.md b/specification/keyvault/data-plane/readme.go.md index 4da1caa5e2cb..051165621376 100644 --- a/specification/keyvault/data-plane/readme.go.md +++ b/specification/keyvault/data-plane/readme.go.md @@ -35,7 +35,7 @@ These settings apply only when `--tag=package-7.1 --go` is specified on the comm Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-7.1' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/v7.1/$(namespace) +output-folder: $(go-sdk-folder)/services/$(namespace)/v7.1/$(namespace) ``` ### Tag: package-7.0 and go diff --git a/specification/operationalinsights/resource-manager/readme.go.md b/specification/operationalinsights/resource-manager/readme.go.md index 94ee9c7a62d1..e1fe11bf0104 100644 --- a/specification/operationalinsights/resource-manager/readme.go.md +++ b/specification/operationalinsights/resource-manager/readme.go.md @@ -52,5 +52,5 @@ These settings apply only when `--tag=package-2020-08 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2020-08' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-08-01/$(namespace) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-08-01/$(namespace) ``` diff --git a/specification/policyinsights/resource-manager/readme.go.md b/specification/policyinsights/resource-manager/readme.go.md index fa3fa5126749..249c80b4f08a 100644 --- a/specification/policyinsights/resource-manager/readme.go.md +++ b/specification/policyinsights/resource-manager/readme.go.md @@ -23,7 +23,7 @@ These settings apply only when `--tag=package-2019-10 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2019-10' && $(go) -output-folder: $(go-sdk-folder)/services//$(namespace)/mgmt/2019-10-01/$(namespace) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2019-10-01-preview/$(namespace) ``` ### Tag: package-2018-07 and go diff --git a/specification/servicefabric/resource-manager/readme.go.md b/specification/servicefabric/resource-manager/readme.go.md index 866fdbb790d8..b47de2db193f 100644 --- a/specification/servicefabric/resource-manager/readme.go.md +++ b/specification/servicefabric/resource-manager/readme.go.md @@ -44,7 +44,7 @@ These settings apply only when `--tag=package-2018-02 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2018-02' && $(go) -output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-02-01/$(namespace) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-02-01-preview/$(namespace) ``` ### Tag: package-2017-07 and go diff --git a/specification/storage/resource-manager/readme.go.md b/specification/storage/resource-manager/readme.go.md index 6ecd43bc6a06..96bcfeb1d9fe 100644 --- a/specification/storage/resource-manager/readme.go.md +++ b/specification/storage/resource-manager/readme.go.md @@ -71,7 +71,7 @@ These settings apply only when `--tag=package-2018-07 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2018-07' && $(go) -output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-07-01/$(namespace) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-07-01-preview/$(namespace) ``` ### Tag: package-2018-03 and go diff --git a/specification/trafficmanager/resource-manager/readme.go.md b/specification/trafficmanager/resource-manager/readme.go.md index 5b0c808fa178..6bddd9848b3c 100644 --- a/specification/trafficmanager/resource-manager/readme.go.md +++ b/specification/trafficmanager/resource-manager/readme.go.md @@ -46,7 +46,7 @@ These settings apply only when `--tag=package-2018-02 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2018-02' && $(go) -output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-02-01/$(namespace) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-02-01-preview/$(namespace) ``` ### Tag: package-2017-09-preview and go From b25070fdb7ec15c8fc67599c073cba9100eb0ae6 Mon Sep 17 00:00:00 2001 From: Ruoxuan Wang <52271048+ruowan@users.noreply.github.com> Date: Fri, 25 Sep 2020 17:43:55 +0800 Subject: [PATCH 143/164] Create comment.yaml (#10941) --- .github/comment.yaml | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 .github/comment.yaml diff --git a/.github/comment.yaml b/.github/comment.yaml new file mode 100644 index 000000000000..f4a177fbf594 --- /dev/null +++ b/.github/comment.yaml @@ -0,0 +1,33 @@ +--- +- rule: + type: checkbox + keywords: + - "Removing API(s)" + - "Updating API in stable version" + onCheckedLabels: + - breakingChange + +- rule: + type: checkbox + keywords: + - "WaitForARMFeedback" + booleanFilterExpression: "!(ARMSignedOff||ARMChangesRequested||Approved-OkToMerge||WaitForARMRevisit)" + onCheckedLabels: + - WaitForARMFeedback + onCheckedComments: "Hi, @${PRAuthor} your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @${PRAssignee} " + +- rule: + type: checkbox + keywords: + - "I have reviewed the [documentation](https://aka.ms/ameonboard) for the workflow." + onCheckedComments: "Hi, @${PRAuthor} Thanks for your PR. I am workflow bot for review process. Here are some small tips.
  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. [How to fix?](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/ci-fix.md)

    • Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com" + +- rule: + type: label + label: breakingChange + onLabeledComments: "Hi @${PRAuthor}, one or multiple breaking change(s) is detected in your PR. Pls follow [breaking change policy](https://aka.ms/AzBreakingChangesPolicy) to request breaking change review and approval before proceeding swagger PR review. " + +- rule: + type: label + label: ApprovedOkToMerge + onLabeledComments: "Hi @${PRAuthor},Your PR is approved. Congratulations.
  • If your PR is in public repo (azure-rest-api-specs), PR assignee will merge all updates in the PR shortly afterwards; or pause the PR merge, you need to put on a label DoNotMerge to PR as soon as possible.
  • If your PR is in private repo (azure-rest-api-specs-pr), there won’t be PR merge. Please refer to this [wiki](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/205/RP-Scenarios-to-Contribute-to-Swagger?anchor=**public-repository-vs.-private-repository**) for further guidance on how to proceed.
    • " From ecfce0aaa7ca45d4951d323ab99bdb73e966d38c Mon Sep 17 00:00:00 2001 From: Eli Arbel Date: Fri, 25 Sep 2020 12:44:16 +0300 Subject: [PATCH 144/164] Add Microsoft.AutonomousDevelopmentPlatform 2020-07-01-preview (#10925) * New Readme Config File * New Go Language Readme Config File * New Typescript Language Readme Config File * New Python Language Readme Config File * New C# Language Readme Config File * New Ruby Language Readme Config File * New Swagger Spec File * New Swagger Example Spec File * Add ADP 2020-07-01-preview * Fix type/prettier * Update readmes * Add az cli; fix Python * Add provisioningState property * Fix Python --- .../preview/2020-07-01-preview/adp.json | 1038 +++++++++++++++++ .../examples/AdpAccountDelete.json | 13 + .../examples/AdpAccountGet.json | 22 + .../examples/AdpAccountPatch.json | 33 + .../examples/AdpAccountPut.json | 34 + .../examples/AdpAccountsList.json | 26 + .../AdpAccountsListByResourceGroup.json | 26 + .../examples/AdpDataPoolDelete.json | 14 + .../examples/AdpDataPoolGet.json | 26 + .../examples/AdpDataPoolPatch.json | 48 + .../examples/AdpDataPoolPut.json | 48 + .../examples/AdpDataPoolsList.json | 30 + .../examples/AdpOperationsList.json | 40 + .../adp/resource-manager/readme.az.md | 12 + .../adp/resource-manager/readme.cli.md | 6 + .../adp/resource-manager/readme.csharp.md | 14 + .../adp/resource-manager/readme.go.md | 19 + specification/adp/resource-manager/readme.md | 81 ++ .../adp/resource-manager/readme.python.md | 35 + .../adp/resource-manager/readme.ruby.md | 25 + .../adp/resource-manager/readme.typescript.md | 14 + 21 files changed, 1604 insertions(+) create mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/adp.json create mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountDelete.json create mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountGet.json create mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPatch.json create mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPut.json create mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsList.json create mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsListByResourceGroup.json create mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolDelete.json create mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolGet.json create mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPatch.json create mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPut.json create mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolsList.json create mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpOperationsList.json create mode 100644 specification/adp/resource-manager/readme.az.md create mode 100644 specification/adp/resource-manager/readme.cli.md create mode 100644 specification/adp/resource-manager/readme.csharp.md create mode 100644 specification/adp/resource-manager/readme.go.md create mode 100644 specification/adp/resource-manager/readme.md create mode 100644 specification/adp/resource-manager/readme.python.md create mode 100644 specification/adp/resource-manager/readme.ruby.md create mode 100644 specification/adp/resource-manager/readme.typescript.md diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/adp.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/adp.json new file mode 100644 index 000000000000..91eededc55bc --- /dev/null +++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/adp.json @@ -0,0 +1,1038 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-07-01-preview", + "title": "adp", + "description": "Microsoft Autonomous Development Platform" + }, + "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.AutonomousDevelopmentPlatform/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Autonomous Development Platform provider operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "List operations": { + "$ref": "./examples/AdpOperationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_List", + "description": "List all ADP accounts available under the subscription", + "x-ms-examples": { + "List accounts": { + "$ref": "./examples/AdpAccountsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_ListByResourceGroup", + "description": "List all ADP accounts available under the resource group", + "x-ms-examples": { + "List accounts by resource group": { + "$ref": "./examples/AdpAccountsListByResourceGroup.json" + } + }, + "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" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/{accountName}": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_Get", + "description": "Gets the properties of an ADP account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The ADP account properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get account": { + "$ref": "./examples/AdpAccountGet.json" + } + } + }, + "patch": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_Update", + "x-ms-long-running-operation": true, + "description": "Updates the properties of an existing ADP account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The parameters to provide for the current ADP account.", + "schema": { + "$ref": "#/definitions/AccountPatch" + } + } + ], + "responses": { + "200": { + "description": "The resource was updated successfully.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "201": { + "description": "The resource will be updated asynchronously.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch account": { + "$ref": "./examples/AdpAccountPatch.json" + } + } + }, + "put": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_CreateOrUpdate", + "description": "Creates or updates an ADP account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The parameters to provide for the ADP account.", + "schema": { + "$ref": "#/definitions/Account" + } + } + ], + "responses": { + "200": { + "description": "The ADP account was successfully updated.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "201": { + "description": "The resource will be updated asynchronously.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Put account": { + "$ref": "./examples/AdpAccountPut.json" + } + } + }, + "delete": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_Delete", + "description": "Deletes an ADP account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The ADP account was successfully deleted." + }, + "201": { + "description": "The ADP account will be deleted asynchronously." + }, + "204": { + "description": "The ADP account does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete account": { + "$ref": "./examples/AdpAccountDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/{accountName}/dataPools": { + "get": { + "tags": [ + "DataPools" + ], + "operationId": "DataPools_List", + "description": "Lists the data pools under the ADP account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of data pools that was successfully retrieved.", + "schema": { + "$ref": "#/definitions/DataPoolList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Data Pools": { + "$ref": "./examples/AdpDataPoolsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/{accountName}/dataPools/{dataPoolName}": { + "get": { + "tags": [ + "DataPools" + ], + "operationId": "DataPools_Get", + "description": "Gets the properties of a Data Pool.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/DataPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Data Pool that was successfully retrieved.", + "schema": { + "$ref": "#/definitions/DataPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Data Pool": { + "$ref": "./examples/AdpDataPoolGet.json" + } + } + }, + "patch": { + "tags": [ + "DataPools" + ], + "operationId": "DataPools_Update", + "description": "Updates the properties of an existing Data Pool.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/DataPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The parameters to provide for the Data Pool.", + "schema": { + "$ref": "#/definitions/DataPoolPatch" + } + } + ], + "responses": { + "200": { + "description": "The Data Pool was updated successfully.", + "schema": { + "$ref": "#/definitions/DataPool" + } + }, + "201": { + "description": "The Data Pool will be updated asynchronously.", + "schema": { + "$ref": "#/definitions/DataPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Data Pool": { + "$ref": "./examples/AdpDataPoolPatch.json" + } + } + }, + "put": { + "tags": [ + "DataPools" + ], + "operationId": "DataPools_CreateOrUpdate", + "description": "Creates or updates a Data Pool.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/DataPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The parameters to provide for the Data Pool.", + "schema": { + "$ref": "#/definitions/DataPool" + } + } + ], + "responses": { + "200": { + "description": "The Data Pool was successfully updated.", + "schema": { + "$ref": "#/definitions/DataPool" + } + }, + "201": { + "description": "The Data Pool will be updated asynchronously.", + "schema": { + "$ref": "#/definitions/DataPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Put Data Pool": { + "$ref": "./examples/AdpDataPoolPut.json" + } + } + }, + "delete": { + "tags": [ + "DataPools" + ], + "operationId": "DataPools_Delete", + "description": "Deletes a Data Pool.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/DataPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Data Pool was successfully deleted." + }, + "201": { + "description": "The Data Pool will be deleted asynchronously." + }, + "204": { + "description": "The Data Pool does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Data Pool": { + "$ref": "./examples/AdpDataPoolDelete.json" + } + } + } + } + }, + "definitions": { + "Tags": { + "description": "Resource tags", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + } + }, + "Account": { + "description": "An ADP account.", + "type": "object", + "properties": { + "properties": { + "description": "List of account properties", + "type": "object", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccountProperties" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ] + }, + "AccountPatch": { + "description": "An ADP account.", + "type": "object", + "properties": { + "properties": { + "description": "List of account properties", + "type": "object", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccountProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Tags" + } + ] + }, + "AccountProperties": { + "description": "ADP account properties", + "properties": { + "accountId": { + "description": "The account's data-plane ID", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the account at the time the operation was called.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Deleting" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + } + } + }, + "AccountList": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Account" + }, + "description": "List of accounts and their properties." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + }, + "description": "The list operation response, that contains the data pools and their properties." + }, + "DataPool": { + "description": "An ADP Data Pool.", + "properties": { + "properties": { + "description": "List of data pool properties", + "type": "object", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DataPoolProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ] + }, + "DataPoolPatch": { + "description": "An ADP Data Pool.", + "properties": { + "properties": { + "description": "List of data pool properties", + "type": "object", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DataPoolBaseProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ] + }, + "DataPoolBaseProperties": { + "description": "Data Pool properties", + "properties": { + "dataPoolId": { + "description": "The Data Pool's data-plane ID", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the data pool at the time the operation was called.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Deleting" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "locations": { + "type": "array", + "items": { + "$ref": "#/definitions/DataPoolLocation" + }, + "minItems": 1, + "description": "Gets or sets the collection of locations where Data Pool resources should be created." + } + } + }, + "DataPoolProperties": { + "description": "Data Pool properties", + "allOf": [ + { + "$ref": "#/definitions/DataPoolBaseProperties" + } + ], + "required": [ + "locations" + ] + }, + "DataPoolLocation": { + "description": "Location of a Data Pool", + "properties": { + "name": { + "description": "The location name", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "DataPoolList": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DataPool" + }, + "description": "List of data pools and their properties." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + }, + "description": "The list operation response, that contains the data pools and their properties." + }, + "Operation": { + "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" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Properties of the operation", + "x-ms-client-flatten": true + } + } + }, + "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" + } + } + }, + "OperationProperties": { + "description": "Additional details about an operation.", + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "serviceSpecification": { + "description": "Details about a service operation.", + "$ref": "#/definitions/OperationServiceSpecification" + } + } + }, + "OperationServiceSpecification": { + "description": "Details about a service operation.", + "type": "object", + "properties": { + "logSpecifications": { + "description": "Details about operations related to logs.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationLogSpecification" + } + }, + "metricSpecifications": { + "description": "Details about operations related to metrics.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationMetricSpecification" + } + } + } + }, + "OperationLogSpecification": { + "description": "Details about an operation related to logs.", + "type": "object", + "properties": { + "name": { + "description": "The name of the log category.", + "type": "string" + }, + "displayName": { + "description": "Localized display name.", + "type": "string" + }, + "blobDuration": { + "description": "Blobs created in the customer storage account, per hour.", + "type": "string" + } + } + }, + "OperationMetricSpecification": { + "description": "Details about an operation related to metrics.", + "type": "object", + "properties": { + "name": { + "description": "The name of the metric.", + "type": "string" + }, + "displayName": { + "description": "Localized display name of the metric.", + "type": "string" + }, + "displayDescription": { + "description": "The description of the metric.", + "type": "string" + }, + "unit": { + "description": "The unit that the metric is measured in.", + "type": "string" + }, + "aggregationType": { + "description": "The type of metric aggregation.", + "type": "string" + }, + "enableRegionalMdmAccount": { + "description": "Whether or not the service is using regional MDM accounts.", + "type": "string" + }, + "sourceMdmAccount": { + "description": "The name of the MDM account.", + "type": "string" + }, + "sourceMdmNamespace": { + "description": "The name of the MDM namespace.", + "type": "string" + }, + "availabilities": { + "description": "Defines how often data for metrics becomes available.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationMetricAvailability" + } + } + } + }, + "OperationMetricAvailability": { + "description": "Defines how often data for a metric becomes available.", + "type": "object", + "properties": { + "timeGrain": { + "description": "The granularity for the metric.", + "type": "string" + }, + "blobDuration": { + "description": "Blob created in the customer storage account, per hour.", + "type": "string" + } + } + }, + "OperationListResult": { + "description": "Available operations of the service.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "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." + } + } + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDefinition", + "description": "The error details." + } + } + }, + "ErrorDefinition": { + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Internal error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDefinition" + }, + "readOnly": true + } + } + } + }, + "parameters": { + "AccountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ADP account.", + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*", + "maxLength": 50, + "x-ms-parameter-location": "method" + }, + "DataPoolNameParameter": { + "name": "dataPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Pool.", + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*", + "maxLength": 50, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountDelete.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountDelete.json new file mode 100644 index 000000000000..d6e9aa9488b2 --- /dev/null +++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "adpClient", + "api-version": "2020-07-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "201": {}, + "204": {} + } +} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountGet.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountGet.json new file mode 100644 index 000000000000..b26fb2fd4abb --- /dev/null +++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "adpClient", + "api-version": "2020-07-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", + "name": "adp1", + "location": "Global", + "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", + "tags": {}, + "properties": { + "accountId": "id" + } + } + } + } +} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPatch.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPatch.json new file mode 100644 index 000000000000..52f5a7518d75 --- /dev/null +++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPatch.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "adpClient", + "api-version": "2020-07-01-preview", + "subscriptionId": "subid", + "parameters": { + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", + "name": "adp1", + "location": "Global", + "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", + "tags": {}, + "properties": {} + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", + "name": "adp1", + "location": "Global", + "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", + "tags": {}, + "properties": {} + } + } + } +} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPut.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPut.json new file mode 100644 index 000000000000..2eb9a55173d3 --- /dev/null +++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPut.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "adpClient", + "api-version": "2020-07-01-preview", + "subscriptionId": "subid", + "parameters": { + "location": "Global", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", + "name": "adp1", + "location": "Global", + "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", + "tags": {}, + "properties": {} + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", + "name": "adp1", + "location": "Global", + "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", + "tags": {}, + "properties": {} + } + } + } +} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsList.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsList.json new file mode 100644 index 000000000000..ec1224c955e4 --- /dev/null +++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsList.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceGroupName": "adpClient", + "api-version": "2020-07-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", + "name": "adp1", + "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", + "location": "Global", + "tags": {}, + "properties": { + "accountId": "id" + } + } + ], + "nextLink": "link" + } + } + } +} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsListByResourceGroup.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsListByResourceGroup.json new file mode 100644 index 000000000000..d3a341af516f --- /dev/null +++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsListByResourceGroup.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2020-07-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "adpClient" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", + "name": "adp1", + "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", + "location": "Global", + "tags": {}, + "properties": { + "accountId": "id" + } + } + ], + "nextLink": "link" + } + } + } +} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolDelete.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolDelete.json new file mode 100644 index 000000000000..b07fcf338e68 --- /dev/null +++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "accountName": "sampleacct", + "dataPoolName": "sampledp", + "resourceGroupName": "adpClient", + "api-version": "2020-07-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "201": {}, + "204": {} + } +} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolGet.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolGet.json new file mode 100644 index 000000000000..6be7714e47a0 --- /dev/null +++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "accountName": "sampleacct", + "dataPoolName": "sampledp", + "resourceGroupName": "adpClient", + "api-version": "2020-07-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", + "name": "dp1", + "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", + "properties": { + "dataPoolId": "id", + "locations": [ + { + "name": "westus" + } + ] + } + } + } + } +} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPatch.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPatch.json new file mode 100644 index 000000000000..3e1343f70936 --- /dev/null +++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPatch.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "accountName": "sampleacct", + "dataPoolName": "sampledp", + "resourceGroupName": "adpClient", + "api-version": "2020-07-01-preview", + "subscriptionId": "subid", + "parameters": { + "properties": { + "locations": [ + { + "name": "westus" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", + "name": "dp1", + "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", + "properties": { + "locations": [ + { + "name": "westus" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", + "name": "dp1", + "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", + "properties": { + "locations": [ + { + "name": "westus" + } + ] + } + } + } + } +} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPut.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPut.json new file mode 100644 index 000000000000..3e1343f70936 --- /dev/null +++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPut.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "accountName": "sampleacct", + "dataPoolName": "sampledp", + "resourceGroupName": "adpClient", + "api-version": "2020-07-01-preview", + "subscriptionId": "subid", + "parameters": { + "properties": { + "locations": [ + { + "name": "westus" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", + "name": "dp1", + "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", + "properties": { + "locations": [ + { + "name": "westus" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", + "name": "dp1", + "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", + "properties": { + "locations": [ + { + "name": "westus" + } + ] + } + } + } + } +} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolsList.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolsList.json new file mode 100644 index 000000000000..61c1d13a4930 --- /dev/null +++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolsList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "adpClient", + "api-version": "2020-07-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", + "name": "dp1", + "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", + "properties": { + "dataPoolId": "id", + "locations": [ + { + "name": "westus" + } + ] + } + } + ], + "nextLink": "link" + } + } + } +} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpOperationsList.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpOperationsList.json new file mode 100644 index 000000000000..e2f05ce8376f --- /dev/null +++ b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpOperationsList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2020-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AutonomousDevelopmentPlatform/accounts/read", + "display": { + "provider": "Microsoft Autonomous Development Platform", + "resource": "Account", + "operation": "Read accounts", + "description": "Read accounts" + } + }, + { + "name": "Microsoft.AutonomousDevelopmentPlatform/accounts/write", + "display": { + "provider": "Microsoft Autonomous Development Platform", + "resource": "Account", + "operation": "Update accounts", + "description": "Update accounts" + } + }, + { + "name": "Microsoft.AutonomousDevelopmentPlatform/accounts/delete", + "display": { + "provider": "Microsoft Autonomous Development Platform", + "resource": "Account", + "operation": "Delete accounts", + "description": "Delete accounts" + } + } + ] + } + } + } +} diff --git a/specification/adp/resource-manager/readme.az.md b/specification/adp/resource-manager/readme.az.md new file mode 100644 index 000000000000..ad394bde867b --- /dev/null +++ b/specification/adp/resource-manager/readme.az.md @@ -0,0 +1,12 @@ +## AZ + +These settings apply only when `--az` is specified on the command line. + +``` yaml $(az) && $(target-mode) != 'core' +az: + extensions: adp + namespace: azure.mgmt.adp + package-name: azure-mgmt-adp +az-output-folder: $(azure-cli-extension-folder)/src/adp +python-sdk-output-folder: "$(az-output-folder)/azext_adp/vendored_sdks/adp" +``` diff --git a/specification/adp/resource-manager/readme.cli.md b/specification/adp/resource-manager/readme.cli.md new file mode 100644 index 000000000000..bd1ae237a340 --- /dev/null +++ b/specification/adp/resource-manager/readme.cli.md @@ -0,0 +1,6 @@ +## CLI + +These settings don't need to apply `--cli` on the command line. + +``` yaml +``` diff --git a/specification/adp/resource-manager/readme.csharp.md b/specification/adp/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..5ed6552b1f8c --- /dev/null +++ b/specification/adp/resource-manager/readme.csharp.md @@ -0,0 +1,14 @@ +## C + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + namespace: Microsoft.Azure.Management.AutonomousDevelopmentPlatform + output-folder: $(csharp-sdks-folder)/adp/Microsoft.Azure.Management.AutonomousDevelopmentPlatform/Generated +``` diff --git a/specification/adp/resource-manager/readme.go.md b/specification/adp/resource-manager/readme.go.md new file mode 100644 index 000000000000..428c70e15dbb --- /dev/null +++ b/specification/adp/resource-manager/readme.go.md @@ -0,0 +1,19 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: adp + clear-output-folder: true +``` + +### Tag: package-2020-07-01-preview and go + +These settings apply only when `--tag=package-2020-07-01-preview --go` is specified on the command line. +Please also specify `--go-sdks-folder=`. + +```yaml $(tag) == 'package-2020-07-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/adp/mgmt/2019-07-01-preview +``` diff --git a/specification/adp/resource-manager/readme.md b/specification/adp/resource-manager/readme.md new file mode 100644 index 000000000000..fbcf3b99cb44 --- /dev/null +++ b/specification/adp/resource-manager/readme.md @@ -0,0 +1,81 @@ +# adp + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for adp. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the adp. + +```yaml +title: AdpManagementClient +openapi-type: arm +tag: package-2020-07-01-preview +``` + +### Tag: package-2020-07-01-preview + +These settings apply only when `--tag=package-2020-07-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2020-07-01-preview' +input-file: + - Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/adp.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_adp'] + - repo: azure-cli-extensions +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Ruby + +See configuration in [readme.ruby.md](./readme.ruby.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) diff --git a/specification/adp/resource-manager/readme.python.md b/specification/adp/resource-manager/readme.python.md new file mode 100644 index 000000000000..07758b81e1ea --- /dev/null +++ b/specification/adp/resource-manager/readme.python.md @@ -0,0 +1,35 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +```yaml $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-adp +clear-output-folder: true +no-namespace-folders: true +modelerfour: + lenient-model-deduplication: true +``` + +```yaml $(multiapi) +clear-output-folder: true +batch: + - tag: package-2020-07-01-preview + - multiapiscript: true +``` + +``` yaml $(multiapiscript) +output-folder: $(python-sdks-folder)/adp/azure-mgmt-adp/azure/mgmt/adp/ +clear-output-folder: false +perform-load: false +``` + +``` yaml $(tag) == 'package-2020-07-01-preview' +namespace: azure.mgmt.adp.v2020_07_01_preview +output-folder: $(python-sdks-folder)/adp/azure-mgmt-adp/azure/mgmt/adp/v2020_07_01_preview +python: + namespace: azure.mgmt.adp.v2020_07_01_preview + output-folder: $(python-sdks-folder)/adp/azure-mgmt-adp/azure/mgmt/adp/v2020_07_01_preview +``` diff --git a/specification/adp/resource-manager/readme.ruby.md b/specification/adp/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..cedab1ae4f5d --- /dev/null +++ b/specification/adp/resource-manager/readme.ruby.md @@ -0,0 +1,25 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +```yaml +package-name: azure_mgmt_adp +package-version: 2020-07-01-preview +azure-arm: true +``` + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2020-07-01-preview +``` + + +### Tag: package-2020-07-01-preview and ruby + +These settings apply only when `--tag=package-2020-07-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2020-07-01-preview' && $(ruby) +namespace: Azure::AutonomousDevelopmentPlatform::Mgmt::V2020_07_01_preview +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_adp/lib +``` diff --git a/specification/adp/resource-manager/readme.typescript.md b/specification/adp/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..5bc90c6d3cbd --- /dev/null +++ b/specification/adp/resource-manager/readme.typescript.md @@ -0,0 +1,14 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +```yaml $(typescript) +typescript: + azure-arm: true + package-name: "adp" + output-folder: "$(typescript-sdks-folder)/sdk/adp/arm-adp" + payload-flattening-threshold: 1 + generate-metadata: true + override-client-name: AdpManagementClient +``` From 94f375d1a13560aafd9b58cba3163916468a6ca9 Mon Sep 17 00:00:00 2001 From: JianyeXi <59603451+jianyexi@users.noreply.github.com> Date: Fri, 25 Sep 2020 17:50:56 +0800 Subject: [PATCH 145/164] Update issue_assignment.yml for OOF (#10942) * Update issue_assignment.yml * Update pull_request_assignment.yml --- .github/issue_assignment.yml | 1 - .github/pull_request_assignment.yml | 1 - 2 files changed, 2 deletions(-) diff --git a/.github/issue_assignment.yml b/.github/issue_assignment.yml index a33797d7ddb7..7347c318e629 100644 --- a/.github/issue_assignment.yml +++ b/.github/issue_assignment.yml @@ -19,4 +19,3 @@ - qianwens - ruowan - MyronFanQiu - - jianyexi diff --git a/.github/pull_request_assignment.yml b/.github/pull_request_assignment.yml index abdb98fcfd0c..545caea8b069 100644 --- a/.github/pull_request_assignment.yml +++ b/.github/pull_request_assignment.yml @@ -152,4 +152,3 @@ - leni-msft - qianwens - ruowan - - jianyexi From ec4e7927a0d4b5d155d3d7a35cc436b96afefb8c Mon Sep 17 00:00:00 2001 From: Ray Chen Date: Fri, 25 Sep 2020 18:04:21 +0800 Subject: [PATCH 146/164] Update pull_request_assignment.yml (#10946) --- .github/pull_request_assignment.yml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/.github/pull_request_assignment.yml b/.github/pull_request_assignment.yml index 545caea8b069..02ee93e0fdc2 100644 --- a/.github/pull_request_assignment.yml +++ b/.github/pull_request_assignment.yml @@ -29,11 +29,6 @@ - fengzhou-msft - yungezz -- rule: - paths: "specification/@(resources|powerplatform)/**" - reviewers: - - raych1 - - rule: paths: - "specification/machinelearningservices/**" @@ -139,7 +134,6 @@ - yungezz - erich-wang - NullMDR - - raych1 - lirenhe - weidongxu-microsoft - ArcturusZhang From d61b283066c03650ad434e62c29f9e1c2633673a Mon Sep 17 00:00:00 2001 From: Jennifer Marsman Date: Fri, 25 Sep 2020 17:18:48 -0400 Subject: [PATCH 147/164] Adding indexing parameters to the swagger for Cognitive Search (#10349) * Removed color and imageType from the visualFeature enumeration in the V2 SDK. These weren't referenced in the examples. * Added indexing parameters to the swagger for Cognitive Search * Moved properties under configuration * Removed bad formatting so JSON is valid * Added 3 words to custom-words list * Marking IndexingParameter extra properties as not required * Removed duplicate type definitions with $ref, changed default values to false for failOn* properties, and removed en-us locale from URL * Add swagger spec for indexer execution environment * Change the default value to 'standard' * Updating 2020 API swaggers with IndexingParameters in Cognitive Search * Add swagger spec for indexer execution environment in 2 new API versions * Added default value for queryTimeout parameter * Removing indexing parameter changes from 2019-05-06-preview version of swagger * Removed x-nullable from indexing parameter enums * Removed the required: false since everything is optional/not required by default * Marked batchSize, maxFailedItems, and maxFailedItemsPerBatch as x-nullable * Added x-nullable to configuration parameters * Added indexing parameters to the swagger for Cognitive Search * Moved properties under configuration * Removed bad formatting so JSON is valid * Added 3 words to custom-words list * Marking IndexingParameter extra properties as not required * Removed duplicate type definitions with $ref, changed default values to false for failOn* properties, and removed en-us locale from URL * Add swagger spec for indexer execution environment * Change the default value to 'standard' * Updating 2020 API swaggers with IndexingParameters in Cognitive Search * Add swagger spec for indexer execution environment in 2 new API versions * Added default value for queryTimeout parameter * Removing indexing parameter changes from 2019-05-06-preview version of swagger * Removed x-nullable from indexing parameter enums * Removed the required: false since everything is optional/not required by default * Marked batchSize, maxFailedItems, and maxFailedItemsPerBatch as x-nullable * Added x-nullable to configuration parameters * Removed duplicate x-nullable since someone else also added them * Revert "Added x-nullable to configuration parameters" This reverts commit 732f032fdc77c2314ab29a270818d2af1e1ec42f. * Added default values for excludedFileNameExtensions and indexedFileNameExtensions * Moved indexing parameters configuration to a separate model not under configuration * Referencing the IndexingParametersConfiguration from configuration Co-authored-by: Arvind Krishnaa Jagannathan --- custom-words.txt | 3 + .../2020-06-30-Preview/searchservice.json | 251 +++++++++++++++++- .../preview/2020-06-30/searchservice.json | 251 +++++++++++++++++- 3 files changed, 493 insertions(+), 12 deletions(-) diff --git a/custom-words.txt b/custom-words.txt index 6aa19385dc88..2c42408cbe55 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1159,6 +1159,7 @@ Paypal PBIE PCIE PCNET +PDFs peerings Pendingissuance Pendingrevocation @@ -1204,6 +1205,7 @@ powerbidedicated powerbiembedded poweredoff poweroff +pptx prebackup prebackupvalidation prebuilts @@ -1739,6 +1741,7 @@ unparsed unprepare unprepares unpreparing +Unprocessable Unprovision unprovisioned Unprovisioning diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json index ff607b71c3b9..789da827e4d3 100644 --- a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json @@ -5779,14 +5779,253 @@ "description": "The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0." }, "configuration": { - "type": "object", - "additionalProperties": { - "type": "object" - }, - "description": "A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type." + "$ref": "#/definitions/IndexingParametersConfiguration" + } + }, + "description": "Represents parameters for indexer execution.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/create-indexer#parameters" + } + }, + "IndexingParametersConfiguration": { + "type": "object", + "properties": { + "parsingMode": { + "$ref": "#/definitions/ParsingMode" + }, + "excludedFileNameExtensions": { + "type": "string", + "default": "", + "description": "Comma-delimited list of filename extensions to ignore when processing from Azure blob storage. For example, you could exclude \".png, .mp4\" to skip over those files during indexing." + }, + "indexedFileNameExtensions": { + "type": "string", + "default": "", + "description": "Comma-delimited list of filename extensions to select when processing from Azure blob storage. For example, you could focus indexing on specific application files \".docx, .pptx, .msg\" to specifically include those file types." + }, + "failOnUnsupportedContentType": { + "type": "boolean", + "default": false, + "description": "For Azure blobs, set to false if you want to continue indexing when an unsupported content type is encountered, and you don't know all the content types (file extensions) in advance." + }, + "failOnUnprocessableDocument": { + "type": "boolean", + "default": false, + "description": "For Azure blobs, set to false if you want to continue indexing if a document fails indexing." + }, + "indexStorageMetadataOnlyForOversizedDocuments": { + "type": "boolean", + "default": false, + "description": "For Azure blobs, set this property to true to still index storage metadata for blob content that is too large to process. Oversized blobs are treated as errors by default. For limits on blob size, see https://docs.microsoft.com/azure/search/search-limits-quotas-capacity." + }, + "delimitedTextHeaders": { + "type": "string", + "description": "For CSV blobs, specifies a comma-delimited list of column headers, useful for mapping source fields to destination fields in an index." + }, + "delimitedTextDelimiter": { + "type": "string", + "description": "For CSV blobs, specifies the end-of-line single-character delimiter for CSV files where each line starts a new document (for example, \"|\")." + }, + "firstLineContainsHeaders": { + "type": "boolean", + "default": true, + "description": "For CSV blobs, indicates that the first (non-blank) line of each blob contains headers." + }, + "documentRoot": { + "type": "string", + "description": "For JSON arrays, given a structured or semi-structured document, you can specify a path to the array using this property." + }, + "dataToExtract": { + "$ref": "#/definitions/DataToExtract" + }, + "imageAction": { + "$ref": "#/definitions/ImageAction" + }, + "allowSkillsetToReadFileData": { + "type": "boolean", + "default": false, + "description": "If true, will create a path //document//file_data that is an object representing the original file data downloaded from your blob data source. This allows you to pass the original file data to a custom skill for processing within the enrichment pipeline, or to the Document Extraction skill." + }, + "pdfTextRotationAlgorithm": { + "$ref": "#/definitions/PdfTextRotationAlgorithm" + }, + "executionEnvironment": { + "$ref": "#/definitions/ExecutionEnvironment" + }, + "queryTimeout": { + "type": "string", + "default": "00:05:00", + "description": "Increases the timeout beyond the 5-minute default for Azure SQL database data sources, specified in the format \"hh:mm:ss\"." } }, - "description": "Represents parameters for indexer execution." + "additionalProperties": { + "type": "object" + }, + "description": "A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/create-indexer#parameters" + } + }, + "ParsingMode": { + "type": "string", + "enum": [ + "default", + "text", + "delimitedText", + "json", + "jsonArray", + "jsonLines" + ], + "x-ms-enum": { + "name": "BlobIndexerParsingMode", + "modelAsString": true, + "values": [ + { + "value": "default", + "name": "Default", + "description": "Set to default for normal file processing." + }, + { + "value": "text", + "name": "Text", + "description": "Set to text to improve indexing performance on plain text files in blob storage." + }, + { + "value": "delimitedText", + "name": "DelimitedText", + "description": "Set to delimitedText when blobs are plain CSV files." + }, + { + "value": "json", + "name": "Json", + "description": "Set to json to extract structured content from JSON files." + }, + { + "value": "jsonArray", + "name": "JsonArray", + "description": "Set to jsonArray to extract individual elements of a JSON array as separate documents in Azure Cognitive Search." + }, + { + "value": "jsonLines", + "name": "JsonLines", + "description": "Set to jsonLines to extract individual JSON entities, separated by a new line, as separate documents in Azure Cognitive Search." + } + ] + }, + "default": "default", + "description": "Represents the parsing mode for indexing from an Azure blob data source." + }, + "DataToExtract": { + "type": "string", + "enum": [ + "storageMetadata", + "allMetadata", + "contentAndMetadata" + ], + "x-ms-enum": { + "name": "BlobIndexerDataToExtract", + "modelAsString": true, + "values": [ + { + "value": "storageMetadata", + "name": "StorageMetadata", + "description": "Indexes just the standard blob properties and user-specified metadata." + }, + { + "value": "allMetadata", + "name": "AllMetadata", + "description": "Extracts metadata provided by the Azure blob storage subsystem and the content-type specific metadata (for example, metadata unique to just .png files are indexed)." + }, + { + "value": "contentAndMetadata", + "name": "ContentAndMetadata", + "description": "Extracts all metadata and textual content from each blob." + } + ] + }, + "default": "contentAndMetadata", + "description": "Specifies the data to extract from Azure blob storage and tells the indexer which data to extract from image content when \"imageAction\" is set to a value other than \"none\". This applies to embedded image content in a .PDF or other application, or image files such as .jpg and .png, in Azure blobs." + }, + "ImageAction": { + "type": "string", + "enum": [ + "none", + "generateNormalizedImages", + "generateNormalizedImagePerPage" + ], + "x-ms-enum": { + "name": "BlobIndexerImageAction", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Ignores embedded images or image files in the data set. This is the default." + }, + { + "value": "generateNormalizedImages", + "name": "GenerateNormalizedImages", + "description": "Extracts text from images (for example, the word \"STOP\" from a traffic stop sign), and embeds it into the content field. This action requires that \"dataToExtract\" is set to \"contentAndMetadata\". A normalized image refers to additional processing resulting in uniform image output, sized and rotated to promote consistent rendering when you include images in visual search results. This information is generated for each image when you use this option." + }, + { + "value": "generateNormalizedImagePerPage", + "name": "GenerateNormalizedImagePerPage", + "description": "Extracts text from images (for example, the word \"STOP\" from a traffic stop sign), and embeds it into the content field, but treats PDF files differently in that each page will be rendered as an image and normalized accordingly, instead of extracting embedded images. Non-PDF file types will be treated the same as if \"generateNormalizedImages\" was set." + } + ] + }, + "default": "none", + "description": "Determines how to process embedded images and image files in Azure blob storage. Setting the \"imageAction\" configuration to any value other than \"none\" requires that a skillset also be attached to that indexer." + }, + "PdfTextRotationAlgorithm": { + "type": "string", + "enum": [ + "none", + "detectAngles" + ], + "x-ms-enum": { + "name": "BlobIndexerPDFTextRotationAlgorithm", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Leverages normal text extraction. This is the default." + }, + { + "value": "detectAngles", + "name": "DetectAngles", + "description": "May produce better and more readable text extraction from PDF files that have rotated text within them. Note that there may be a small performance speed impact when this parameter is used. This parameter only applies to PDF files, and only to PDFs with embedded text. If the rotated text appears within an embedded image in the PDF, this parameter does not apply." + } + ] + }, + "default": "none", + "description": "Determines algorithm for text extraction from PDF files in Azure blob storage." + }, + "ExecutionEnvironment": { + "type": "string", + "enum": [ + "standard", + "private" + ], + "x-ms-enum": { + "name": "IndexerExecutionEnvironment", + "modelAsString": true, + "values": [ + { + "value": "standard", + "name": "standard", + "description": "Indicates that Azure Cognitive Search can determine where the indexer should execute. This is the default environment when nothing is specified and is the recommended value." + }, + { + "value": "private", + "name": "private", + "description": "Indicates that the indexer should run with the environment provisioned specifically for the search service. This should only be specified as the execution environment if the indexer needs to access resources securely over shared private link resources." + } + ] + }, + "default": "standard", + "description": "Specifies the environment in which the indexer should execute." }, "FieldMappingFunction": { "properties": { diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json index 57a5eedf1b93..34c226b5f8e0 100644 --- a/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json @@ -5779,14 +5779,253 @@ "description": "The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0." }, "configuration": { - "type": "object", - "additionalProperties": { - "type": "object" - }, - "description": "A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type." + "$ref": "#/definitions/IndexingParametersConfiguration" + } + }, + "description": "Represents parameters for indexer execution.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/create-indexer#parameters" + } + }, + "IndexingParametersConfiguration": { + "type": "object", + "properties": { + "parsingMode": { + "$ref": "#/definitions/ParsingMode" + }, + "excludedFileNameExtensions": { + "type": "string", + "default": "", + "description": "Comma-delimited list of filename extensions to ignore when processing from Azure blob storage. For example, you could exclude \".png, .mp4\" to skip over those files during indexing." + }, + "indexedFileNameExtensions": { + "type": "string", + "default": "", + "description": "Comma-delimited list of filename extensions to select when processing from Azure blob storage. For example, you could focus indexing on specific application files \".docx, .pptx, .msg\" to specifically include those file types." + }, + "failOnUnsupportedContentType": { + "type": "boolean", + "default": false, + "description": "For Azure blobs, set to false if you want to continue indexing when an unsupported content type is encountered, and you don't know all the content types (file extensions) in advance." + }, + "failOnUnprocessableDocument": { + "type": "boolean", + "default": false, + "description": "For Azure blobs, set to false if you want to continue indexing if a document fails indexing." + }, + "indexStorageMetadataOnlyForOversizedDocuments": { + "type": "boolean", + "default": false, + "description": "For Azure blobs, set this property to true to still index storage metadata for blob content that is too large to process. Oversized blobs are treated as errors by default. For limits on blob size, see https://docs.microsoft.com/azure/search/search-limits-quotas-capacity." + }, + "delimitedTextHeaders": { + "type": "string", + "description": "For CSV blobs, specifies a comma-delimited list of column headers, useful for mapping source fields to destination fields in an index." + }, + "delimitedTextDelimiter": { + "type": "string", + "description": "For CSV blobs, specifies the end-of-line single-character delimiter for CSV files where each line starts a new document (for example, \"|\")." + }, + "firstLineContainsHeaders": { + "type": "boolean", + "default": true, + "description": "For CSV blobs, indicates that the first (non-blank) line of each blob contains headers." + }, + "documentRoot": { + "type": "string", + "description": "For JSON arrays, given a structured or semi-structured document, you can specify a path to the array using this property." + }, + "dataToExtract": { + "$ref": "#/definitions/DataToExtract" + }, + "imageAction": { + "$ref": "#/definitions/ImageAction" + }, + "allowSkillsetToReadFileData": { + "type": "boolean", + "default": false, + "description": "If true, will create a path //document//file_data that is an object representing the original file data downloaded from your blob data source. This allows you to pass the original file data to a custom skill for processing within the enrichment pipeline, or to the Document Extraction skill." + }, + "pdfTextRotationAlgorithm": { + "$ref": "#/definitions/PdfTextRotationAlgorithm" + }, + "executionEnvironment": { + "$ref": "#/definitions/ExecutionEnvironment" + }, + "queryTimeout": { + "type": "string", + "default": "00:05:00", + "description": "Increases the timeout beyond the 5-minute default for Azure SQL database data sources, specified in the format \"hh:mm:ss\"." } }, - "description": "Represents parameters for indexer execution." + "additionalProperties": { + "type": "object" + }, + "description": "A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/create-indexer#parameters" + } + }, + "ParsingMode": { + "type": "string", + "enum": [ + "default", + "text", + "delimitedText", + "json", + "jsonArray", + "jsonLines" + ], + "x-ms-enum": { + "name": "BlobIndexerParsingMode", + "modelAsString": true, + "values": [ + { + "value": "default", + "name": "Default", + "description": "Set to default for normal file processing." + }, + { + "value": "text", + "name": "Text", + "description": "Set to text to improve indexing performance on plain text files in blob storage." + }, + { + "value": "delimitedText", + "name": "DelimitedText", + "description": "Set to delimitedText when blobs are plain CSV files." + }, + { + "value": "json", + "name": "Json", + "description": "Set to json to extract structured content from JSON files." + }, + { + "value": "jsonArray", + "name": "JsonArray", + "description": "Set to jsonArray to extract individual elements of a JSON array as separate documents in Azure Cognitive Search." + }, + { + "value": "jsonLines", + "name": "JsonLines", + "description": "Set to jsonLines to extract individual JSON entities, separated by a new line, as separate documents in Azure Cognitive Search." + } + ] + }, + "default": "default", + "description": "Represents the parsing mode for indexing from an Azure blob data source." + }, + "DataToExtract": { + "type": "string", + "enum": [ + "storageMetadata", + "allMetadata", + "contentAndMetadata" + ], + "x-ms-enum": { + "name": "BlobIndexerDataToExtract", + "modelAsString": true, + "values": [ + { + "value": "storageMetadata", + "name": "StorageMetadata", + "description": "Indexes just the standard blob properties and user-specified metadata." + }, + { + "value": "allMetadata", + "name": "AllMetadata", + "description": "Extracts metadata provided by the Azure blob storage subsystem and the content-type specific metadata (for example, metadata unique to just .png files are indexed)." + }, + { + "value": "contentAndMetadata", + "name": "ContentAndMetadata", + "description": "Extracts all metadata and textual content from each blob." + } + ] + }, + "default": "contentAndMetadata", + "description": "Specifies the data to extract from Azure blob storage and tells the indexer which data to extract from image content when \"imageAction\" is set to a value other than \"none\". This applies to embedded image content in a .PDF or other application, or image files such as .jpg and .png, in Azure blobs." + }, + "ImageAction": { + "type": "string", + "enum": [ + "none", + "generateNormalizedImages", + "generateNormalizedImagePerPage" + ], + "x-ms-enum": { + "name": "BlobIndexerImageAction", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Ignores embedded images or image files in the data set. This is the default." + }, + { + "value": "generateNormalizedImages", + "name": "GenerateNormalizedImages", + "description": "Extracts text from images (for example, the word \"STOP\" from a traffic stop sign), and embeds it into the content field. This action requires that \"dataToExtract\" is set to \"contentAndMetadata\". A normalized image refers to additional processing resulting in uniform image output, sized and rotated to promote consistent rendering when you include images in visual search results. This information is generated for each image when you use this option." + }, + { + "value": "generateNormalizedImagePerPage", + "name": "GenerateNormalizedImagePerPage", + "description": "Extracts text from images (for example, the word \"STOP\" from a traffic stop sign), and embeds it into the content field, but treats PDF files differently in that each page will be rendered as an image and normalized accordingly, instead of extracting embedded images. Non-PDF file types will be treated the same as if \"generateNormalizedImages\" was set." + } + ] + }, + "default": "none", + "description": "Determines how to process embedded images and image files in Azure blob storage. Setting the \"imageAction\" configuration to any value other than \"none\" requires that a skillset also be attached to that indexer." + }, + "PdfTextRotationAlgorithm": { + "type": "string", + "enum": [ + "none", + "detectAngles" + ], + "x-ms-enum": { + "name": "BlobIndexerPDFTextRotationAlgorithm", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Leverages normal text extraction. This is the default." + }, + { + "value": "detectAngles", + "name": "DetectAngles", + "description": "May produce better and more readable text extraction from PDF files that have rotated text within them. Note that there may be a small performance speed impact when this parameter is used. This parameter only applies to PDF files, and only to PDFs with embedded text. If the rotated text appears within an embedded image in the PDF, this parameter does not apply." + } + ] + }, + "default": "none", + "description": "Determines algorithm for text extraction from PDF files in Azure blob storage." + }, + "ExecutionEnvironment": { + "type": "string", + "enum": [ + "standard", + "private" + ], + "x-ms-enum": { + "name": "IndexerExecutionEnvironment", + "modelAsString": true, + "values": [ + { + "value": "standard", + "name": "standard", + "description": "Indicates that Azure Cognitive Search can determine where the indexer should execute. This is the default environment when nothing is specified and is the recommended value." + }, + { + "value": "private", + "name": "private", + "description": "Indicates that the indexer should run with the environment provisioned specifically for the search service. This should only be specified as the execution environment if the indexer needs to access resources securely over shared private link resources." + } + ] + }, + "default": "standard", + "description": "Specifies the environment in which the indexer should execute." }, "FieldMappingFunction": { "properties": { From 7d9eaf4c9866664806a2202b02e3ab5259c86cf9 Mon Sep 17 00:00:00 2001 From: edwin-msft <71858592+edwin-msft@users.noreply.github.com> Date: Fri, 25 Sep 2020 19:15:39 -0700 Subject: [PATCH 148/164] add scmMinTlsVersion (#10937) Co-authored-by: Edwin Diaz --- .../stable/2020-06-01/CommonDefinitions.json | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2020-06-01/CommonDefinitions.json b/specification/web/resource-manager/Microsoft.Web/stable/2020-06-01/CommonDefinitions.json index ecce545a54bd..c8188882a811 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2020-06-01/CommonDefinitions.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2020-06-01/CommonDefinitions.json @@ -2220,6 +2220,19 @@ "modelAsString": true } }, + "scmMinTlsVersion": { + "description": "ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site", + "enum": [ + "1.0", + "1.1", + "1.2" + ], + "type": "string", + "x-ms-enum": { + "name": "SupportedTlsVersions", + "modelAsString": true + } + }, "ftpsState": { "description": "State of FTP / FTPS service", "enum": [ From 25e3eaa8dd29c201625aebc33762ef9ab021eb9e Mon Sep 17 00:00:00 2001 From: tamilmani1989 Date: Sat, 26 Sep 2020 19:20:44 -0700 Subject: [PATCH 149/164] API Spec change for DNC RP (#10819) * updated apispec * spell error fix * removed dncappid from response * updated apispec * Added appid and endpoint in response * adde controller id in delegated subnet response * updated examples * updated * updated apispec * spell check and prettier fix * spell check fix * updated title same in all files * updated operationid * reverting to new change * addressed review comments * addressed feedback comments * spell check fix * updated readme.md * updated definition name * addressed feedback comments * fixed lint issue --- .../2020-08-08-preview/DelegatedNetwork.json | 1038 ----------------- .../2020-08-08-preview/controller.json | 506 ++++++++ .../2020-08-08-preview/delegatedSubnets.json | 520 +++++++++ ...rListByRG.json => controllerListByRG.json} | 8 +- ...istBySub.json => controllerListBySub.json} | 8 +- .../delegatedNetworkOperationsList.json | 27 + .../examples/delegatedSubnetListByRG.json | 12 +- .../examples/delegatedSubnetListBySub.json | 10 +- .../examples/deleteController.json | 2 +- .../examples/deleteDelegatedSubnet.json | 7 +- .../examples/deleteOrchestrator.json | 21 + .../examples/getController.json | 10 +- .../examples/getDelegatedSubnet.json | 14 +- .../examples/getOrchestrator.json | 36 + .../orchestratorInstanceListByRG.json | 39 + .../orchestratorInstanceListBySub.json | 38 + .../examples/patchController.json | 35 +- .../examples/patchDelegatedSubnet.json | 35 +- .../examples/patchOrchestrator.json | 44 + .../examples/putController.json | 26 +- .../examples/putDelegatedSubnet.json | 30 +- .../examples/putOrchestrator.json | 68 ++ .../2020-08-08-preview/operations.json | 194 +++ .../2020-08-08-preview/orchestrators.json | 567 +++++++++ specification/dnc/resource-manager/readme.md | 6 +- 25 files changed, 2168 insertions(+), 1133 deletions(-) delete mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/DelegatedNetwork.json create mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/controller.json create mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/delegatedSubnets.json rename specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/{delegatedNetworkControllerListByRG.json => controllerListByRG.json} (73%) rename specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/{delegatedNetworkControllerListBySub.json => controllerListBySub.json} (72%) create mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteOrchestrator.json create mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getOrchestrator.json create mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/orchestratorInstanceListByRG.json create mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/orchestratorInstanceListBySub.json create mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchOrchestrator.json create mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putOrchestrator.json create mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/operations.json create mode 100644 specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/orchestrators.json diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/DelegatedNetwork.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/DelegatedNetwork.json deleted file mode 100644 index 8d03de36a68f..000000000000 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/DelegatedNetwork.json +++ /dev/null @@ -1,1038 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2020-08-08-preview", - "title": "DNC", - "description": "DNC web api provides way to create, get and delete dnc controller" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/controller/{resourceName}": { - "get": { - "description": "Gets details about the specified dnc controller.", - "x-ms-examples": { - "Get details of a controller": { - "$ref": "./examples/getController.json" - } - }, - "tags": [ - "Controller" - ], - "operationId": "Controller_GetDetails", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK. The operation was successful.", - "schema": { - "$ref": "#/definitions/DelegatedController" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "description": "Create a dnc controller", - "x-ms-examples": { - "Create controller": { - "$ref": "./examples/putController.json" - } - }, - "tags": [ - "Controller" - ], - "operationId": "Controller_Create", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "controllerParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ControllerTypeParameters" - }, - "description": "controller type parameters" - } - ], - "responses": { - "200": { - "description": "OK. The operation completed successfully.", - "schema": { - "$ref": "#/definitions/DelegatedController" - } - }, - "201": { - "description": "InProgress. The operation is still in progress.", - "schema": { - "$ref": "#/definitions/DelegatedController" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "description": "Deletes the DNC controller", - "x-ms-examples": { - "Delete controller": { - "$ref": "./examples/deleteController.json" - } - }, - "tags": [ - "Controller" - ], - "operationId": "Controller_Delete", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$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/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "description": "Update dnc controller", - "x-ms-examples": { - "update controller": { - "$ref": "./examples/patchController.json" - } - }, - "tags": [ - "Controller" - ], - "operationId": "Controller_Patch", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "controllerParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ControllerTypeParameters" - }, - "description": "controller type parameters" - } - ], - "responses": { - "200": { - "description": "OK. The operation completed successfully.", - "schema": { - "$ref": "#/definitions/DelegatedController" - } - }, - "201": { - "description": "InProgress. The operation is still in progress.", - "schema": { - "$ref": "#/definitions/DelegatedController" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}/providers/Microsoft.DelegatedNetwork/delegatedSubnets/{resourceName}": { - "get": { - "description": "Gets details about the specified dnc DelegatedSubnet Link.", - "x-ms-examples": { - "Get details of a delegated subnet": { - "$ref": "./examples/getDelegatedSubnet.json" - } - }, - "tags": [ - "DNCDelegatedSubnet" - ], - "operationId": "DelegatedSubnetService_GetDetails", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/vnetNameParameter" - }, - { - "$ref": "#/parameters/subnetNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK. The operation was successful.", - "schema": { - "$ref": "#/definitions/DelegatedSubnet" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "description": "Put delegated subnet resource", - "x-ms-examples": { - "put delegated subnet": { - "$ref": "./examples/putDelegatedSubnet.json" - } - }, - "tags": [ - "DNCDelegatedSubnet" - ], - "operationId": "DelegatedSubnetService_PutDetails", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/vnetNameParameter" - }, - { - "$ref": "#/parameters/subnetNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "delegatedSubnetParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DelegatedSubnetParameters" - }, - "description": "Delegated subnet details." - } - ], - "responses": { - "200": { - "description": "OK. The operation was successful.", - "schema": { - "$ref": "#/definitions/DelegatedSubnet" - } - }, - "201": { - "description": "InProgress. The operation is still in progress", - "schema": { - "$ref": "#/definitions/DelegatedSubnet" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "description": "Patch delegated subnet resource", - "x-ms-examples": { - "patch delegated subnet": { - "$ref": "./examples/patchDelegatedSubnet.json" - } - }, - "tags": [ - "DNCDelegatedSubnet" - ], - "operationId": "DelegatedSubnetService_PatchDetails", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/vnetNameParameter" - }, - { - "$ref": "#/parameters/subnetNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "delegatedSubnetParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DelegatedSubnetParameters" - }, - "description": "Delegated subnet details." - } - ], - "responses": { - "200": { - "description": "OK. The operation was successful.", - "schema": { - "$ref": "#/definitions/DelegatedSubnet" - } - }, - "201": { - "description": "InProgress. The operation is still in progress", - "schema": { - "$ref": "#/definitions/DelegatedSubnet" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "description": "Delete dnc DelegatedSubnet.", - "x-ms-examples": { - "delete delegated subnet": { - "$ref": "./examples/deleteDelegatedSubnet.json" - } - }, - "tags": [ - "DNCDelegatedSubnet" - ], - "operationId": "DelegatedSubnetService_DeleteDetails", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/resourceNameParameter" - }, - { - "$ref": "#/parameters/vnetNameParameter" - }, - { - "$ref": "#/parameters/subnetNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$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/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DelegatedNetwork/delegatedControllers": { - "get": { - "tags": [ - "DelegatedControllers" - ], - "description": "Get all the delegatedController resources in a subscription.", - "operationId": "DelegatedNetwork_ListBySubscription", - "x-ms-examples": { - "Get DelegatedController resources by subscription": { - "$ref": "./examples/delegatedNetworkControllerListBySub.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the DelegatedControllers in the subscription.", - "schema": { - "$ref": "#/definitions/DelegatedControllers" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/delegatedControllers": { - "get": { - "tags": [ - "DelegatedControllers" - ], - "description": "Get all the delegatedController resources in a resource group.", - "operationId": "DelegatedNetwork_ListByResourceGroup", - "x-ms-examples": { - "Get DelegatedNetwork resources by resource group": { - "$ref": "./examples/delegatedNetworkControllerListByRG.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the delegatedControllers in the resource group.", - "schema": { - "$ref": "#/definitions/DelegatedControllers" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DelegatedNetwork/delegatedSubnetInstances": { - "get": { - "tags": [ - "DelegatedSubnets" - ], - "description": "Get all the DelegatedSubnets resources in a subscription.", - "operationId": "DelegatedSubnetService_ListBySubscription", - "x-ms-examples": { - "Get DelegatedSubnets resources by subscription": { - "$ref": "./examples/delegatedSubnetListBySub.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the DelegatedSubnets in the subscription.", - "schema": { - "$ref": "#/definitions/DelegatedSubnetList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/delegatedSubnetInstances": { - "get": { - "tags": [ - "DelegatedSubnets" - ], - "description": "Get all the DelegatedSubnets resources in a resource group.", - "operationId": "DelegatedSubnetService_ListByResourceGroup", - "x-ms-examples": { - "Get DelegatedSubnets resources by resource group": { - "$ref": "./examples/delegatedSubnetListByRG.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - } - ], - "responses": { - "200": { - "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the DelegatedSubnets in the resource group.", - "schema": { - "$ref": "#/definitions/DelegatedSubnetList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.DelegatedNetwork/operations": { - "get": { - "tags": [ - "Operations" - ], - "description": "Lists all of the available DelegatedNetwork service REST API operations.", - "operationId": "Operations_List", - "x-ms-examples": { - "Get available operations": { - "$ref": "./examples/delegatedNetworkOperationsList.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "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/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "OperationListResult": { - "description": "Result of request to list controller operations.It contains a list of operations and a URL link to get the next set of results", - "type": "object", - "properties": { - "value": { - "type": "array", - "uniqueItems": false, - "readOnly": true, - "description": "List of operations supported by the Microsoft.DelegatedNetwork resource provider.", - "items": { - "$ref": "#/definitions/Operation" - } - }, - "nextLink": { - "description": "URL to get the next set of operation list results if there are any.", - "type": "string" - } - } - }, - "Operation": { - "description": "Microsoft.DelegatedNetwork REST API operation definition", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}.", - "type": "string", - "readOnly": true - }, - "origin": { - "description": "Origin of the operation", - "type": "string" - }, - "isDataAction": { - "description": "Gets or sets a value indicating whether the operation is a data action or not.", - "type": "boolean" - }, - "display": { - "description": "Operation properties display", - "$ref": "#/definitions/OperationDisplay" - }, - "properties": { - "$ref": "#/definitions/OperationProperties", - "description": "Properties of the operation" - } - } - }, - "OperationDisplay": { - "description": "The object that represents the operation.", - "type": "object", - "properties": { - "provider": { - "description": "Service provider: Microsoft.DelegatedNetwork.", - "type": "string", - "readOnly": true - }, - "resource": { - "description": "Resource on which the operation is performed: controller, etc.", - "type": "string", - "readOnly": true - }, - "operation": { - "description": "Operation type: create, get, delete, etc.", - "type": "string", - "readOnly": true - }, - "description": { - "readOnly": true, - "type": "string", - "description": "Friendly description for the operation," - } - } - }, - "OperationProperties": { - "description": "Operation properties.", - "type": "object", - "properties": {} - }, - "ControllerResource": { - "description": "Represents an instance of an DNC controller resource.", - "type": "object", - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "An identifier that represents the DNC controller resource." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "The name of the DNC controller resource." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "The type of the DNC controller resource.(Microsoft.DelegatedNetwork/controller)" - }, - "location": { - "type": "string", - "description": "Location of the DNC controller resource." - } - }, - "x-ms-azure-resource": true - }, - "DelegatedControllers": { - "description": "An array of Delegated controller resources.", - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DelegatedController" - }, - "description": "An array of Delegated controller resources." - } - }, - "required": [ - "value" - ] - }, - "ControllerTypeParameters": { - "description": "Details of controller type.", - "type": "object", - "properties": { - "controllerType": { - "type": "string", - "description": "Type of controller", - "enum": [ - "Kubernetes" - ], - "x-ms-enum": { - "name": "ControllerType", - "modelAsString": true - } - }, - "properties": { - "x-ms-client-flatten": true, - "description": "Controller properties", - "$ref": "#/definitions/ControllerInstanceProperties" - } - } - }, - "DelegatedController": { - "description": "Represents an instance of a DNC controller.", - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ControllerResponseProperties", - "description": "Properties of the provision operation request." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ControllerResource" - } - ] - }, - "ControllerResponseProperties": { - "description": "Properties of Delegated controller resource.", - "type": "object", - "properties": { - "state": { - "type": "string", - "enum": [ - "Deleting", - "Succeeded", - "Failed", - "Provisioning" - ], - "x-ms-enum": { - "name": "ControllerState", - "modelAsString": true - }, - "readOnly": true, - "description": "The current state of dnc controller resource." - }, - "dncAppId": { - "type": "string", - "description": "The current state of dnc controller resource." - }, - "dncEndpoint": { - "type": "string", - "description": "dnc endpoint url that customers can use to connect to" - } - } - }, - "ControllerInstanceProperties": { - "description": "Properties of orchestrator", - "type": "object", - "properties": { - "serverAppID": { - "description": "AAD ID used with apiserver", - "type": "string" - }, - "serverTenantID": { - "description": "TenantID of server App ID", - "type": "string" - }, - "clusterRootCA": { - "description": "RootCA certificate of kubernetes cluster", - "type": "string" - }, - "apiServerEndpoint": { - "description": "APIServer url", - "type": "string" - } - } - }, - "DelegatedSubnetResource": { - "description": "Represents an instance of a DelegatedSubnet resource.", - "type": "object", - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "An identifier that represents the DelegatedSubnet resource." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "The name of the DelegatedSubnet resource." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "The type of the DelegatedSubnet resource.(Microsoft.DelegatedNetwork/delegatedSubnet)" - }, - "location": { - "type": "string", - "description": "Location of the DelegatedSubnet resource." - } - }, - "x-ms-azure-resource": true - }, - "DelegatedSubnetParameters": { - "description": "DelegatedSubnet Parameters", - "type": "object", - "properties": { - "controllerID": { - "type": "string", - "description": "Delegated Network Controller ARM resource ID" - } - } - }, - "DelegatedSubnetList": { - "description": "An array of Delegated subnets resources.", - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DelegatedSubnet" - }, - "description": "An array of Delegated subnets resources." - } - }, - "required": [ - "value" - ] - }, - "DelegatedSubnet": { - "description": "Delegated subnet details", - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/DelegatedSubnetResponseProperties", - "description": "Properties of the delegated subnet request" - } - }, - "allOf": [ - { - "$ref": "#/definitions/DelegatedSubnetResource" - } - ] - }, - "DelegatedSubnetResponseProperties": { - "description": "Properties of delegated subnet resource.", - "type": "object", - "properties": { - "state": { - "type": "string", - "enum": [ - "Deleting", - "Succeeded", - "Failed", - "Provisioning" - ], - "x-ms-enum": { - "name": "DelegatedSubnetState", - "modelAsString": true - }, - "readOnly": true, - "description": "The current state of delegated subnet resource." - }, - "resourceGuid": { - "type": "string", - "description": "Guid for the resource(delegatedSubnet) created" - } - } - }, - "ErrorResponse": { - "description": "Error response.", - "properties": { - "error": { - "description": "Error description", - "$ref": "#/definitions/ErrorDefinition" - } - } - }, - "ErrorDefinition": { - "description": "Error definition.", - "properties": { - "code": { - "description": "Service specific error code which serves as the substatus for the HTTP error code.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "Description of the error.", - "type": "string", - "readOnly": true - }, - "details": { - "description": "Internal error details.", - "type": "array", - "items": { - "$ref": "#/definitions/ErrorDefinition" - }, - "readOnly": true - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The client API version." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method", - "description": "The name of the Azure Resource group of which a given DelegatedNetwork resource is part. This name must be at least 1 character in length, and no more than 90." - }, - "resourceNameParameter": { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[a-z][a-z0-9]*$", - "minLength": 3, - "maxLength": 63, - "x-ms-parameter-location": "method", - "description": "The name of the resource. It must be a minimum of 3 characters, and a maximum of 63." - }, - "vnetNameParameter": { - "name": "vnetName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method", - "description": "The name of the virtual network. This name must be at least 1 character in length, and no more than 90." - }, - "subnetNameParameter": { - "name": "subnetName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method", - "description": "The name of the delegated subnet. This name must be at least 1 character in length, and no more than 90." - } - } -} diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/controller.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/controller.json new file mode 100644 index 000000000000..c021fb9165bc --- /dev/null +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/controller.json @@ -0,0 +1,506 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-08-08-preview", + "title": "DNC", + "description": "DNC web api provides way to create, get and delete dnc controller" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/controller/{resourceName}": { + "get": { + "description": "Gets details about the specified dnc controller.", + "x-ms-examples": { + "Get details of a controller": { + "$ref": "./examples/getController.json" + } + }, + "tags": [ + "Controller" + ], + "operationId": "Controller_GetDetails", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The operation was successful.", + "schema": { + "$ref": "#/definitions/DelegatedController" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Create a dnc controller", + "x-ms-examples": { + "Create controller": { + "$ref": "./examples/putController.json" + } + }, + "tags": [ + "Controller" + ], + "operationId": "Controller_Create", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DelegatedController" + }, + "description": "controller type parameters" + } + ], + "responses": { + "200": { + "description": "OK. The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DelegatedController" + } + }, + "201": { + "description": "InProgress. The operation is still in progress.", + "schema": { + "$ref": "#/definitions/DelegatedController" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "description": "Deletes the DNC controller", + "x-ms-examples": { + "Delete controller": { + "$ref": "./examples/deleteController.json" + } + }, + "tags": [ + "Controller" + ], + "operationId": "Controller_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$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/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "description": "Update dnc controller", + "x-ms-examples": { + "update controller": { + "$ref": "./examples/patchController.json" + } + }, + "tags": [ + "Controller" + ], + "operationId": "Controller_Patch", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ControllerResourceUpdateParameters" + }, + "description": "controller type parameters" + } + ], + "responses": { + "200": { + "description": "OK. The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DelegatedController" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DelegatedNetwork/controllers": { + "get": { + "tags": [ + "DelegatedControllers" + ], + "description": "Get all the delegatedController resources in a subscription.", + "operationId": "DelegatedNetwork_ListBySubscription", + "x-ms-examples": { + "Get DelegatedController resources by subscription": { + "$ref": "./examples/controllerListBySub.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the DelegatedControllers in the subscription.", + "schema": { + "$ref": "#/definitions/DelegatedControllers" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/controllers": { + "get": { + "tags": [ + "DelegatedControllers" + ], + "description": "Get all the delegatedController resources in a resource group.", + "operationId": "DelegatedNetwork_ListByResourceGroup", + "x-ms-examples": { + "Get DelegatedNetwork resources by resource group": { + "$ref": "./examples/controllerListByRG.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the delegatedControllers in the resource group.", + "schema": { + "$ref": "#/definitions/DelegatedControllers" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ControllerResource": { + "description": "Represents an instance of a resource.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "An identifier that represents the resource." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The type of resource." + }, + "location": { + "type": "string", + "description": "Location of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "x-ms-azure-resource": true + }, + "ControllerResourceUpdateParameters": { + "description": "Parameters for updating a resource.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + } + }, + "DelegatedControllers": { + "description": "An array of Delegated controller resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DelegatedController" + }, + "description": "An array of Delegated controller resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of controllers.", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "DelegatedController": { + "description": "Represents an instance of a DNC controller.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ControllerResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "readOnly": true, + "$ref": "#/definitions/DelegatedControllerProperties", + "description": "Properties of the provision operation request." + } + } + }, + "DelegatedControllerProperties": { + "description": "Properties of Delegated controller resource.", + "type": "object", + "properties": { + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Resource guid." + }, + "provisioningState": { + "type": "string", + "enum": [ + "Deleting", + "Succeeded", + "Failed", + "Provisioning" + ], + "x-ms-enum": { + "name": "ControllerState", + "modelAsString": true + }, + "readOnly": true, + "description": "The current state of dnc controller resource." + }, + "dncAppId": { + "type": "string", + "readOnly": true, + "description": "dnc application id should be used by customer to authenticate with dnc gateway." + }, + "dncTenantId": { + "type": "string", + "readOnly": true, + "description": "tenant id of dnc application id" + }, + "dncEndpoint": { + "type": "string", + "readOnly": true, + "description": "dnc endpoint url that customers can use to connect to" + } + } + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "description": "Error description", + "$ref": "#/definitions/ErrorDefinition" + } + } + }, + "ErrorDefinition": { + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Internal error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDefinition" + }, + "readOnly": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The client API version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "The name of the Azure Resource group of which a given DelegatedNetwork resource is part. This name must be at least 1 character in length, and no more than 90." + }, + "resourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "minLength": 3, + "maxLength": 63, + "x-ms-parameter-location": "method", + "description": "The name of the resource. It must be a minimum of 3 characters, and a maximum of 63." + } + } +} diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/delegatedSubnets.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/delegatedSubnets.json new file mode 100644 index 000000000000..227454d9adc8 --- /dev/null +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/delegatedSubnets.json @@ -0,0 +1,520 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-08-08-preview", + "title": "DNC", + "description": "DNC web api provides way to create, get and delete dnc controller" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/delegatedSubnets/{resourceName}": { + "get": { + "description": "Gets details about the specified dnc DelegatedSubnet Link.", + "x-ms-examples": { + "Get details of a delegated subnet": { + "$ref": "./examples/getDelegatedSubnet.json" + } + }, + "tags": [ + "DNCDelegatedSubnet" + ], + "operationId": "DelegatedSubnetService_GetDetails", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The operation was successful.", + "schema": { + "$ref": "#/definitions/DelegatedSubnet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Put delegated subnet resource", + "x-ms-examples": { + "put delegated subnet": { + "$ref": "./examples/putDelegatedSubnet.json" + } + }, + "tags": [ + "DNCDelegatedSubnet" + ], + "operationId": "DelegatedSubnetService_PutDetails", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DelegatedSubnet" + }, + "description": "Delegated subnet details." + } + ], + "responses": { + "200": { + "description": "OK. The operation was successful.", + "schema": { + "$ref": "#/definitions/DelegatedSubnet" + } + }, + "201": { + "description": "InProgress. The operation is still in progress", + "schema": { + "$ref": "#/definitions/DelegatedSubnet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "description": "Patch delegated subnet resource", + "x-ms-examples": { + "patch delegated subnet": { + "$ref": "./examples/patchDelegatedSubnet.json" + } + }, + "tags": [ + "DNCDelegatedSubnet" + ], + "operationId": "DelegatedSubnetService_PatchDetails", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceUpdateParameters" + }, + "description": "Delegated subnet details." + } + ], + "responses": { + "200": { + "description": "OK. The operation was successful.", + "schema": { + "$ref": "#/definitions/DelegatedSubnet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "description": "Delete dnc DelegatedSubnet.", + "x-ms-examples": { + "delete delegated subnet": { + "$ref": "./examples/deleteDelegatedSubnet.json" + } + }, + "tags": [ + "DNCDelegatedSubnet" + ], + "operationId": "DelegatedSubnetService_DeleteDetails", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$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/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DelegatedNetwork/delegatedSubnets": { + "get": { + "tags": [ + "DelegatedSubnets" + ], + "description": "Get all the DelegatedSubnets resources in a subscription.", + "operationId": "DelegatedSubnetService_ListBySubscription", + "x-ms-examples": { + "Get DelegatedSubnets resources by subscription": { + "$ref": "./examples/delegatedSubnetListBySub.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the DelegatedSubnets in the subscription.", + "schema": { + "$ref": "#/definitions/DelegatedSubnets" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/delegatedSubnets": { + "get": { + "tags": [ + "DelegatedSubnets" + ], + "description": "Get all the DelegatedSubnets resources in a resource group.", + "operationId": "DelegatedSubnetService_ListByResourceGroup", + "x-ms-examples": { + "Get DelegatedSubnets resources by resource group": { + "$ref": "./examples/delegatedSubnetListByRG.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the DelegatedSubnets in the resource group.", + "schema": { + "$ref": "#/definitions/DelegatedSubnets" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "DelegatedSubnetResource": { + "description": "Represents an instance of a resource.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "An identifier that represents the resource." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The type of resource." + }, + "location": { + "type": "string", + "description": "Location of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "x-ms-azure-resource": true + }, + "ResourceUpdateParameters": { + "description": "Parameters for updating a resource.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + } + }, + "DelegatedSubnets": { + "description": "An array of DelegatedSubnet resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DelegatedSubnet" + }, + "description": "An array of DelegatedSubnet resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of DelegatedSubnet resources.", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "DelegatedSubnet": { + "description": "Represents an instance of a orchestrator.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DelegatedSubnetResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "readOnly": true, + "$ref": "#/definitions/DelegatedSubnetProperties", + "description": "Properties of the provision operation request." + } + } + }, + "DelegatedSubnetProperties": { + "description": "Properties of delegated subnet", + "type": "object", + "properties": { + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Resource guid." + }, + "provisioningState": { + "type": "string", + "enum": [ + "Deleting", + "Succeeded", + "Failed", + "Provisioning" + ], + "x-ms-enum": { + "name": "DelegatedSubnetState", + "modelAsString": true + }, + "readOnly": true, + "description": "The current state of dnc delegated subnet resource." + }, + "subnetDetails": { + "description": "orchestrator details", + "$ref": "#/definitions/subnetDetails" + }, + "controllerDetails": { + "description": "controller details", + "$ref": "#/definitions/controllerDetails" + } + } + }, + "subnetDetails": { + "description": "Properties of orchestrator", + "type": "object", + "properties": { + "id": { + "description": "subnet arm resource id", + "type": "string" + } + } + }, + "controllerDetails": { + "description": "controller details", + "type": "object", + "properties": { + "id": { + "description": "controller arm resource id", + "type": "string" + } + } + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "description": "Error description", + "$ref": "#/definitions/ErrorDefinition" + } + } + }, + "ErrorDefinition": { + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Internal error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDefinition" + }, + "readOnly": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The client API version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "The name of the Azure Resource group of which a given DelegatedNetwork resource is part. This name must be at least 1 character in length, and no more than 90." + }, + "resourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "minLength": 3, + "maxLength": 63, + "x-ms-parameter-location": "method", + "description": "The name of the resource. It must be a minimum of 3 characters, and a maximum of 63." + } + } +} diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkControllerListByRG.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/controllerListByRG.json similarity index 73% rename from specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkControllerListByRG.json rename to specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/controllerListByRG.json index 4ef9119e545b..a81f2d4d5193 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkControllerListByRG.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/controllerListByRG.json @@ -10,13 +10,15 @@ "body": { "value": [ { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller1", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller", "location": "West US", - "name": "dnctestcontroller1", + "name": "testcontroller", "type": "Microsoft.DelegatedNetwork/controller", "properties": { - "state": "Succeeded", + "provisioningState": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801", "dncAppId": "ac1192d7-503f-477a-9cfe-4efc3ee2bd60", + "dncTenantId": "66192d7-503f-477a-9cfe-4efc3ee2bd60", "dncEndpoint": "https://orch.useast.dnc.azure.com" } } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkControllerListBySub.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/controllerListBySub.json similarity index 72% rename from specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkControllerListBySub.json rename to specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/controllerListBySub.json index 1ea3ec7ab0c8..5c58a73c6761 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkControllerListBySub.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/controllerListBySub.json @@ -9,13 +9,15 @@ "body": { "value": [ { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller1", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller", "location": "West US", - "name": "dnctestcontroller1", + "name": "testcontroller", "type": "Microsoft.DelegatedNetwork/controller", "properties": { - "state": "Succeeded", + "provisioningState": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801", "dncAppId": "ac1192d7-503f-477a-9cfe-4efc3ee2bd60", + "dncTenantId": "66192d7-503f-477a-9cfe-4efc3ee2bd60", "dncEndpoint": "https://orch.useast.dnc.azure.com" } } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkOperationsList.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkOperationsList.json index 06cd0fa9225e..d56a67b6d20b 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkOperationsList.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedNetworkOperationsList.json @@ -34,6 +34,33 @@ "description": "Delete a Controller Service instance." } }, + { + "name": "Microsoft.DelegatedNetwork/orchestratorInstances/write", + "display": { + "provider": "Microsoft Delegated Network Service", + "resource": "Microsoft Delegated Network orchestratorInstance", + "operation": "Create or update a orchestratorInstance.", + "description": "Create or update a orchestratorInstance." + } + }, + { + "name": "Microsoft.DelegatedNetwork/controller/read", + "display": { + "provider": "Microsoft Delegated Network Service", + "resource": "Microsoft Delegated Network orchestratorInstance", + "operation": "Get a orchestratorInstances.", + "description": "Get a orchestratorInstance." + } + }, + { + "name": "Microsoft.DelegatedNetwork/controller/delete", + "display": { + "provider": "Microsoft Delegated Network Service", + "resource": "Microsoft Delegated Network orchestratorInstance", + "operation": "Delete a orchestratorInstance.", + "description": "Delete a orchestratorInstance." + } + }, { "name": "Microsoft.DelegatedNetwork/delegatedSubnets/write", "display": { diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListByRG.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListByRG.json index 3118b8b5b991..8e0b0c7846e4 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListByRG.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListByRG.json @@ -10,13 +10,19 @@ "body": { "value": [ { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", "location": "West US", "name": "delegated1", "type": "Microsoft.DelegatedNetwork/delegatedSubnets", "properties": { - "state": "Succeeded", - "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801" + "provisioningState": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801", + "subnetDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet" + }, + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller" + } } } ] diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListBySub.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListBySub.json index eac3db04c096..7eb3dd2c65ef 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListBySub.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/delegatedSubnetListBySub.json @@ -14,8 +14,14 @@ "name": "delegated1", "type": "Microsoft.DelegatedNetwork/delegatedSubnets", "properties": { - "state": "Succeeded", - "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801" + "provisioningState": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801", + "subnetDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet" + }, + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller" + } } } ] diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteController.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteController.json index dbc0056a454b..3b80be1a636d 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteController.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteController.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", "resourceGroupName": "TestRG", - "resourceName": "dnctestcontroller", + "resourceName": "testcontroller", "api-version": "2020-08-08-preview" }, "responses": { diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteDelegatedSubnet.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteDelegatedSubnet.json index b1e8c5f1c8bb..ae6a8d624d0f 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteDelegatedSubnet.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteDelegatedSubnet.json @@ -2,13 +2,8 @@ "parameters": { "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", "resourceGroupName": "TestRG", - "vnetName": "testvnet", - "subnetName": "testsubnet", "resourceName": "delegated1", - "api-version": "2020-08-08-preview", - "delegatedSubnetParameters": { - "controllerID": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller" - } + "api-version": "2020-08-08-preview" }, "responses": { "200": { diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteOrchestrator.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteOrchestrator.json new file mode 100644 index 000000000000..826523d95420 --- /dev/null +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/deleteOrchestrator.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", + "resourceGroupName": "TestRG", + "resourceName": "k8stest1", + "api-version": "2020-08-08-preview" + }, + "responses": { + "200": { + "headers": {}, + "description": "OK." + }, + "202": { + "headers": {}, + "description": "Accepted." + }, + "204": { + "headers": {} + } + } +} diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getController.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getController.json index 6fa0fd517f29..f583f14e4985 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getController.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getController.json @@ -2,20 +2,22 @@ "parameters": { "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", "resourceGroupName": "TestRG", - "resourceName": "dnctestcontroller", + "resourceName": "testcontroller", "api-version": "2020-08-08-preview" }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller", "location": "West US", - "name": "dnctestcontroller", + "name": "testcontroller", "type": "Microsoft.DelegatedNetwork/controller", "properties": { - "state": "Succeeded", + "provisioningState": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801", "dncAppId": "ac1192d7-503f-477a-9cfe-4efc3ee2bd60", + "dncTenantId": "66192d7-503f-477a-9cfe-4efc3ee2bd60", "dncEndpoint": "https://orch.useast.dnc.azure.com" } } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getDelegatedSubnet.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getDelegatedSubnet.json index 79100cab522b..fe8dc64cd511 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getDelegatedSubnet.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getDelegatedSubnet.json @@ -2,8 +2,6 @@ "parameters": { "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", "resourceGroupName": "TestRG", - "vnetName": "testvnet", - "subnetName": "testsubnet", "resourceName": "delegated1", "api-version": "2020-08-08-preview" }, @@ -11,13 +9,19 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", "location": "West US", "name": "delegated1", "type": "Microsoft.DelegatedNetwork/delegatedSubnets", "properties": { - "state": "Succeeded", - "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801" + "provisioningState": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801", + "subnetDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet" + }, + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller" + } } } } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getOrchestrator.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getOrchestrator.json new file mode 100644 index 000000000000..7c0e763848c8 --- /dev/null +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/getOrchestrator.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", + "resourceGroupName": "TestRG", + "resourceName": "testk8s1", + "api-version": "2020-08-08-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/orchestrators/testk8s1", + "location": "West US", + "name": "testk8s1", + "type": "Microsoft.DelegatedNetwork/orchestrators", + "kind": "Kubernetes", + "identity": { + "principalId": "7a2192d7-503f-477a-9cfe-4efc3ee2bd60", + "tenantId": "3e2192d7-503f-477a-9cfe-4efc3ee2bd60", + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1b2192d7-503f-477a-9cfe-4efc3ee2bd60", + "orchestratorAppId": "546192d7-503f-477a-9cfe-4efc3ee2b6e1", + "orchestratorTenantId": "da6192d7-503f-477a-9cfe-4efc3ee2b6c3", + "clusterRootCA": "ddsadsad344mfdsfdl", + "apiServerEndpoint": "https://testk8s.cloudapp.net", + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller" + } + } + } + } + } +} diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/orchestratorInstanceListByRG.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/orchestratorInstanceListByRG.json new file mode 100644 index 000000000000..e4077f80797c --- /dev/null +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/orchestratorInstanceListByRG.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "50016170-c839-41ba-a724-51e9df440b9e", + "api-version": "2020-08-08-preview", + "resourceGroupName": "testRG" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/orchestrators/testk8s1", + "location": "West US", + "name": "testk8s1", + "type": "Microsoft.DelegatedNetwork/orchestrators", + "kind": "Kubernetes", + "identity": { + "principalId": "7a2192d7-503f-477a-9cfe-4efc3ee2bd60", + "tenantId": "3e2192d7-503f-477a-9cfe-4efc3ee2bd60", + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1b2192d7-503f-477a-9cfe-4efc3ee2bd60", + "orchestratorAppId": "546192d7-503f-477a-9cfe-4efc3ee2b6e1", + "orchestratorTenantId": "da6192d7-503f-477a-9cfe-4efc3ee2b6c3", + "clusterRootCA": "ddsadsad344mfdsfdl", + "apiServerEndpoint": "https://testk8s.cloudapp.net", + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller" + } + } + } + ] + } + } + } +} diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/orchestratorInstanceListBySub.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/orchestratorInstanceListBySub.json new file mode 100644 index 000000000000..c8a00c1bd581 --- /dev/null +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/orchestratorInstanceListBySub.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "50016170-c839-41ba-a724-51e9df440b9e", + "api-version": "2020-08-08-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/orchestrators/testk8s1", + "location": "West US", + "name": "testk8s1", + "type": "Microsoft.DelegatedNetwork/orchestrators", + "kind": "Kubernetes", + "identity": { + "principalId": "7a2192d7-503f-477a-9cfe-4efc3ee2bd60", + "tenantId": "3e2192d7-503f-477a-9cfe-4efc3ee2bd60", + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1b2192d7-503f-477a-9cfe-4efc3ee2bd60", + "orchestratorAppId": "546192d7-503f-477a-9cfe-4efc3ee2b6e1", + "orchestratorTenantId": "da6192d7-503f-477a-9cfe-4efc3ee2b6c3", + "clusterRootCA": "ddsadsad344mfdsfdl", + "apiServerEndpoint": "https://testk8s.cloudapp.net", + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller" + } + } + } + ] + } + } + } +} diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchController.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchController.json index 629ac7b2f344..9f9f3614ac45 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchController.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchController.json @@ -2,15 +2,11 @@ "parameters": { "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", "resourceGroupName": "TestRG", - "resourceName": "dnctestcontroller", + "resourceName": "testcontroller", "api-version": "2020-08-08-preview", - "controllerParameters": { - "controllerType": "Kubernetes", - "properties": { - "serverAppID": "546192d7-503f-477a-9cfe-4efc3ee2b6e1", - "serverTenantID": "da6192d7-503f-477a-9cfe-4efc3ee2b6c3", - "clusterRootCA": "ddsadsad344mfdsfdl", - "apiServerEndpoint": "https://testk8s.cloudapp.net" + "parameters": { + "tags": { + "key": "value" } } }, @@ -18,28 +14,21 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller", "location": "West US", - "name": "dnctestcontroller", + "name": "testcontroller", "type": "Microsoft.DelegatedNetwork/controller", + "tags": { + "key": "value" + }, "properties": { - "state": "Succeeded", + "provisioningState": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801", "dncAppId": "ac1192d7-503f-477a-9cfe-4efc3ee2bd60", + "dncTenantId": "66192d7-503f-477a-9cfe-4efc3ee2bd60", "dncEndpoint": "https://orch.useast.dnc.azure.com" } } - }, - "201": { - "headers": {}, - "body": { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller", - "location": "West US", - "name": "dnctestcontroller", - "type": "Microsoft.DelegatedNetwork/controller", - "properties": { - "state": "Provisioning" - } - } } } } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchDelegatedSubnet.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchDelegatedSubnet.json index 9441a459a8d6..9c2462969f5f 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchDelegatedSubnet.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchDelegatedSubnet.json @@ -2,37 +2,34 @@ "parameters": { "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", "resourceGroupName": "TestRG", - "vnetName": "testvnet", - "subnetName": "testsubnet", "resourceName": "delegated1", "api-version": "2020-08-08-preview", - "delegatedSubnetParameters": { - "controllerID": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller" + "parameters": { + "tags": { + "key": "value" + } } }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", - "location": "West US", - "name": "delegated1", - "type": "Microsoft.DelegatedNetwork/delegatedSubnets", - "properties": { - "state": "Succeeded", - "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801" - } - } - }, - "201": { - "headers": {}, - "body": { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", "location": "West US", "name": "delegated1", "type": "Microsoft.DelegatedNetwork/delegatedSubnets", + "tags": { + "key": "value" + }, "properties": { - "state": "Provisioning" + "provisioningState": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801", + "subnetDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet" + }, + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller" + } } } } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchOrchestrator.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchOrchestrator.json new file mode 100644 index 000000000000..8cabeee2c9c5 --- /dev/null +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/patchOrchestrator.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", + "resourceGroupName": "TestRG", + "resourceName": "testk8s1", + "api-version": "2020-08-08-preview", + "parameters": { + "tags": { + "key": "value" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/orchestrators/testk8s1", + "location": "West US", + "name": "testk8s1", + "type": "Microsoft.DelegatedNetwork/orchestrators", + "kind": "Kubernetes", + "tags": { + "key": "value" + }, + "identity": { + "principalId": "7a2192d7-503f-477a-9cfe-4efc3ee2bd60", + "tenantId": "3e2192d7-503f-477a-9cfe-4efc3ee2bd60", + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1b2192d7-503f-477a-9cfe-4efc3ee2bd60", + "orchestratorAppId": "546192d7-503f-477a-9cfe-4efc3ee2b6e1", + "orchestratorTenantId": "da6192d7-503f-477a-9cfe-4efc3ee2b6c3", + "clusterRootCA": "ddsadsad344mfdsfdl", + "apiServerEndpoint": "https://testk8s.cloudapp.net", + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller" + } + } + } + } + } +} diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putController.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putController.json index 629ac7b2f344..77ec462dc3a3 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putController.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putController.json @@ -2,29 +2,25 @@ "parameters": { "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", "resourceGroupName": "TestRG", - "resourceName": "dnctestcontroller", + "resourceName": "testcontroller", "api-version": "2020-08-08-preview", - "controllerParameters": { - "controllerType": "Kubernetes", - "properties": { - "serverAppID": "546192d7-503f-477a-9cfe-4efc3ee2b6e1", - "serverTenantID": "da6192d7-503f-477a-9cfe-4efc3ee2b6c3", - "clusterRootCA": "ddsadsad344mfdsfdl", - "apiServerEndpoint": "https://testk8s.cloudapp.net" - } + "parameters": { + "location": "West US" } }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller", "location": "West US", - "name": "dnctestcontroller", + "name": "testcontroller", "type": "Microsoft.DelegatedNetwork/controller", "properties": { - "state": "Succeeded", + "provisioningState": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801", "dncAppId": "ac1192d7-503f-477a-9cfe-4efc3ee2bd60", + "dncTenantId": "66192d7-503f-477a-9cfe-4efc3ee2bd60", "dncEndpoint": "https://orch.useast.dnc.azure.com" } } @@ -32,12 +28,12 @@ "201": { "headers": {}, "body": { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller", "location": "West US", - "name": "dnctestcontroller", + "name": "testcontroller", "type": "Microsoft.DelegatedNetwork/controller", "properties": { - "state": "Provisioning" + "provisioningState": "Provisioning" } } } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putDelegatedSubnet.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putDelegatedSubnet.json index 9441a459a8d6..ed8fa91a8363 100644 --- a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putDelegatedSubnet.json +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putDelegatedSubnet.json @@ -2,37 +2,49 @@ "parameters": { "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", "resourceGroupName": "TestRG", - "vnetName": "testvnet", - "subnetName": "testsubnet", "resourceName": "delegated1", "api-version": "2020-08-08-preview", - "delegatedSubnetParameters": { - "controllerID": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller" + "parameters": { + "location": "West US", + "properties": { + "subnetDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet" + }, + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller" + } + } } }, "responses": { "200": { "headers": {}, "body": { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", "location": "West US", "name": "delegated1", "type": "Microsoft.DelegatedNetwork/delegatedSubnets", "properties": { - "state": "Succeeded", - "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801" + "provisioningState": "Succeeded", + "resourceGuid": "5a82cbcf-e8ea-4175-ac2b-ad36a73f9801", + "subnetDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet" + }, + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/dnctestcontroller" + } } } }, "201": { "headers": {}, "body": { - "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/delegatedSubnets/delegated1", "location": "West US", "name": "delegated1", "type": "Microsoft.DelegatedNetwork/delegatedSubnets", "properties": { - "state": "Provisioning" + "provisioningState": "Provisioning" } } } diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putOrchestrator.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putOrchestrator.json new file mode 100644 index 000000000000..d98e3b7c2926 --- /dev/null +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/examples/putOrchestrator.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", + "resourceGroupName": "TestRG", + "resourceName": "testk8s1", + "api-version": "2020-08-08-preview", + "parameters": { + "location": "West US", + "kind": "Kubernetes", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "orchestratorAppId": "546192d7-503f-477a-9cfe-4efc3ee2b6e1", + "orchestratorTenantId": "da6192d7-503f-477a-9cfe-4efc3ee2b6c3", + "clusterRootCA": "ddsadsad344mfdsfdl", + "apiServerEndpoint": "https://testk8s.cloudapp.net", + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/orchestrators/testk8s1", + "location": "West US", + "name": "testk8s1", + "type": "Microsoft.DelegatedNetwork/orchestrators", + "kind": "Kubernetes", + "identity": { + "principalId": "7a2192d7-503f-477a-9cfe-4efc3ee2bd60", + "tenantId": "3e2192d7-503f-477a-9cfe-4efc3ee2bd60", + "type": "SystemAssigned" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1b2192d7-503f-477a-9cfe-4efc3ee2bd60", + "orchestratorAppId": "546192d7-503f-477a-9cfe-4efc3ee2b6e1", + "orchestratorTenantId": "da6192d7-503f-477a-9cfe-4efc3ee2b6c3", + "clusterRootCA": "ddsadsad344mfdsfdl", + "apiServerEndpoint": "https://testk8s.cloudapp.net", + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller" + } + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/orchestrators/testk8s1", + "location": "West US", + "name": "testk8s1", + "type": "Microsoft.DelegatedNetwork/orchestrators", + "kind": "Kubernetes", + "properties": { + "provisioningState": "Provisioning", + "controllerDetails": { + "id": "/subscriptions/613192d7-503f-477a-9cfe-4efc3ee2bd60/resourceGroups/TestRG/providers/Microsoft.DelegatedNetwork/controller/testcontroller" + } + } + } + } + } +} diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/operations.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/operations.json new file mode 100644 index 000000000000..3c101da6934e --- /dev/null +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/operations.json @@ -0,0 +1,194 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-08-08-preview", + "title": "DNC", + "description": "DNC web api provides way to create, get and delete dnc controller" + }, + "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.DelegatedNetwork/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available DelegatedNetwork service REST API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "Get available operations": { + "$ref": "./examples/delegatedNetworkOperationsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "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/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of request to list controller operations.It contains a list of operations and a URL link to get the next set of results", + "type": "object", + "properties": { + "value": { + "type": "array", + "uniqueItems": false, + "readOnly": true, + "description": "List of operations supported by the Microsoft.DelegatedNetwork resource provider.", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string" + } + } + }, + "Operation": { + "description": "Microsoft.DelegatedNetwork REST API operation definition", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string", + "readOnly": true + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + }, + "isDataAction": { + "description": "Gets or sets a value indicating whether the operation is a data action or not.", + "type": "boolean" + }, + "display": { + "description": "Operation properties display", + "$ref": "#/definitions/OperationDisplay" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Properties of the operation" + } + } + }, + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "description": "Service provider: Microsoft.DelegatedNetwork.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Resource on which the operation is performed: controller, etc.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Operation type: create, get, delete, etc.", + "type": "string", + "readOnly": true + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Friendly description for the operation," + } + } + }, + "OperationProperties": { + "description": "Operation properties.", + "type": "object", + "properties": {} + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "description": "Error description", + "$ref": "#/definitions/ErrorDefinition" + } + } + }, + "ErrorDefinition": { + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Internal error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDefinition" + }, + "readOnly": true + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The client API version." + } + } +} diff --git a/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/orchestrators.json b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/orchestrators.json new file mode 100644 index 000000000000..82e58c69c10c --- /dev/null +++ b/specification/dnc/resource-manager/Microsoft.DelegatedNetwork/preview/2020-08-08-preview/orchestrators.json @@ -0,0 +1,567 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-08-08-preview", + "title": "DNC", + "description": "DNC web api provides way to create, get and delete dnc controller" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/orchestrators/{resourceName}": { + "get": { + "description": "Gets details about the orchestrator instance.", + "x-ms-examples": { + "Get details of a orchestratorInstance": { + "$ref": "./examples/getOrchestrator.json" + } + }, + "tags": [ + "OrchestratorInstance" + ], + "operationId": "OrchestratorInstanceService_GetDetails", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The operation was successful.", + "schema": { + "$ref": "#/definitions/Orchestrator" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Create a orchestrator instance", + "x-ms-examples": { + "Create orchestrator instance": { + "$ref": "./examples/putOrchestrator.json" + } + }, + "tags": [ + "OrchestratorInstance" + ], + "operationId": "OrchestratorInstanceService_Create", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Orchestrator" + }, + "description": "OrchestratorInstance type parameters" + } + ], + "responses": { + "200": { + "description": "OK. The operation completed successfully.", + "schema": { + "$ref": "#/definitions/Orchestrator" + } + }, + "201": { + "description": "InProgress. The operation is still in progress.", + "schema": { + "$ref": "#/definitions/Orchestrator" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "description": "Deletes the Orchestrator Instance", + "x-ms-examples": { + "Delete Orchestrator Instance": { + "$ref": "./examples/deleteOrchestrator.json" + } + }, + "tags": [ + "OrchestratorInstance" + ], + "operationId": "OrchestratorInstanceService_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$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/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "description": "Update Orchestrator Instance", + "x-ms-examples": { + "update Orchestrator Instance": { + "$ref": "./examples/patchOrchestrator.json" + } + }, + "tags": [ + "OrchestratorInstance" + ], + "operationId": "OrchestratorInstanceService_Patch", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OrchestratorResourceUpdateParameters" + }, + "description": "OrchestratorInstance update parameters" + } + ], + "responses": { + "200": { + "description": "OK. The operation completed successfully.", + "schema": { + "$ref": "#/definitions/Orchestrator" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DelegatedNetwork/orchestrators": { + "get": { + "tags": [ + "OrchestratorInstanceList" + ], + "description": "Get all the orchestratorInstance resources in a subscription.", + "operationId": "OrchestratorInstanceService_ListBySubscription", + "x-ms-examples": { + "Get orchestratorInstance resources by subscription": { + "$ref": "./examples/orchestratorInstanceListBySub.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the orchestratorInstance in the subscription.", + "schema": { + "$ref": "#/definitions/Orchestrators" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DelegatedNetwork/orchestrators": { + "get": { + "tags": [ + "OrchestratorInstanceList" + ], + "description": "Get all the OrchestratorInstances resources in a resource group.", + "operationId": "OrchestratorInstanceService_ListByResourceGroup", + "x-ms-examples": { + "Get OrchestratorInstance resources by resource group": { + "$ref": "./examples/orchestratorInstanceListByRG.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the orchestratorInstances in the resource group.", + "schema": { + "$ref": "#/definitions/Orchestrators" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "OrchestratorResource": { + "description": "Represents an instance of a resource.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "An identifier that represents the resource." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The type of resource." + }, + "location": { + "type": "string", + "description": "Location of the resource." + }, + "kind": { + "type": "string", + "description": "The kind of workbook. Choices are user and shared.", + "enum": [ + "Kubernetes" + ], + "x-ms-enum": { + "name": "OrchestratorKind", + "modelAsString": true + } + }, + "identity": { + "$ref": "#/definitions/OrchestratorIdentity", + "description": "The identity of the orchestrator" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "required": [ + "kind" + ], + "x-ms-azure-resource": true + }, + "OrchestratorResourceUpdateParameters": { + "description": "Parameters for updating a resource.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + } + }, + "Orchestrators": { + "description": "An array of OrchestratorInstance resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Orchestrator" + }, + "description": "An array of OrchestratorInstance resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of orchestrators.", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "Orchestrator": { + "description": "Represents an instance of a orchestrator.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OrchestratorResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OrchestratorResourceProperties", + "description": "Properties of the provision operation request." + } + } + }, + "OrchestratorResourceProperties": { + "description": "Properties of orchestrator", + "type": "object", + "properties": { + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Resource guid." + }, + "provisioningState": { + "type": "string", + "enum": [ + "Deleting", + "Succeeded", + "Failed", + "Provisioning" + ], + "x-ms-enum": { + "name": "OrchestratorInstanceState", + "modelAsString": true + }, + "readOnly": true, + "description": "The current state of orchestratorInstance resource." + }, + "orchestratorAppId": { + "description": "AAD ID used with apiserver", + "type": "string" + }, + "orchestratorTenantId": { + "description": "TenantID of server App ID", + "type": "string" + }, + "clusterRootCA": { + "description": "RootCA certificate of kubernetes cluster base64 encoded", + "type": "string" + }, + "apiServerEndpoint": { + "description": "K8s APIServer url", + "type": "string" + }, + "controllerDetails": { + "description": "controller details", + "$ref": "#/definitions/ControllerDetails" + } + }, + "required": [ + "controllerDetails" + ] + }, + "OrchestratorIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity which is used by orchestrator." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity which is used by orchestrator." + }, + "type": { + "type": "string", + "description": "The type of identity used for orchestrator cluster. Type 'SystemAssigned' will use an implicitly created identity orchestrator clusters", + "enum": [ + "SystemAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + } + } + }, + "ControllerDetails": { + "description": "controller details", + "type": "object", + "properties": { + "id": { + "description": "controller arm resource id", + "type": "string" + } + } + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "description": "Error description", + "$ref": "#/definitions/ErrorDefinition" + } + } + }, + "ErrorDefinition": { + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Internal error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDefinition" + }, + "readOnly": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The client API version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "The name of the Azure Resource group of which a given DelegatedNetwork resource is part. This name must be at least 1 character in length, and no more than 90." + }, + "resourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "minLength": 3, + "maxLength": 63, + "x-ms-parameter-location": "method", + "description": "The name of the resource. It must be a minimum of 3 characters, and a maximum of 63." + } + } +} diff --git a/specification/dnc/resource-manager/readme.md b/specification/dnc/resource-manager/readme.md index 6b1b089bee9f..cec8467edf34 100644 --- a/specification/dnc/resource-manager/readme.md +++ b/specification/dnc/resource-manager/readme.md @@ -36,7 +36,10 @@ These settings apply only when `--tag=package-2020-08-08-preview` is specified o ``` yaml $(tag) == 'package-2020-08-08-preview' input-file: -- Microsoft.DelegatedNetwork/preview/2020-08-08-preview/DelegatedNetwork.json +- Microsoft.DelegatedNetwork/preview/2020-08-08-preview/controller.json +- Microsoft.DelegatedNetwork/preview/2020-08-08-preview/orchestrators.json +- Microsoft.DelegatedNetwork/preview/2020-08-08-preview/delegatedSubnets.json +- Microsoft.DelegatedNetwork/preview/2020-08-08-preview/operations.json ``` --- @@ -114,4 +117,3 @@ generate-interface: true See configuration in [readme.python.md](./readme.python.md) - From f4b75e2531a1225f556da91a2d6284104d9ed655 Mon Sep 17 00:00:00 2001 From: Phoenix He Date: Mon, 28 Sep 2020 10:22:03 +0800 Subject: [PATCH 150/164] Update alias in pull_request_assignmeng.yml (#10957) * Update alias in pull_request_assignmeng.yml * Update issue_assignment.yml --- .github/issue_assignment.yml | 2 +- .github/pull_request_assignment.yml | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/issue_assignment.yml b/.github/issue_assignment.yml index 7347c318e629..40be9f7f70ed 100644 --- a/.github/issue_assignment.yml +++ b/.github/issue_assignment.yml @@ -4,7 +4,7 @@ assignees: - yungezz - erich-wang - - NullMDR + - PhoenixHe-msft - raych1 - lirenhe - weidongxu-microsoft diff --git a/.github/pull_request_assignment.yml b/.github/pull_request_assignment.yml index 02ee93e0fdc2..44d81ed03425 100644 --- a/.github/pull_request_assignment.yml +++ b/.github/pull_request_assignment.yml @@ -84,7 +84,7 @@ paths: - "specification/@(containerservice|containerinstance)/**" reviewers: - - NullMDR + - PhoenixHe-msft - fengzhou-msft - yungezz @@ -99,7 +99,7 @@ paths: - "specification/portal/**" reviewers: - - NullMDR + - PhoenixHe-msft - rule: paths: @@ -123,7 +123,7 @@ - ".azure-pipelines-preproduction/**" reviewers: - akning-ms - - NullMDR + - PhoenixHe-msft - raych1 - rule: @@ -133,7 +133,7 @@ reviewers: - yungezz - erich-wang - - NullMDR + - PhoenixHe-msft - lirenhe - weidongxu-microsoft - ArcturusZhang From 654e235d1f32ce68d7f907a8621d8519b56b08b7 Mon Sep 17 00:00:00 2001 From: Himanshu Chandel Date: Sun, 27 Sep 2020 22:58:06 -0700 Subject: [PATCH 151/164] Updating items to remove additional properties (#10934) Co-authored-by: Himanshu Chandel --- .../preview/2020-09-01-preview/portal.json | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/portal.json b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/portal.json index c2531031f2bb..775e2613e185 100644 --- a/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/portal.json +++ b/specification/portal/resource-manager/Microsoft.Portal/preview/2020-09-01-preview/portal.json @@ -530,11 +530,8 @@ "parts": { "type": "array", "description": "The dashboard parts.", - "additionalProperties": { - "$ref": "#/definitions/DashboardParts" - }, "items": { - "type": "object" + "$ref": "#/definitions/DashboardParts" } }, "metadata": { @@ -553,11 +550,8 @@ "lenses": { "type": "array", "description": "The dashboard lenses.", - "additionalProperties": { - "$ref": "#/definitions/DashboardLens" - }, "items": { - "type": "object" + "$ref": "#/definitions/DashboardLens" } }, "metadata": { From ab60861c352b683c2e28dd5837175e99c01a3512 Mon Sep 17 00:00:00 2001 From: xaliciayang <59986952+xaliciayang@users.noreply.github.com> Date: Mon, 28 Sep 2020 10:24:21 -0700 Subject: [PATCH 152/164] Update databases.json (#10959) Remove "Currently the only supported option is GRS (GeoRedundantStorage)" from databases 2019 --- .../Microsoft.Sql/preview/2019-06-01-preview/databases.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/databases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/databases.json index 2e2db731b65d..1a3a82038457 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/databases.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/databases.json @@ -940,7 +940,7 @@ "type": "integer" }, "storageAccountType": { - "description": "The storage account type used to store backups for this database. Currently the only supported option is GRS (GeoRedundantStorage).", + "description": "The storage account type used to store backups for this database.", "enum": [ "GRS", "LRS", From 1aaf3c1c62ffc01ad21cf81e3ab30b3abdc51ed8 Mon Sep 17 00:00:00 2001 From: sahithikkss <53164851+sahithikkss@users.noreply.github.com> Date: Tue, 29 Sep 2020 01:48:53 +0530 Subject: [PATCH 153/164] Update QnAMaker.json - response code correction (#10828) * Update QnAMaker.json Correct PATCH EndpointSettings response code from 200 to 204 * Update example response set endpoint Update example response set endpoint * Prettier validation fix * required propery validation fix * remove alternateQuestionClusters from example * removed alternateQuestionClusters across the example Need to add it as a whole Active learning swagger update * ModelValidation fixed in example instead of spec - non breaking change --- .../data-plane/QnAMaker/stable/v4.0/QnAMaker.json | 7 ++----- .../QnAMaker/stable/v4.0/examples/SuccessfulRepKb.json | 2 +- .../stable/v4.0/examples/SuccessfulSetEpSettings.json | 5 +---- .../QnAMaker/stable/v4.0/examples/SuccessfulUpdKb.json | 8 -------- 4 files changed, 4 insertions(+), 18 deletions(-) diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json index 4e2a55047833..3a42dc889089 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json @@ -77,11 +77,8 @@ "application/json" ], "responses": { - "200": { - "description": "Response with endpointSettings update status.", - "schema": { - "type": "string" - } + "204": { + "description": "HTTP 204 No Content." }, "default": { "description": "Error response.", diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulRepKb.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulRepKb.json index 640d3f21dc32..fd6ba1224539 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulRepKb.json +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulRepKb.json @@ -5,7 +5,7 @@ "Ocp-Apim-Subscription-Key": "{API key}", "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff", "replaceKb": { - "qnaList": [ + "qnAList": [ { "id": 0, "answer": "You can change the default message if you use the QnAMakerDialog. See this for details: https://docs.botframework.com/en-us/azure-bot-service/templates/qnamaker/#navtitle", diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulSetEpSettings.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulSetEpSettings.json index a12bd163bd89..468c0b59680a 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulSetEpSettings.json +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulSetEpSettings.json @@ -10,9 +10,6 @@ } }, "responses": { - "200": { - "headers": {}, - "body": "Successfully updated endpoint settings" - } + "204": {} } } diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulUpdKb.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulUpdKb.json index 0a767648beb6..3c717ca27123 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulUpdKb.json +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulUpdKb.json @@ -48,9 +48,6 @@ "add": [], "delete": [] }, - "alternateQuestionClusters": { - "delete": [] - }, "context": { "isContextOnly": false, "promptsToAdd": [ @@ -65,7 +62,6 @@ "How can I add prompts?" ], "metadata": [], - "alternateQuestionClusters": [], "context": { "isContextOnly": false, "prompts": [] @@ -84,7 +80,6 @@ "How can I delete delete prompts?" ], "metadata": [], - "alternateQuestionClusters": [], "context": { "isContextOnly": false, "prompts": [] @@ -126,9 +121,6 @@ } ] }, - "alternateQuestionClusters": { - "delete": [] - }, "context": { "isContextOnly": false, "promptsToAdd": [ From 5b8e4157c807c8874edc850079751ac83b5e2de0 Mon Sep 17 00:00:00 2001 From: sahithikkss <53164851+sahithikkss@users.noreply.github.com> Date: Tue, 29 Sep 2020 02:23:43 +0530 Subject: [PATCH 154/164] strings update (#10969) --- .../data-plane/QnAMaker/stable/v4.0/QnAMaker.json | 2 +- .../data-plane/QnAMaker/stable/v4.0/QnAMakerRuntime.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json index 3a42dc889089..2afdea67435e 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json @@ -899,7 +899,7 @@ }, "language": { "type": "string", - "description": "Language of the knowledgebase.", + "description": "Language of the knowledgebase. Please find the list of supported languages     here.", "maxLength": 100, "minLength": 1 } diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMakerRuntime.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMakerRuntime.json index 843426973bd1..04490d47590a 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMakerRuntime.json +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMakerRuntime.json @@ -339,7 +339,7 @@ }, "userId": { "type": "string", - "description": "Unique identifier for the user." + "description": "Unique identifier for the user. Optional parameter for telemetry. For more information, refer Analytics and Telemetry." }, "isTest": { "type": "boolean", From c615f7ce8604464def11dde08b0729559aee1055 Mon Sep 17 00:00:00 2001 From: Andre Pinto <31374863+anpint@users.noreply.github.com> Date: Mon, 28 Sep 2020 18:55:05 -0700 Subject: [PATCH 155/164] [Microsoft.StorageSync] Introduce 2020-09-01 API version (#10836) * Adds base for updating Microsoft.StorageSync from version stable/2020-03-01 to version 2020-09-01 * Updates readme * Updates API version in new specs and examples * Fix small issues with API version format in readme.md --- .../examples/CloudEndpoints_Create.json | 51 + .../examples/CloudEndpoints_Delete.json | 28 + .../examples/CloudEndpoints_Get.json | 33 + .../CloudEndpoints_ListBySyncGroup.json | 36 + .../examples/CloudEndpoints_PostBackup.json | 34 + .../examples/CloudEndpoints_PostRestore.json | 49 + .../examples/CloudEndpoints_PreBackup.json | 29 + .../examples/CloudEndpoints_PreRestore.json | 47 + .../CloudEndpoints_RestoreHeatbeat.json | 18 + ...CloudEndpoints_TriggerChangeDetection.json | 30 + .../examples/OperationStatus_Get.json | 25 + .../2020-09-01/examples/Operations_List.json | 214 + .../PrivateEndpointConnections_Create.json | 46 + .../PrivateEndpointConnections_Delete.json | 23 + .../PrivateEndpointConnections_Get.json | 29 + ...tConnections_ListByStorageSyncService.json | 48 + .../examples/PrivateLinkResources_List.json | 33 + .../examples/RegisteredServers_Create.json | 60 + .../examples/RegisteredServers_Delete.json | 27 + .../examples/RegisteredServers_Get.json | 42 + ...teredServers_ListByStorageSyncService.json | 45 + .../RegisteredServers_TriggerRollover.json | 29 + .../examples/ServerEndpoints_Create.json | 65 + .../examples/ServerEndpoints_Delete.json | 27 + .../examples/ServerEndpoints_Get.json | 149 + .../ServerEndpoints_ListBySyncGroup.json | 193 + .../examples/ServerEndpoints_Recall.json | 31 + .../examples/ServerEndpoints_Update.json | 88 + ...ceCheckNameAvailability_AlreadyExists.json | 20 + ...erviceCheckNameAvailability_Available.json | 18 + .../examples/StorageSyncServices_Create.json | 38 + .../examples/StorageSyncServices_Delete.json | 21 + .../examples/StorageSyncServices_Get.json | 43 + ...orageSyncServices_ListByResourceGroup.json | 55 + ...torageSyncServices_ListBySubscription.json | 54 + .../examples/StorageSyncServices_Update.json | 43 + .../examples/SyncGroups_Create.json | 24 + .../examples/SyncGroups_Delete.json | 18 + .../2020-09-01/examples/SyncGroups_Get.json | 26 + .../SyncGroups_ListByStorageSyncService.json | 29 + .../2020-09-01/examples/Workflows_Abort.json | 17 + .../2020-09-01/examples/Workflows_Get.json | 29 + .../Workflows_ListByStorageSyncService.json | 32 + .../preview/2020-09-01/storagesync.json | 4954 +++++++++++++++++ .../storagesync/resource-manager/readme.md | 13 +- 45 files changed, 6961 insertions(+), 2 deletions(-) create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Create.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Delete.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Get.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_ListBySyncGroup.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PostBackup.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PostRestore.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PreBackup.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PreRestore.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_RestoreHeatbeat.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_TriggerChangeDetection.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/OperationStatus_Get.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Operations_List.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Create.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Delete.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Get.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_ListByStorageSyncService.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateLinkResources_List.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Create.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Delete.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Get.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_ListByStorageSyncService.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_TriggerRollover.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Create.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Delete.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Get.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_ListBySyncGroup.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Recall.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Update.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_Available.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Create.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Delete.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Get.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_ListByResourceGroup.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_ListBySubscription.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Update.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Create.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Delete.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Get.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_ListByStorageSyncService.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_Abort.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_Get.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_ListByStorageSyncService.json create mode 100644 specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/storagesync.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Create.json new file mode 100644 index 000000000000..c7286db17334 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Create.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2020-09-01", + "parameters": { + "properties": { + "storageAccountResourceId": "/subscriptions/744f4d70-6d17-4921-8970-a765d14f763f/resourceGroups/tminienv59svc/providers/Microsoft.Storage/storageAccounts/tminienv59storage", + "azureFileShareName": "cvcloud-afscv-0719-058-a94a1354-a1fd-4e9a-9a50-919fad8c4ba4", + "storageAccountTenantId": "\"72f988bf-86f1-41af-91ab-2d7cd011db47\"", + "friendlyName": "ankushbsubscriptionmgmtmab" + } + } + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleCloudEndpoint_1", + "properties": { + "backupEnabled": "false", + "provisioningState": "Succeeded", + "storageAccountResourceId": "/subscriptions/744f4d70-6d17-4921-8970-a765d14f763f/resourceGroups/tminienv59svc/providers/Microsoft.Storage/storageAccounts/tminienv59storage", + "azureFileShareName": "cvcloud-afscv-0719-058-a94a1354-a1fd-4e9a-9a50-919fad8c4ba4", + "storageAccountTenantId": "\"72f988bf-86f1-41af-91ab-2d7cd011db47\"", + "friendlyName": "ankushbsubscriptionmgmtmab", + "lastWorkflowId": "storageSyncServices/GATest/workflows/24ba0c4a-348e-419b-8f7a-091d0d9f07a4", + "partnershipId": "1|U0VSVkVSQVNTWU5DQ0xJRU5USEZTVjJ8RjhDODcwQTItMkFGNi00NDUyLTgzMDgtRjJCQTZEQjI3RkEwfEdFTkVSSUN8NTJCOERBMkYtNjFFMC00QTFGLThEREUtMzM2OTExRjM2N0ZC", + "lastOperationName": "ICreateCloudEndpointWorkflow" + }, + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/cloudEndpoints/SampleCloudEndpoint_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncservice_1/workflows/c1d54be7-4738-4898-8212-cc36774314f8/operations/7ce689b2-0eca-48f5-86f0-0b8d6ceef14a?api-version=2020-09-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncservice_1/workflows/c1d54be7-4738-4898-8212-cc36774314f8/operationresults/7ce689b2-0eca-48f5-86f0-0b8d6ceef14a?api-version=2020-09-01", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Delete.json new file mode 100644 index 000000000000..b487abd29d5b --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Delete.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operations/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2020-09-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operationresults/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2020-09-01", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "204": {} + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Get.json new file mode 100644 index 000000000000..aa12f906e412 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleCloudEndpoint_1", + "properties": { + "provisioningState": "Succeeded", + "storageAccountResourceId": "", + "azureFileShareName": "", + "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"", + "lastWorkflowId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/a377fdd5-949a-40ab-9629-06cd0e9852f9", + "friendlyName": "SampleAzureFileShareName_1", + "partnershipId": "1|U0VSVkVSQVNTWU5DQ0xJRU5USEZTVjJ8MTkxNjYwQ0QtNkExQS00RjhDLTk3ODctQTZCRUQyMDZBMUREfEdFTkVSSUN8M0EwNDgyODMtMzM4Ri00MDAyLUE5REQtQTUwRkRBRENCMzky", + "lastOperationName": "ICreateCloudEndpointWorkflow" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/cloudEndpoints/CEP_Restore_08-08_Test112", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_ListBySyncGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_ListBySyncGroup.json new file mode 100644 index 000000000000..d7ea0c467cb8 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_ListBySyncGroup.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "value": [ + { + "name": "CEP_Restore_08-08_Test112", + "properties": { + "provisioningState": "Succeeded", + "storageAccountResourceId": "", + "azureFileShareName": "", + "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"", + "lastWorkflowId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/a377fdd5-949a-40ab-9629-06cd0e9852f9", + "friendlyName": "SampleAzureFileShareName_1", + "partnershipId": "1|U0VSVkVSQVNTWU5DQ0xJRU5Udfsdfdsfs8MTkxNjYwQ0QtNkExQS00RjhDLTk3ODctQTZCRUQyMDZBMUREfEdFTkVSSUN8M0EwNDgyODMtMzM4Ri00MDAyLUE5REQtQTUwRkRBRENCMzky", + "lastOperationName": "ICreateCloudEndpointWorkflow" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/cloudEndpoints/CEP_Restore_08-08_Test112", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + } + ] + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PostBackup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PostBackup.json new file mode 100644 index 000000000000..92c3e2894a3d --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PostBackup.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "parameters": { + "azureFileShare": "https://sampleserver.file.core.test-cint.azure-test.net/sampleFileShare" + }, + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "backupMetadata": { + "cloudEndpointName": "subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/cloudEndpoints/SampleCloudEndpoint_1" + } + } + }, + "202": { + "headers": { + "x-ms-location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/HfsMabFS1/syncGroups/HfsMabDS1/cloudEndpoints/HfsMabCE1/operationresults/baa40401-b043-4d1b-a80b-cb4e79fa1398?api-version=2020-09-01&resourcetype=PostBackupResourceType&ifxctx3=1847a938-7638-4d1b-943c-96ff2f8a2ec8", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PostRestore.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PostRestore.json new file mode 100644 index 000000000000..cb39f0bb3622 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PostRestore.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "parameters": { + "azureFileShareUri": "https://hfsazbackupdevintncus2.file.core.test-cint.azure-test.net/sampleFileShare", + "sourceAzureFileShareUri": "https://hfsazbackupdevintncus2.file.core.test-cint.azure-test.net/sampleFileShare", + "status": "Succeeded", + "restoreFileSpec": [ + { + "path": "text1.txt", + "isdir": false + }, + { + "path": "MyDir", + "isdir": true + }, + { + "path": "MyDir/SubDir", + "isdir": false + }, + { + "path": "MyDir/SubDir/File1.pdf", + "isdir": false + } + ] + }, + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "202": { + "headers": { + "x-ms-location": "https: //management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/HfsMabFS1/syncGroups/HfsMabDS1/cloudEndpoints/HfsMabCE1/operationresults/d67cfb91-1b13-4710-8226-83467bb5b66d?api-version=2020-09-01&resourcetype=preBackupResourceType&ifxctx3=005909ad-d156-4514-a26e-dd1cc566db64", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PreBackup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PreBackup.json new file mode 100644 index 000000000000..8b480d7a4227 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PreBackup.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2020-09-01", + "parameters": { + "azureFileShare": "https://sampleserver.file.core.test-cint.azure-test.net/sampleFileShare" + } + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "202": { + "headers": { + "x-ms-location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/HfsMabFS1/syncGroups/HfsMabDS1/cloudEndpoints/HfsMabCE1/operationresults/d67cfb91-1b13-4710-8226-83467bb5b66d?api-version=2020-09-01&resourcetype=preBackupResourceType&ifxctx3=005909ad-d156-4514-a26e-dd1cc566db64", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PreRestore.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PreRestore.json new file mode 100644 index 000000000000..91062e6f90ad --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_PreRestore.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2020-09-01", + "parameters": { + "azureFileShareUri": "https://hfsazbackupdevintncus2.file.core.test-cint.azure-test.net/sampleFileShare", + "restoreFileSpec": [ + { + "path": "text1.txt", + "isdir": false + }, + { + "path": "MyDir", + "isdir": true + }, + { + "path": "MyDir/SubDir", + "isdir": false + }, + { + "path": "MyDir/SubDir/File1.pdf", + "isdir": false + } + ] + } + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "202": { + "headers": { + "x-ms-location": "https: //management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/HfsMabFS1/syncGroups/HfsMabDS1/cloudEndpoints/HfsMabCE1/operationresults/d67cfb91-1b13-4710-8226-83467bb5b66d?api-version=2020-09-01&resourcetype=preBackupResourceType&ifxctx3=005909ad-d156-4514-a26e-dd1cc566db64", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_RestoreHeatbeat.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_RestoreHeatbeat.json new file mode 100644 index 000000000000..4f8c0fa23156 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_RestoreHeatbeat.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_TriggerChangeDetection.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_TriggerChangeDetection.json new file mode 100644 index 000000000000..57a15665b0a5 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/CloudEndpoints_TriggerChangeDetection.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "parameters": { + "directoryPath": "NewDirectory", + "changeDetectionMode": "Recursive" + }, + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "202": { + "headers": { + "x-ms-location": "https: //management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/HfsMabFS1/syncGroups/HfsMabDS1/cloudEndpoints/HfsMabCE1/operationresults/d67cfb91-1b13-4710-8226-83467bb5b66d?api-version=2020-09-01&resourcetype=preBackupResourceType&ifxctx3=005909ad-d156-4514-a26e-dd1cc566db64", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/OperationStatus_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/OperationStatus_Get.json new file mode 100644 index 000000000000..a06342086b23 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/OperationStatus_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "locationName": "westus", + "workflowId": "828219ea-083e-48b5-89ea-8fd9991b2e75", + "operationId": "14b50e24-f68d-4b29-a882-38be9dfb8bd1", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "14b50e24-f68d-4b29-a882-38be9dfb8bd1", + "status": "Succeeded", + "startTime": "2019-05-09T23:53:21.7328715Z", + "endTime": "2019-05-09T23:53:23.3735483Z", + "error": null + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Operations_List.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Operations_List.json new file mode 100644 index 000000000000..fcce130bcff9 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Operations_List.json @@ -0,0 +1,214 @@ +{ + "parameters": { + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.StorageSync/storageSyncServices/read", + "display": { + "provider": "Microsoft.StorageSync", + "resource": "Storage Sync Services", + "operation": "Read Storage Sync Services", + "description": "Read any Storage Sync Services" + }, + "origin": "User" + }, + { + "name": "Microsoft.StorageSync/storageSyncServices/write", + "display": { + "provider": "Microsoft.StorageSync", + "resource": "Storage Sync Services", + "operation": "Create or Update Storage Sync Services", + "description": "Create or Update any Storage Sync Services" + }, + "origin": "User" + }, + { + "name": "Microsoft.StorageSync/storageSyncServices/delete", + "display": { + "provider": "Microsoft.StorageSync", + "resource": "Storage Sync Services", + "operation": "Delete Storage Sync Services", + "description": "Delete any Storage Sync Services" + }, + "origin": "User" + }, + { + "name": "Microsoft.StorageSync/storageSyncServices/syncGroups/read", + "display": { + "provider": "Microsoft.StorageSync", + "resource": "Sync Groups", + "operation": "Read Sync Groups", + "description": "Read any Sync Groups" + }, + "origin": "User" + }, + { + "name": "Microsoft.StorageSync/storageSyncServices/syncGroups/write", + "display": { + "provider": "Microsoft.StorageSync", + "resource": "Sync Groups", + "operation": "Create or Update Sync Groups", + "description": "Create or Update any Sync Groups" + }, + "origin": "User" + }, + { + "name": "Microsoft.StorageSync/storageSyncServices/syncGroups/delete", + "display": { + "provider": "Microsoft.StorageSync", + "resource": "Sync Groups", + "operation": "Delete Sync Groups", + "description": "Delete any Sync Groups" + }, + "origin": "User" + }, + { + "name": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints/read", + "display": { + "provider": "Microsoft.StorageSync", + "resource": "Cloud Endpoints", + "operation": "Read Cloud Endpoints", + "description": "Read any Cloud Endpoints" + }, + "origin": "User" + }, + { + "name": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints/write", + "display": { + "provider": "Microsoft.StorageSync", + "resource": "Cloud Endpoints", + "operation": "Create or Update Cloud Endpoints", + "description": "Create or Update any Cloud Endpoints" + }, + "origin": "User" + }, + { + "name": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints/delete", + "display": { + "provider": "Microsoft.StorageSync", + "resource": "Cloud Endpoints", + "operation": "Delete Cloud Endpoints", + "description": "Delete any Cloud Endpoints" + }, + "origin": "User" + }, + { + "name": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints/prebackup/action", + "display": { + "provider": "Microsoft.StorageSync", + "resource": "Cloud Endpoints", + "operation": "prebackup", + "description": "Call this action before backup" + }, + "origin": "User" + }, + { + "name": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints/postbackup/action", + "display": { + "provider": "Microsoft.StorageSync", + "resource": "Cloud Endpoints", + "operation": "postbackup", + "description": "Call this action after backup" + }, + "origin": "User" + }, + { + "name": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints/prerestore/action", + "display": { + "provider": "Microsoft.StorageSync", + "resource": "Cloud Endpoints", + "operation": "prerestore", + "description": "Call this action before restore" + }, + "origin": "User" + }, + { + "name": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints/postrestore/action", + "display": { + "provider": "Microsoft.StorageSync", + "resource": "Cloud Endpoints", + "operation": "postrestore", + "description": "Call this action after restore" + }, + "origin": "User" + }, + { + "name": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints/read", + "display": { + "provider": "Microsoft.StorageSync", + "resource": "Server Endpoints", + "operation": "Read Server Endpoints", + "description": "Read any Server Endpoints" + }, + "origin": "User" + }, + { + "name": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints/write", + "display": { + "provider": "Microsoft.StorageSync", + "resource": "Server Endpoints", + "operation": "Create or Update Server Endpoints", + "description": "Create or Update any Server Endpoints" + }, + "origin": "User" + }, + { + "name": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints/delete", + "display": { + "provider": "Microsoft.StorageSync", + "resource": "Server Endpoints", + "operation": "Delete Server Endpoints", + "description": "Delete any Server Endpoints" + }, + "origin": "User" + }, + { + "name": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints/recallAction/action", + "display": { + "provider": "Microsoft.StorageSync", + "resource": "Server Endpoints", + "operation": "recallAction", + "description": "Call this action to recall files to a server" + }, + "origin": "User" + }, + { + "name": "Microsoft.StorageSync/storageSyncServices/registeredServers/read", + "display": { + "provider": "Microsoft.StorageSync", + "resource": "Registered Server", + "operation": "Read Registered Server", + "description": "Read any Registered Server" + }, + "origin": "User" + }, + { + "name": "Microsoft.StorageSync/storageSyncServices/registeredServers/write", + "display": { + "provider": "Microsoft.StorageSync", + "resource": "Registered Server", + "operation": "Create or Update Registered Server", + "description": "Create or Update any Registered Server" + }, + "origin": "User" + }, + { + "name": "Microsoft.StorageSync/storageSyncServices/registeredServers/delete", + "display": { + "provider": "Microsoft.StorageSync", + "resource": "Registered Server", + "operation": "Delete Registered Server", + "description": "Delete any Registered Server" + }, + "origin": "User" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Create.json new file mode 100644 index 000000000000..9c1a989f3e26 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Create.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res7687", + "storageSyncServiceName": "sss2527", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2020-09-01", + "monitor": "true", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.StorageSync/storageSyncServices/sss2527/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.StorageSync/storageSyncServices/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operations/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2020-09-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operationresults/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2020-09-01", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Delete.json new file mode 100644 index 000000000000..c6410fa5f083 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "storageSyncServiceName": "sss2527", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2020-09-01", + "monitor": "true" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operations/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2020-09-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operationresults/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2020-09-01", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "204": {} + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Get.json new file mode 100644 index 000000000000..07048c36b7dc --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "storageSyncServiceName": "sss2527", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2020-09-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.StorageSync/storageSyncServices/sss2527/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.StorageSync/storageSyncServices/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_ListByStorageSyncService.json new file mode 100644 index 000000000000..f82166720521 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateEndpointConnections_ListByStorageSyncService.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "storageSyncServiceName": "sss2527", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2020-09-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.StorageSync/storageSyncServices/sss2527/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.StorageSync/storageSyncServices/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.StorageSync/storageSyncServices/sss2527/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.StorageSync/storageSyncServices/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res7231/providers/Microsoft.Network/privateEndpoints/petest02" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + ] + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateLinkResources_List.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateLinkResources_List.json new file mode 100644 index 000000000000..56d373b01187 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/PrivateLinkResources_List.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res6977", + "storageSyncServiceName": "sss2527", + "api-version": "2020-09-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/res6977/providers/Microsoft.StorageSync/storageSyncServices/sss2527/privateLinkResources/afs", + "name": "afs", + "type": "Microsoft.StorageSync/storageSyncServices/privateLinkResources", + "properties": { + "groupId": "afs", + "requiredMembers": [ + "management", + "sync.primary", + "sync.secondary" + ], + "requiredZoneNames": [ + "privatelink.afs.azure.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Create.json new file mode 100644 index 000000000000..bce5be84808d --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Create.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "serverId": "\"080d4133-bdb5-40a0-96a0-71a6057bfe9a\"", + "parameters": { + "properties": { + "serverRole": "Standalone", + "serverCertificate": "\"MIIDFjCCAf6gAwIBAgIQQS+DS8uhc4VNzUkTw7wbRjANBgkqhkiG9w0BAQ0FADAzMTEwLwYDVQQDEyhhbmt1c2hiLXByb2QzLnJlZG1vbmQuY29ycC5taWNyb3NvZnQuY29tMB4XDTE3MDgwMzE3MDQyNFoXDTE4MDgwNDE3MDQyNFowMzExMC8GA1UEAxMoYW5rdXNoYi1wcm9kMy5yZWRtb25kLmNvcnAubWljcm9zb2Z0LmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALDRvV4gmsIy6jGDPiHsXmvgVP749NNP7DopdlbHaNhjFmYINHl0uWylyaZmgJrROt2mnxN/zEyJtGnqYHlzUr4xvGq/qV5pqgdB9tag/sw9i22gfe9PRZ0FmSOZnXMbLYgLiDFqLtut5gHcOuWMj03YnkfoBEKlFBxWbagvW2yxz/Sxi9OVSJOKCaXra0RpcIHrO/KFl6ho2eE1/7Ykmfa8hZvSdoPd5gHdLiQcMB/pxq+mWp1fI6c8vFZoDu7Atn+NXTzYPKUxKzaisF12TsaKpohUsJpbB3Wocb0F5frn614D2pg14ERB5otjAMWw1m65csQWPI6dP8KIYe0+QPkCAwEAAaMmMCQwIgYDVR0lAQH/BBgwFgYIKwYBBQUHAwIGCisGAQQBgjcKAwwwDQYJKoZIhvcNAQENBQADggEBAA4RhVIBkw34M1RwakJgHvtjsOFxF1tVQA941NtLokx1l2Z8+GFQkcG4xpZSt+UN6wLerdCbnNhtkCErWUDeaT0jxk4g71Ofex7iM04crT4iHJr8mi96/XnhnkTUs+GDk12VgdeeNEczMZz+8Mxw9dJ5NCnYgTwO0SzGlclRsDvjzkLo8rh2ZG6n/jKrEyNXXo+hOqhupij0QbRP2Tvexdfw201kgN1jdZify8XzJ8Oi0bTS0KpJf2pNPOlooK2bjMUei9ANtEdXwwfVZGWvVh6tJjdv6k14wWWJ1L7zhA1IIVb1J+sQUzJji5iX0DrezjTz1Fg+gAzITaA/WsuujlM=\"", + "lastHeartBeat": "\"2017-08-08T18:29:06.470652Z\"", + "serverOSVersion": "10.0.14393.0", + "agentVersion": "1.0.277.0" + } + }, + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/530a0384-50ac-456d-8240-9d6621404151", + "type": "Microsoft.StorageSync/storageSyncServices/registeredServers", + "name": "ankushb-prod3.redmond.corp.microsoft.com", + "properties": { + "agentVersion": "3.1.5.0", + "serverOSVersion": "10.0.14393.0", + "serverManagementErrorCode": 0, + "lastHeartBeat": "\"2018-06-11T21:50:40.5840543Z\"", + "provisioningState": "Succeeded", + "serverRole": "Standalone", + "clusterId": "\"00000000-0000-0000-0000-000000000000\"", + "clusterName": "", + "serverId": "\"3635ca8b-5cc8-4a5c-bd43-c2de5ad8dc64\"", + "storageSyncServiceUid": "\"4aa14534-1c61-483b-b6a6-9630a76f109a\"", + "lastWorkflowId": "storageSyncServices/CV_FileStore_F1D485AA/workflows/4eecfbcf-9537-4b61-8fee-aaa3ace11c44", + "lastOperationName": "ICreateRegisteredServerWorkflow", + "friendlyName": "afscv-2304-139", + "managementEndpointUri": "\"https://kailanitest99.one.microsoft.com:443/\"", + "monitoringEndpointUri": "\"https://kailanitest99.one.microsoft.com:443/\"", + "discoveryEndpointUri": "\"https://kailanitest99.one.microsoft.com:443\"", + "resourceLocation": "westus", + "serviceLocation": "westus" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/63e554fd-4d27-4b91-8249-2fc697de7c69/operations/d4b00aa1-7ae0-47f0-9fa7-7ed3ea527bc9?api-version=2020-09-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/63e554fd-4d27-4b91-8249-2fc697de7c69/operationresults/d4b00aa1-7ae0-47f0-9fa7-7ed3ea527bc9?api-version=2020-09-01", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Delete.json new file mode 100644 index 000000000000..21b501c31b59 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Delete.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "serverId": "41166691-ab03-43e9-ab3e-0330eda162ac", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/cdb963fd-ea36-457e-9222-f85754ff398c/operations/20675646-8111-4158-954b-6b637e922cbf?api-version=2020-09-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/cdb963fd-ea36-457e-9222-f85754ff398c/operationresults/20675646-8111-4158-954b-6b637e922cbf?api-version=2020-09-01", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "204": {} + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Get.json new file mode 100644 index 000000000000..17212565d8e0 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "serverId": "080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleRegisteredServer_1.redmond.corp.microsoft.com", + "properties": { + "agentVersion": "3.1.5.0", + "serverOSVersion": "10.0.14393.0", + "serverManagementErrorCode": 0, + "lastHeartBeat": "\"2018-06-11T21:50:40.5840543Z\"", + "provisioningState": "Succeeded", + "serverRole": "Standalone", + "clusterId": "\"00000000-0000-0000-0000-000000000000\"", + "clusterName": "", + "serverId": "\"3635ca8b-5cc8-4a5c-bd43-c2de5ad8dc64\"", + "storageSyncServiceUid": "\"4aa14534-1c61-483b-b6a6-9630a76f109a\"", + "lastWorkflowId": "storageSyncServices/CV_FileStore_F1D485AA/workflows/4eecfbcf-9537-4b61-8fee-aaa3ace11c44", + "lastOperationName": "ICreateRegisteredServerWorkflow", + "friendlyName": "afscv-2304-139", + "managementEndpointUri": "\"https://kailanitest99.one.microsoft.com:443/\"", + "monitoringEndpointUri": "\"https://kailanitest99.one.microsoft.com:443/\"", + "discoveryEndpointUri": "\"https://kailanitest99.one.microsoft.com:443\"", + "resourceLocation": "westus", + "serviceLocation": "westus" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "type": "Microsoft.StorageSync/storageSyncServices/registeredServers" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_ListByStorageSyncService.json new file mode 100644 index 000000000000..f5fb12049f87 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_ListByStorageSyncService.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "value": [ + { + "name": "SampleRegisteredServer_1.redmond.corp.microsoft.com", + "properties": { + "agentVersion": "3.1.5.0", + "serverOSVersion": "10.0.14393.0", + "serverManagementErrorCode": 0, + "lastHeartBeat": "\"2018-06-11T21:50:40.5840543Z\"", + "provisioningState": "Succeeded", + "serverRole": "Standalone", + "clusterId": "\"00000000-0000-0000-0000-000000000000\"", + "clusterName": "", + "serverId": "\"3635ca8b-5cc8-4a5c-bd43-c2de5ad8dc64\"", + "storageSyncServiceUid": "\"4aa14534-1c61-483b-b6a6-9630a76f109a\"", + "lastWorkflowId": "storageSyncServices/CV_FileStore_F1D485AA/workflows/4eecfbcf-9537-4b61-8fee-aaa3ace11c44", + "lastOperationName": "ICreateRegisteredServerWorkflow", + "friendlyName": "afscv-2304-139", + "managementEndpointUri": "\"https://kailanitest99.one.microsoft.com:443/\"", + "monitoringEndpointUri": "\"https://kailanitest99.one.microsoft.com:443/\"", + "discoveryEndpointUri": "\"https://kailanitest99.one.microsoft.com:443\"", + "resourceLocation": "westus", + "serviceLocation": "westus" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "type": "Microsoft.StorageSync/storageSyncServices/registeredServers" + } + ] + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_TriggerRollover.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_TriggerRollover.json new file mode 100644 index 000000000000..649faa8b0888 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/RegisteredServers_TriggerRollover.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "serverId": "d166ca76-dad2-49df-b409-12345642d730", + "parameters": { + "serverCertificate": "\"MIIDFjCCAf6gAwIBAgIQQS+DS8uhc4VNzUkTw7wbRjANBgkqhkiG9w0BAQ0FADAzMTEwLwYDVQQDEyhhbmt1c2hiLXByb2QzLnJlZG1vbmQuY29ycC5taWNyb3NvZnQuY29tMB4XDTE3MDgwMzE3MDQyNFoXDTE4MDgwNDE3MDQyNFowMzExMC8GA1UEAxMoYW5rdXNoYi1wcm9kMy5yZWRtb25kLmNvcnAubWljcm9zb2Z0LmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALDRvV4gmsIy6jGDPiHsXmvgVP749NNP7DopdlbHaNhjFmYINHl0uWylyaZmgJrROt2mnxN/zEyJtGnqYHlzUr4xvGq/qV5pqgdB9tag/sw9i22gfe9PRZ0FmSOZnXMbLYgLiDFqLtut5gHcOuWMj03YnkfoBEKlFBxWbagvW2yxz/Sxi9OVSJOKCaXra0RpcIHrO/KFl6ho2eE1/7Ykmfa8hZvSdoPd5gHdLiQcMB/pxq+mWp1fI6c8vFZoDu7Atn+NXTzYPKUxKzaisF12TsaKpohUsJpbB3Wocb0F5frn614D2pg14ERB5otjAMWw1m65csQWPI6dP8KIYe0+QPkCAwEAAaMmMCQwIgYDVR0lAQH/BBgwFgYIKwYBBQUHAwIGCisGAQQBgjcKAwwwDQYJKoZIhvcNAQENBQADggEBAA4RhVIBkw34M1RwakJgHvtjsOFxF1tVQA941NtLokx1l2Z8+GFQkcG4xpZSt+UN6wLerdCbnNhtkCErWUDeaT0jxk4g71Ofex7iM04crT4iHJr8mi96/XnhnkTUs+GDk12VgdeeNEczMZz+8Mxw9dJ5NCnYgTwO0SzGlclRsDvjzkLo8rh2ZG6n/jKrEyNXXo+hOqhupij0QbRP2Tvexdfw201kgN1jdZify8XzJ8Oi0bTS0KpJf2pNPOlooK2bjMUei9ANtEdXwwfVZGWvVh6tJjdv6k14wWWJ1L7zhA1IIVb1J+sQUzJji5iX0DrezjTz1Fg+gAzITaA/WsuujlM=\"" + }, + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47222", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d222" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Create.json new file mode 100644 index 000000000000..8d6a79f7a091 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Create.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "serverEndpointName": "SampleServerEndpoint_1", + "parameters": { + "properties": { + "serverLocalPath": "D:\\SampleServerEndpoint_1", + "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "cloudTiering": "off", + "volumeFreeSpacePercent": 100, + "tierFilesOlderThanDays": 0, + "offlineDataTransfer": "on", + "offlineDataTransferShareName": "myfileshare", + "initialDownloadPolicy": "NamespaceThenModifiedFiles", + "localCacheMode": "UpdateLocallyCachedFiles" + } + }, + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleServerEndpoint_1", + "properties": { + "serverLocalPath": "D:\\SampleServerEndpoint_1", + "cloudTiering": "off", + "volumeFreeSpacePercent": 100, + "friendlyName": "somemachine.redmond.corp.microsoft.com", + "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "provisioningState": "Succeeded", + "lastWorkflowId": "storageSyncServices/healthDemo1/workflows/569afb5c-7172-4cf8-a8ea-d987f727f11a", + "lastOperationName": "ICreateServerEndpointWorkflow", + "tierFilesOlderThanDays": 0, + "syncStatus": null, + "offlineDataTransfer": "on", + "offlineDataTransferStorageAccountResourceId": "/subscriptions/744f4d70-6d17-4921-8970-a765d14f763f/resourceGroups/myRG/providers/Microsoft.Storage/storageAccounts/mysa", + "offlineDataTransferStorageAccountTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "offlineDataTransferShareName": "myfileshare", + "cloudTieringStatus": null, + "recallStatus": null, + "initialDownloadPolicy": "NamespaceThenModifiedFiles", + "localCacheMode": "UpdateLocallyCachedFiles" + }, + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Delete.json new file mode 100644 index 000000000000..cf7ebd290c61 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Delete.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "serverEndpointName": "SampleServerEndpoint_1", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/9122d971-147b-4dba-bada-1ceb7c9311e5/operations/6dce076b-1df5-4449-829b-69b24f38b5a1?api-version=2020-09-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/9122d971-147b-4dba-bada-1ceb7c9311e5/operationresults/6dce076b-1df5-4449-829b-69b24f38b5a1?api-version=2020-09-01", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Get.json new file mode 100644 index 000000000000..0a01e8805c2b --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Get.json @@ -0,0 +1,149 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "serverEndpointName": "SampleServerEndpoint_1", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleServerEndpoint_1", + "properties": { + "serverLocalPath": "D:\\SampleServerEndpoint_1", + "cloudTiering": "on", + "volumeFreeSpacePercent": 100, + "friendlyName": "somemachine.redmond.corp.microsoft.com", + "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "provisioningState": "Succeeded", + "lastWorkflowId": "storageSyncServices/healthDemo1/workflows/569afb5c-7172-4cf8-a8ea-d987f727f11a", + "lastOperationName": "ICreateServerEndpointWorkflow", + "tierFilesOlderThanDays": 0, + "syncStatus": { + "downloadHealth": "Healthy", + "uploadHealth": "Error", + "combinedHealth": "Error", + "syncActivity": "UploadAndDownload", + "totalPersistentFilesNotSyncingCount": null, + "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z", + "uploadStatus": { + "lastSyncResult": -2134351810, + "lastSyncTimestamp": "2018-06-11T23:32:51.1057915Z", + "lastSyncSuccessTimestamp": null, + "lastSyncPerItemErrorCount": 1000, + "persistentFilesNotSyncingCount": null, + "transientFilesNotSyncingCount": null, + "filesNotSyncingErrors": null + }, + "downloadStatus": { + "lastSyncResult": 0, + "lastSyncTimestamp": "2018-06-11T23:28:33.9217334Z", + "lastSyncSuccessTimestamp": "2018-06-11T23:28:33.9217334Z", + "lastSyncPerItemErrorCount": 0, + "persistentFilesNotSyncingCount": null, + "transientFilesNotSyncingCount": null, + "filesNotSyncingErrors": null + }, + "uploadActivity": { + "timestamp": "2018-06-11T23:32:51.1057915Z", + "perItemErrorCount": 300, + "appliedItemCount": 1000, + "totalItemCount": 2300, + "appliedBytes": 57348983, + "totalBytes": 1958367412 + }, + "downloadActivity": { + "timestamp": "2018-06-11T23:32:51.1057915Z", + "perItemErrorCount": 0, + "appliedItemCount": 100, + "totalItemCount": 300, + "appliedBytes": 94805587, + "totalBytes": 19583674 + }, + "offlineDataTransferStatus": "InProgress" + }, + "offlineDataTransfer": "on", + "offlineDataTransferStorageAccountResourceId": "/subscriptions/744f4d70-6d17-4921-8970-a765d14f763f/resourceGroups/myRG/providers/Microsoft.Storage/storageAccounts/mysa", + "offlineDataTransferStorageAccountTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "offlineDataTransferShareName": "myfileshare", + "initialDownloadPolicy": "NamespaceThenModifiedFiles", + "localCacheMode": "UpdateLocallyCachedFiles", + "cloudTieringStatus": { + "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z", + "health": "Error", + "healthLastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z", + "lastCloudTieringResult": -2134347771, + "lastSuccessTimestamp": "2018-06-11T23:32:51.1057915Z", + "spaceSavings": { + "lastUpdatedTimestamp": "2019-04-17T19:04:59.1959227Z", + "volumeSizeBytes": 922337203685477580, + "totalSizeCloudBytes": 100000000, + "cachedSizeBytes": 50000000, + "spaceSavingsPercent": 50, + "spaceSavingsBytes": 50000000 + }, + "cachePerformance": { + "lastUpdatedTimestamp": "2019-04-17T19:04:59.1959227Z", + "cacheHitBytes": 922337203685477580, + "cacheMissBytes": 922337203685477580, + "cacheHitBytesPercent": 50 + }, + "filesNotTiering": { + "lastUpdatedTimestamp": "2019-04-17T19:04:59.1959227Z", + "totalFileCount": 60, + "errors": [ + { + "errorCode": -2134347771, + "fileCount": 10 + }, + { + "errorCode": -2134347770, + "fileCount": 20 + }, + { + "errorCode": -2134347769, + "fileCount": 30 + } + ] + }, + "volumeFreeSpacePolicyStatus": { + "lastUpdatedTimestamp": "2019-04-17T19:04:59.1959227Z", + "effectiveVolumeFreeSpacePolicy": 30, + "currentVolumeFreeSpacePercent": 5 + }, + "datePolicyStatus": { + "lastUpdatedTimestamp": "2019-04-17T19:04:59.1959227Z", + "tieredFilesMostRecentAccessTimestamp": "2019-04-17T19:04:59.1959227Z" + } + }, + "recallStatus": { + "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z", + "totalRecallErrorsCount": 30, + "recallErrors": [ + { + "errorCode": -2134347775, + "count": 5 + }, + { + "errorCode": -2134347774, + "count": 10 + }, + { + "errorCode": -2134347773, + "count": 15 + } + ] + } + }, + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_ListBySyncGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_ListBySyncGroup.json new file mode 100644 index 000000000000..ea19f6efb835 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_ListBySyncGroup.json @@ -0,0 +1,193 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "value": [ + { + "name": "SampleServerEndpoint_1", + "properties": { + "serverLocalPath": "D:\\SampleServerEndpoint_1", + "cloudTiering": "off", + "volumeFreeSpacePercent": 100, + "friendlyName": "somemachine.redmond.corp.microsoft.com", + "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "provisioningState": "Succeeded", + "lastWorkflowId": "storageSyncServices/healthDemo1/workflows/569afb5c-7172-4cf8-a8ea-d987f727f11a", + "lastOperationName": "ICreateServerEndpointWorkflow", + "tierFilesOlderThanDays": 0, + "syncStatus": { + "downloadHealth": "Healthy", + "uploadHealth": "Error", + "combinedHealth": "Error", + "syncActivity": null, + "totalPersistentFilesNotSyncingCount": null, + "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z", + "uploadStatus": { + "lastSyncResult": 0, + "lastSyncTimestamp": "2018-06-11T23:32:51.1057915Z", + "lastSyncSuccessTimestamp": "2018-06-11T23:32:51.1057915Z", + "lastSyncPerItemErrorCount": 0, + "persistentFilesNotSyncingCount": null, + "transientFilesNotSyncingCount": null, + "filesNotSyncingErrors": null + }, + "downloadStatus": { + "lastSyncResult": 0, + "lastSyncTimestamp": "2018-06-11T23:28:33.9217334Z", + "lastSyncSuccessTimestamp": "2018-06-11T23:28:33.9217334Z", + "lastSyncPerItemErrorCount": 1000, + "persistentFilesNotSyncingCount": null, + "transientFilesNotSyncingCount": null, + "filesNotSyncingErrors": null + }, + "uploadActivity": null, + "downloadActivity": null, + "offlineDataTransferStatus": "Complete" + }, + "offlineDataTransfer": "on", + "offlineDataTransferStorageAccountResourceId": "/subscriptions/744f4d70-6d17-4921-8970-a765d14f763f/resourceGroups/myRG/providers/Microsoft.Storage/storageAccounts/mysa", + "offlineDataTransferStorageAccountTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "offlineDataTransferShareName": "myfileshare", + "initialDownloadPolicy": "NamespaceThenModifiedFiles", + "localCacheMode": "UpdateLocallyCachedFiles" + }, + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + }, + { + "name": "SampleServerEndpoint_2", + "properties": { + "serverLocalPath": "D:\\SampleServerEndpoint_2", + "cloudTiering": "on", + "volumeFreeSpacePercent": 80, + "friendlyName": "somemachine2.redmond.corp.microsoft.com", + "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/f94e2944-b48d-4e5b-bdc7-c48ab3712659", + "provisioningState": "Succeeded", + "lastWorkflowId": "storageSyncServices/healthDemo1/workflows/40b1dc00-d7d9-4721-a1e9-ab60139b830a", + "lastOperationName": "ICreateServerEndpointWorkflow", + "tierFilesOlderThanDays": 5, + "initialDownloadPolicy": "NamespaceThenModifiedFiles", + "localCacheMode": "UpdateLocallyCachedFiles", + "syncStatus": { + "downloadHealth": "Healthy", + "uploadHealth": "Healthy", + "combinedHealth": "Healthy", + "syncActivity": "Upload", + "totalPersistentFilesNotSyncingCount": null, + "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z", + "uploadStatus": { + "lastSyncResult": 0, + "lastSyncTimestamp": "2018-06-11T23:32:51.1057915Z", + "lastSyncSuccessTimestamp": "2018-06-11T23:28:33.9217334Z", + "lastSyncPerItemErrorCount": 0, + "persistentFilesNotSyncingCount": null, + "transientFilesNotSyncingCount": null, + "filesNotSyncingErrors": null + }, + "downloadStatus": { + "lastSyncResult": 0, + "lastSyncTimestamp": "2018-06-11T23:28:33.9217334Z", + "lastSyncSuccessTimestamp": "2018-06-11T23:28:33.9217334Z", + "lastSyncPerItemErrorCount": 0, + "persistentFilesNotSyncingCount": null, + "transientFilesNotSyncingCount": null, + "filesNotSyncingErrors": null + }, + "uploadActivity": { + "timestamp": "2018-06-11T23:32:51.1057915Z", + "perItemErrorCount": 300, + "appliedItemCount": 1000, + "totalItemCount": 2300, + "appliedBytes": 57348983, + "totalBytes": 1958367412 + }, + "downloadActivity": null, + "offlineDataTransferStatus": "NotRunning" + }, + "offlineDataTransfer": "off", + "cloudTieringStatus": { + "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z", + "health": "Error", + "healthLastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z", + "lastCloudTieringResult": -2134347771, + "lastSuccessTimestamp": "2018-06-11T23:32:51.1057915Z", + "spaceSavings": { + "lastUpdatedTimestamp": "2019-04-17T19:04:59.1959227Z", + "volumeSizeBytes": 922337203685477580, + "totalSizeCloudBytes": 100000000, + "cachedSizeBytes": 50000000, + "spaceSavingsPercent": 50, + "spaceSavingsBytes": 50000000 + }, + "cachePerformance": { + "lastUpdatedTimestamp": "2019-04-17T19:04:59.1959227Z", + "cacheHitBytes": 922337203685477580, + "cacheMissBytes": 922337203685477580, + "cacheHitBytesPercent": 50 + }, + "filesNotTiering": { + "lastUpdatedTimestamp": "2019-04-17T19:04:59.1959227Z", + "totalFileCount": 60, + "errors": [ + { + "errorCode": -2134347771, + "fileCount": 10 + }, + { + "errorCode": -2134347770, + "fileCount": 20 + }, + { + "errorCode": -2134347769, + "fileCount": 30 + } + ] + }, + "volumeFreeSpacePolicyStatus": { + "lastUpdatedTimestamp": "2019-04-17T19:04:59.1959227Z", + "effectiveVolumeFreeSpacePolicy": 30, + "currentVolumeFreeSpacePercent": 5 + }, + "datePolicyStatus": { + "lastUpdatedTimestamp": "2019-04-17T19:04:59.1959227Z", + "tieredFilesMostRecentAccessTimestamp": "2019-04-17T19:04:59.1959227Z" + } + }, + "recallStatus": { + "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z", + "totalRecallErrorsCount": 30, + "recallErrors": [ + { + "errorCode": -2134347775, + "count": 5 + }, + { + "errorCode": -2134347774, + "count": 10 + }, + { + "errorCode": -2134347773, + "count": 15 + } + ] + } + }, + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_2", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + } + ] + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Recall.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Recall.json new file mode 100644 index 000000000000..c4098d71cb89 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Recall.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "serverEndpointName": "SampleServerEndpoint_1", + "api-version": "2020-09-01", + "parameters": { + "pattern": "", + "recallPath": "" + } + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Update.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Update.json new file mode 100644 index 000000000000..27bfafc40e55 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/ServerEndpoints_Update.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "syncGroupName": "SampleSyncGroup_1", + "serverEndpointName": "SampleServerEndpoint_1", + "parameters": { + "properties": { + "cloudTiering": "off", + "volumeFreeSpacePercent": 100, + "tierFilesOlderThanDays": 0, + "offlineDataTransfer": "off", + "localCacheMode": "UpdateLocallyCachedFiles" + } + }, + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleServerEndpoint_1", + "properties": { + "serverLocalPath": "C:\\data_quota2", + "cloudTiering": "off", + "volumeFreeSpacePercent": 20, + "tierFilesOlderThanDays": 0, + "friendlyName": "somemachine2.redmond.corp.microsoft.com", + "serverResourceId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/anpintDemoRG/providers/kailanitest07.one.microsoft.com/storageSyncServices/healthdemo1/registeredServers/f94e2944-b48d-4e5b-bdc7-c48ab3712659", + "provisioningState": "Succeeded", + "lastWorkflowId": "storageSyncServices/healthDemo1/workflows/569afb5c-7172-4cf8-a8ea-d987f727f11b", + "lastOperationName": "ICreateServerEndpointWorkflow", + "syncStatus": { + "downloadHealth": "Healthy", + "uploadHealth": "Error", + "combinedHealth": "Error", + "syncActivity": null, + "totalPersistentFilesNotSyncingCount": null, + "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z", + "uploadStatus": { + "lastSyncResult": -2134351810, + "lastSyncTimestamp": "2018-06-11T23:32:51.1057915Z", + "lastSyncSuccessTimestamp": null, + "lastSyncPerItemErrorCount": 0, + "persistentFilesNotSyncingCount": null, + "transientFilesNotSyncingCount": null, + "filesNotSyncingErrors": null + }, + "downloadStatus": { + "lastSyncResult": 0, + "lastSyncTimestamp": "2018-06-11T23:28:33.9217334Z", + "lastSyncSuccessTimestamp": "2018-06-11T23:28:33.9217334Z", + "lastSyncPerItemErrorCount": 0, + "persistentFilesNotSyncingCount": null, + "transientFilesNotSyncingCount": null, + "filesNotSyncingErrors": null + }, + "uploadActivity": null, + "downloadActivity": null, + "offlineDataTransferStatus": "Stopping" + }, + "offlineDataTransfer": "off", + "offlineDataTransferStorageAccountResourceId": "/subscriptions/744f4d70-6d17-4921-8970-a765d14f763f/resourceGroups/myRG/providers/Microsoft.Storage/storageAccounts/mysa", + "offlineDataTransferStorageAccountTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "offlineDataTransferShareName": "myfileshare", + "initialDownloadPolicy": "NamespaceThenModifiedFiles", + "localCacheMode": "UpdateLocallyCachedFiles" + }, + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Swagger_08-09_Test212/workflows/3af798a9-26fd-44e7-a121-a4ad65f451bd/operations/ef2a30f4-9bb8-40e7-b403-5d6d3dc67a3c?api-version=2020-09-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Swagger_08-09_Test212/workflows/3af798a9-26fd-44e7-a121-a4ad65f451bd/operationresults/ef2a30f4-9bb8-40e7-b403-5d6d3dc67a3c?api-version=2020-09-01", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json new file mode 100644 index 000000000000..81403bd74522 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "5c6bc8e1-1eaf-4192-94d8-58ce463ac86c", + "locationName": "westus", + "parameters": { + "name": "newstoragesyncservicename", + "type": "Microsoft.StorageSync/storageSyncServices" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "An account named 'newstoragesyncservicename' is already in use." + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_Available.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_Available.json new file mode 100644 index 000000000000..c996ca88dc7b --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_Available.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2020-09-01", + "subscriptionId": "5c6bc8e1-1eaf-4192-94d8-58ce463ac86c", + "locationName": "westus", + "parameters": { + "name": "newstoragesyncservicename", + "type": "Microsoft.StorageSync/storageSyncServices" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Create.json new file mode 100644 index 000000000000..a5ba8a0da848 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Create.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "parameters": { + "properties": { + "incomingTrafficPolicy": "AllowAllTraffic" + }, + "location": "WestUS", + "tags": {} + }, + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "body": { + "name": "SampleStorageSyncService_1", + "location": "WestUS", + "properties": { + "incomingTrafficPolicy": "AllowAllTraffic" + }, + "tags": {}, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", + "type": "Microsoft.StorageSync/storageSyncServices" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Delete.json new file mode 100644 index 000000000000..d213969cc0f3 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Delete.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "api-version": "2020-09-01" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Get.json new file mode 100644 index 000000000000..e20d1009c05d --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleStorageSyncService_1", + "location": "WestUS", + "tags": {}, + "properties": { + "storageSyncServiceStatus": 0, + "incomingTrafficPolicy": "AllowAllTraffic", + "storageSyncServiceUid": "\"2de01144-72da-4d7f-9d0c-e858855114a8\"", + "privateEndpointConnections": [ + { + "id": "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/{resource}/{resourceName}/privateEndpointConnections/SampleStorageSyncService_1.cd99f12ba6f3483f9292229e4f822258", + "properties": { + "privateEndpoint": { + "id": "subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_2/providers/Microsoft.Network/privateEndpoints/testpe01" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my request, thanks." + } + } + } + ] + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", + "type": "Microsoft.StorageSync/storageSyncServices" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_ListByResourceGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_ListByResourceGroup.json new file mode 100644 index 000000000000..febc889077bb --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_ListByResourceGroup.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "value": [ + { + "name": "SampleStorageSyncService_1", + "location": "WestUS", + "tags": {}, + "properties": { + "storageSyncServiceStatus": 0, + "incomingTrafficPolicy": "AllowAllTraffic", + "storageSyncServiceUid": "\"3d1bf292-0f2a-4cc1-a3e1-60f35800e40c\"" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", + "type": "Microsoft.StorageSync/storageSyncServices" + }, + { + "name": "SampleStorageSyncService_2", + "location": "WestUS", + "tags": {}, + "properties": { + "storageSyncServiceStatus": 0, + "incomingTrafficPolicy": "AllowAllTraffic", + "storageSyncServiceUid": "\"2de01144-72da-4d7f-9d0c-e858855114a8\"" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_2", + "type": "Microsoft.StorageSync/storageSyncServices" + }, + { + "name": "SampleStorageSyncService_3", + "location": "WestUS", + "tags": {}, + "properties": { + "storageSyncServiceStatus": 0, + "incomingTrafficPolicy": "AllowAllTraffic", + "storageSyncServiceUid": "\"b2c58ee5-933e-462c-8a9e-b30f2bdd8fa3\"" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_3", + "type": "Microsoft.StorageSync/storageSyncServices" + } + ] + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_ListBySubscription.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_ListBySubscription.json new file mode 100644 index 000000000000..568500faeac6 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_ListBySubscription.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "value": [ + { + "name": "SampleStorageSyncService_1", + "location": "WestUS", + "tags": {}, + "properties": { + "storageSyncServiceStatus": 0, + "incomingTrafficPolicy": "AllowAllTraffic", + "storageSyncServiceUid": "\"3d1bf292-0f2a-4cc1-a3e1-60f35800e40c\"" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", + "type": "Microsoft.StorageSync/storageSyncServices" + }, + { + "name": "SampleStorageSyncService_2", + "location": "WestUS", + "tags": {}, + "properties": { + "storageSyncServiceStatus": 0, + "incomingTrafficPolicy": "AllowAllTraffic", + "storageSyncServiceUid": "\"2de01144-72da-4d7f-9d0c-e858855114a8\"" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_2", + "type": "Microsoft.StorageSync/storageSyncServices" + }, + { + "name": "SampleStorageSyncService_3", + "location": "WestUS", + "tags": {}, + "properties": { + "storageSyncServiceStatus": 0, + "incomingTrafficPolicy": "AllowAllTraffic", + "storageSyncServiceUid": "\"b2c58ee5-933e-462c-8a9e-b30f2bdd8fa3\"" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_3", + "type": "Microsoft.StorageSync/storageSyncServices" + } + ] + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Update.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Update.json new file mode 100644 index 000000000000..b5c846d0f8ca --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/StorageSyncServices_Update.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "parameters": { + "properties": { + "incomingTrafficPolicy": "AllowAllTraffic" + }, + "tags": { + "Environment": "Test", + "Dept": "IT" + } + }, + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "body": { + "name": "SampleStorageSyncService_1", + "location": "WestUS", + "properties": { + "incomingTrafficPolicy": "AllowAllTraffic" + }, + "tags": { + "Environment": "Test", + "Dept": "IT" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", + "type": "Microsoft.StorageSync/storageSyncServices" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2020-09-01", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Create.json new file mode 100644 index 000000000000..d06976ee1f44 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Create.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2020-09-01", + "parameters": { + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "name": "SampleSyncGroup_1", + "properties": { + "uniqueId": "7868e4ee-8ddd-4a2d-941b-0041f6052a8a" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Delete.json new file mode 100644 index 000000000000..ccea7daf7689 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "204": {} + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Get.json new file mode 100644 index 000000000000..0f13de87dfb7 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleSyncGroup_1", + "properties": { + "uniqueId": "191660cd-6a1a-4f8c-9787-a6bed206a1dd", + "syncGroupStatus": "0" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Restore_08-08_Test112/syncGroups/SampleSyncGroup_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_ListByStorageSyncService.json new file mode 100644 index 000000000000..d385682f66b8 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/SyncGroups_ListByStorageSyncService.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "value": [ + { + "name": "SampleSyncGroup_1", + "properties": { + "uniqueId": "191660cd-6a1a-4f8c-9787-a6bed206a1dd", + "syncGroupStatus": "0" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Restore_08-08_Test112/syncGroups/SampleSyncGroup_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups" + } + ] + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_Abort.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_Abort.json new file mode 100644 index 000000000000..0880db1c7ae3 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_Abort.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "workflowId": "7ffd50b3-5574-478d-9ff2-9371bc42ce68", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_Get.json new file mode 100644 index 000000000000..3bf8f97a2377 --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "workflowId": "828219ea-083e-48b5-89ea-8fd9991b2e75", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "828219ea-083e-48b5-89ea-8fd9991b2e75", + "properties": { + "status": "succeeded", + "lastOperationId": "\"fe680c98-5725-49c8-b0dc-5e29745f752b\"", + "operation": "do", + "lastStepName": "runServerJob", + "steps": "[{\"name\":\"validateInput\",\"friendlyName\":\"validateInput\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"newServerEndpoint\",\"friendlyName\":\"newServerEndpoint\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"updateReplicaGroupCertificates\",\"friendlyName\":\"updateReplicaGroupCertificates\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"runServerJob\",\"friendlyName\":\"runServerJob\",\"status\":\"Succeeded\",\"error\":null}]" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75", + "type": "Microsoft.StorageSync/storageSyncServices/workflows" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_ListByStorageSyncService.json new file mode 100644 index 000000000000..841dcbcf146d --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/examples/Workflows_ListByStorageSyncService.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "api-version": "2020-09-01" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "value": [ + { + "name": "828219ea-083e-48b5-89ea-8fd9991b2e75", + "properties": { + "status": "succeeded", + "lastOperationId": "\"fe680c98-5725-49c8-b0dc-5e29745f752b\"", + "operation": "do", + "lastStepName": "runServerJob", + "steps": "[{\"name\":\"validateInput\",\"friendlyName\":\"validateInput\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"newServerEndpoint\",\"friendlyName\":\"newServerEndpoint\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"updateReplicaGroupCertificates\",\"friendlyName\":\"updateReplicaGroupCertificates\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"runServerJob\",\"friendlyName\":\"runServerJob\",\"status\":\"Succeeded\",\"error\":null}]" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75", + "type": "Microsoft.StorageSync/storageSyncServices/workflows" + } + ] + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/storagesync.json new file mode 100644 index 000000000000..7924c45db99b --- /dev/null +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2020-09-01/storagesync.json @@ -0,0 +1,4954 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Storage Sync", + "description": "Microsoft Storage Sync Service API", + "version": "2020-09-01", + "x-ms-code-generation-settings": { + "name": "StorageSyncManagementClient" + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.StorageSync/operations": { + "get": { + "tags": [ + "ResourceProvider", + "Operations" + ], + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "Lists all of the available Storage Sync Rest API operations.", + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "responses": { + "200": { + "description": "Array of operations resources in the Resource Provider", + "schema": { + "$ref": "#/definitions/OperationEntityListResult" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/locations/{locationName}/checkNameAvailability": { + "post": { + "tags": [ + "StorageSyncService" + ], + "operationId": "StorageSyncServices_CheckNameAvailability", + "x-ms-examples": { + "StorageSyncServiceCheckNameAvailability_Available": { + "$ref": "./examples/StorageSyncServiceCheckNameAvailability_Available.json" + }, + "StorageSyncServiceCheckNameAvailability_AlreadyExists": { + "$ref": "./examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json" + } + }, + "description": "Check the give namespace name availability.", + "parameters": [ + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The desired region for the name check." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + }, + "description": "Parameters to check availability of the given namespace name" + } + ], + "responses": { + "200": { + "description": "check availability returned successfully.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}": { + "put": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Storage Sync Service resource name.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageSyncServiceCreateParameters" + } + } + ], + "tags": [ + "StorageSyncServices Resource" + ], + "operationId": "StorageSyncServices_Create", + "description": "Create a new StorageSyncService.", + "x-ms-examples": { + "StorageSyncServices_Create": { + "$ref": "./examples/StorageSyncServices_Create.json" + } + }, + "responses": { + "200": { + "description": "Storage Sync Service object created/updated", + "schema": { + "$ref": "#/definitions/StorageSyncService" + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Retry-After": { + "description": "Retry After", + "type": "string" + }, + "x-ms-request-id": { + "description": "Request id", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "StorageSyncServices Resource" + ], + "operationId": "StorageSyncServices_Get", + "description": "Get a given StorageSyncService.", + "x-ms-examples": { + "StorageSyncServices_Get": { + "$ref": "./examples/StorageSyncServices_Get.json" + } + }, + "responses": { + "200": { + "description": "Storage Sync Service object", + "schema": { + "$ref": "#/definitions/StorageSyncService" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "patch": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Storage Sync Service resource.", + "schema": { + "$ref": "#/definitions/StorageSyncServiceUpdateParameters" + } + } + ], + "tags": [ + "StorageSyncServices Resource" + ], + "operationId": "StorageSyncServices_Update", + "description": "Patch a given StorageSyncService.", + "x-ms-examples": { + "StorageSyncServices_Update": { + "$ref": "./examples/StorageSyncServices_Update.json" + } + }, + "responses": { + "200": { + "description": "Storage Sync Service object created/updated", + "schema": { + "$ref": "#/definitions/StorageSyncService" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Retry-After": { + "description": "Retry After", + "type": "string" + }, + "x-ms-request-id": { + "description": "Request id", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "StorageSyncServices Resource" + ], + "operationId": "StorageSyncServices_Delete", + "description": "Delete a given StorageSyncService.", + "x-ms-examples": { + "StorageSyncServices_Delete": { + "$ref": "./examples/StorageSyncServices_Delete.json" + } + }, + "responses": { + "200": { + "description": "Storage Sync Service object was deleted.", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Retry-After": { + "description": "Retry After", + "type": "string" + }, + "x-ms-request-id": { + "description": "Request id", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id", + "type": "string" + } + } + }, + "204": { + "description": "Storage Sync Service Resource doesn't exist" + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices": { + "get": { + "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" + } + ], + "tags": [ + "StorageSyncServices Resource" + ], + "operationId": "StorageSyncServices_ListByResourceGroup", + "description": "Get a StorageSyncService list by Resource group name.", + "x-ms-examples": { + "StorageSyncServices_ListByResourceGroup": { + "$ref": "./examples/StorageSyncServices_ListByResourceGroup.json" + } + }, + "responses": { + "200": { + "description": "Array of registered Storage Sync Service resources in the Resource Group", + "schema": { + "$ref": "#/definitions/StorageSyncServiceArray" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/storageSyncServices": { + "get": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "StorageSyncServices Resource" + ], + "operationId": "StorageSyncServices_ListBySubscription", + "description": "Get a StorageSyncService list by subscription.", + "x-ms-examples": { + "StorageSyncServices_ListBySubscription": { + "$ref": "./examples/StorageSyncServices_ListBySubscription.json" + } + }, + "responses": { + "200": { + "description": "Array of registered Storage Sync Service resources in the subscription.", + "schema": { + "$ref": "#/definitions/StorageSyncServiceArray" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_ListByStorageSyncService", + "description": "Gets the private link resources that need to be created for a storage sync service.", + "x-ms-examples": { + "PrivateLinkResources_List": { + "$ref": "./examples/PrivateLinkResources_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageSyncServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateLinkResourceListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the storage sync service.", + "x-ms-examples": { + "PrivateEndpointConnections_Get": { + "$ref": "./examples/PrivateEndpointConnections_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageSyncServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "OK -- Get the private endpoint connection properties successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Create", + "description": "Update the state of specified private endpoint connection associated with the storage sync service.", + "x-ms-examples": { + "PrivateEndpointConnections_Create": { + "$ref": "./examples/PrivateEndpointConnections_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageSyncServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "The private endpoint connection properties." + } + ], + "responses": { + "200": { + "description": "OK -- Update the private endpoint connection properties successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Retry-After": { + "description": "Retry After", + "type": "string" + }, + "x-ms-request-id": { + "description": "Request id", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "description": "Deletes the specified private endpoint connection associated with the storage sync service.", + "x-ms-examples": { + "PrivateEndpointConnections_Delete": { + "$ref": "./examples/PrivateEndpointConnections_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/StorageSyncServiceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the private endpoint connection successfully." + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Retry-After": { + "description": "Retry After", + "type": "string" + }, + "x-ms-request-id": { + "description": "Request id", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id", + "type": "string" + } + } + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/privateEndpointConnections": { + "get": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "PrivateEndpointConnection Resource" + ], + "operationId": "PrivateEndpointConnections_ListByStorageSyncService", + "description": "Get a PrivateEndpointConnection List.", + "x-ms-examples": { + "PrivateEndpointConnections_ListByStorageSyncService": { + "$ref": "./examples/PrivateEndpointConnections_ListByStorageSyncService.json" + } + }, + "responses": { + "200": { + "description": "Array of Sync Group resources in Storage Sync Service", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnectionListResult" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups": { + "get": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "SyncGroup Resource" + ], + "operationId": "SyncGroups_ListByStorageSyncService", + "description": "Get a SyncGroup List.", + "x-ms-examples": { + "SyncGroups_ListByStorageSyncService": { + "$ref": "./examples/SyncGroups_ListByStorageSyncService.json" + } + }, + "responses": { + "200": { + "description": "Array of Sync Group resources in Storage Sync Service", + "schema": { + "$ref": "#/definitions/SyncGroupArray" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}": { + "put": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Sync Group Body", + "required": true, + "schema": { + "$ref": "#/definitions/SyncGroupCreateParameters" + } + } + ], + "tags": [ + "SyncGroup Resource" + ], + "operationId": "SyncGroups_Create", + "description": "Create a new SyncGroup.", + "x-ms-examples": { + "SyncGroups_Create": { + "$ref": "./examples/SyncGroups_Create.json" + } + }, + "responses": { + "200": { + "description": "Sync Group object", + "schema": { + "$ref": "#/definitions/SyncGroup" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "get": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "SyncGroup Resource" + ], + "operationId": "SyncGroups_Get", + "description": "Get a given SyncGroup.", + "x-ms-examples": { + "SyncGroups_Get": { + "$ref": "./examples/SyncGroups_Get.json" + } + }, + "responses": { + "200": { + "description": "Sync Group object", + "schema": { + "$ref": "#/definitions/SyncGroup" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "delete": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "SyncGroup Resource" + ], + "operationId": "SyncGroups_Delete", + "description": "Delete a given SyncGroup.", + "x-ms-examples": { + "SyncGroups_Delete": { + "$ref": "./examples/SyncGroups_Delete.json" + } + }, + "responses": { + "200": { + "description": "Sync Group object was deleted", + "headers": { + "x-ms-request-id": { + "description": "Request id", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id", + "type": "string" + } + } + }, + "204": { + "description": "Resource doesn't exist" + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}": { + "put": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Cloud Endpoint resource.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudEndpointCreateParameters" + } + } + ], + "tags": [ + "CloudEndpoint Resource" + ], + "operationId": "CloudEndpoints_Create", + "description": "Create a new CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_Create": { + "$ref": "./examples/CloudEndpoints_Create.json" + } + }, + "responses": { + "200": { + "description": "Cloud Endpoint object", + "schema": { + "$ref": "#/definitions/CloudEndpoint" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Retry-After": { + "description": "Retry After", + "type": "string" + }, + "x-ms-request-id": { + "description": "Request id", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + } + ], + "tags": [ + "CloudEndpoint Resource" + ], + "operationId": "CloudEndpoints_Get", + "description": "Get a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_Get": { + "$ref": "./examples/CloudEndpoints_Get.json" + } + }, + "responses": { + "200": { + "description": "Cloud Endpoint object", + "schema": { + "$ref": "#/definitions/CloudEndpoint" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "delete": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + } + ], + "tags": [ + "CloudEndpoint Resource" + ], + "operationId": "CloudEndpoints_Delete", + "description": "Delete a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_Delete": { + "$ref": "./examples/CloudEndpoints_Delete.json" + } + }, + "responses": { + "200": { + "description": "Ok", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Retry-After": { + "description": "Retry After", + "type": "string" + }, + "x-ms-request-id": { + "description": "Request id", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id", + "type": "string" + } + } + }, + "204": { + "description": "Resource doesn't exist" + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints": { + "get": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "CloudEndpoint Resource" + ], + "operationId": "CloudEndpoints_ListBySyncGroup", + "description": "Get a CloudEndpoint List.", + "x-ms-examples": { + "CloudEndpoints_ListBySyncGroup": { + "$ref": "./examples/CloudEndpoints_ListBySyncGroup.json" + } + }, + "responses": { + "200": { + "description": "Array of Cloud Endpoint resources in Sync Group", + "schema": { + "$ref": "#/definitions/CloudEndpointArray" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prebackup": { + "post": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Backup request.", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + } + ], + "tags": [ + "CloudEndpoint Resource", + "Actions", + "Backup Restore" + ], + "operationId": "CloudEndpoints_PreBackup", + "description": "Pre Backup a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_PreBackup": { + "$ref": "./examples/CloudEndpoints_PreBackup.json" + } + }, + "responses": { + "200": { + "description": "Ok", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postbackup": { + "post": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Backup request.", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + } + ], + "tags": [ + "CloudEndpoint Resource", + "Actions", + "Backup Restore" + ], + "operationId": "CloudEndpoints_PostBackup", + "description": "Post Backup a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_PostBackup": { + "$ref": "./examples/CloudEndpoints_PostBackup.json" + } + }, + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/PostBackupResponse" + }, + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prerestore": { + "post": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Cloud Endpoint object.", + "required": true, + "schema": { + "$ref": "#/definitions/PreRestoreRequest" + } + } + ], + "tags": [ + "CloudEndpoint Resource", + "Actions", + "Backup Restore" + ], + "operationId": "CloudEndpoints_PreRestore", + "description": "Pre Restore a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_PreRestore": { + "$ref": "./examples/CloudEndpoints_PreRestore.json" + } + }, + "responses": { + "200": { + "description": "Ok" + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/restoreheartbeat": { + "post": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + } + ], + "tags": [ + "CloudEndpoint Resource", + "Actions", + "Backup Restore" + ], + "operationId": "CloudEndpoints_restoreheartbeat", + "description": "Restore Heartbeat a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_restoreheartbeat": { + "$ref": "./examples/CloudEndpoints_RestoreHeatbeat.json" + } + }, + "responses": { + "200": { + "description": "Restore Heartbeat Operation has ran successfully.", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postrestore": { + "post": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Cloud Endpoint object.", + "required": true, + "schema": { + "$ref": "#/definitions/PostRestoreRequest" + } + } + ], + "tags": [ + "CloudEndpoint Resource", + "Actions", + "Backup Restore" + ], + "operationId": "CloudEndpoints_PostRestore", + "description": "Post Restore a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_PostRestore": { + "$ref": "./examples/CloudEndpoints_PostRestore.json" + } + }, + "responses": { + "200": { + "description": "Ok" + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/triggerChangeDetection": { + "post": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Trigger Change Detection Action parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TriggerChangeDetectionParameters" + } + } + ], + "tags": [ + "CloudEndpoint Resource", + "Actions", + "Change Detection" + ], + "operationId": "CloudEndpoints_TriggerChangeDetection", + "description": "Triggers detection of changes performed on Azure File share connected to the specified Azure File Sync Cloud Endpoint.", + "x-ms-examples": { + "CloudEndpoints_TriggerChangeDetection": { + "$ref": "./examples/CloudEndpoints_TriggerChangeDetection.json" + } + }, + "responses": { + "200": { + "description": "Ok" + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}": { + "put": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "serverEndpointName", + "in": "path", + "description": "Name of Server Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Server Endpoint object.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerEndpointCreateParameters" + } + } + ], + "tags": [ + "ServerEndpoint Resource" + ], + "operationId": "ServerEndpoints_Create", + "description": "Create a new ServerEndpoint.", + "x-ms-examples": { + "ServerEndpoints_Create": { + "$ref": "./examples/ServerEndpoints_Create.json" + } + }, + "responses": { + "200": { + "description": "Server Endpoint object", + "schema": { + "$ref": "#/definitions/ServerEndpoint" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "serverEndpointName", + "in": "path", + "description": "Name of Server Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Any of the properties applicable in PUT request.", + "schema": { + "$ref": "#/definitions/ServerEndpointUpdateParameters" + } + } + ], + "tags": [ + "ServerEndpoint Resource" + ], + "operationId": "ServerEndpoints_Update", + "description": "Patch a given ServerEndpoint.", + "x-ms-examples": { + "ServerEndpoints_Update": { + "$ref": "./examples/ServerEndpoints_Update.json" + } + }, + "responses": { + "200": { + "description": "Server Endpoint object", + "schema": { + "$ref": "#/definitions/ServerEndpoint" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "serverEndpointName", + "in": "path", + "description": "Name of Server Endpoint object.", + "required": true, + "type": "string" + } + ], + "tags": [ + "ServerEndpoint Resource" + ], + "operationId": "ServerEndpoints_Get", + "description": "Get a ServerEndpoint.", + "x-ms-examples": { + "ServerEndpoints_Get": { + "$ref": "./examples/ServerEndpoints_Get.json" + } + }, + "responses": { + "200": { + "description": "Server Endpoint object", + "schema": { + "$ref": "#/definitions/ServerEndpoint" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "delete": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "serverEndpointName", + "in": "path", + "description": "Name of Server Endpoint object.", + "required": true, + "type": "string" + } + ], + "tags": [ + "ServerEndpoint Resource" + ], + "operationId": "ServerEndpoints_Delete", + "description": "Delete a given ServerEndpoint.", + "x-ms-examples": { + "ServerEndpoints_Delete": { + "$ref": "./examples/ServerEndpoints_Delete.json" + } + }, + "responses": { + "200": { + "description": "Ok", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints": { + "get": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "ServerEndpoint Resource" + ], + "operationId": "ServerEndpoints_ListBySyncGroup", + "description": "Get a ServerEndpoint list.", + "x-ms-examples": { + "ServerEndpoints_ListBySyncGroup": { + "$ref": "./examples/ServerEndpoints_ListBySyncGroup.json" + } + }, + "responses": { + "200": { + "description": "Array of Server Endpoint resources in Sync Group", + "schema": { + "$ref": "#/definitions/ServerEndpointArray" + }, + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}/recallAction": { + "post": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "serverEndpointName", + "in": "path", + "description": "Name of Server Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Recall Action object.", + "required": true, + "schema": { + "$ref": "#/definitions/RecallActionParameters" + } + } + ], + "tags": [ + "ServerEndpoint Resource", + "Actions" + ], + "operationId": "ServerEndpoints_recallAction", + "description": "Recall a server endpoint.", + "x-ms-examples": { + "ServerEndpoints_recallAction": { + "$ref": "./examples/ServerEndpoints_Recall.json" + } + }, + "responses": { + "200": { + "description": "Server Endpoint object", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers": { + "get": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "RegisteredServer Resource" + ], + "operationId": "RegisteredServers_ListByStorageSyncService", + "description": "Get a given registered server list.", + "x-ms-examples": { + "RegisteredServers_ListByStorageSyncService": { + "$ref": "./examples/RegisteredServers_ListByStorageSyncService.json" + } + }, + "responses": { + "200": { + "description": "Array of Registered Server resources in Storage Sync Service", + "schema": { + "$ref": "#/definitions/RegisteredServerArray" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}": { + "get": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "serverId", + "in": "path", + "description": "GUID identifying the on-premises server.", + "required": true, + "type": "string" + } + ], + "tags": [ + "RegisteredServer Resource" + ], + "operationId": "RegisteredServers_Get", + "description": "Get a given registered server.", + "x-ms-examples": { + "RegisteredServers_Get": { + "$ref": "./examples/RegisteredServers_Get.json" + } + }, + "responses": { + "200": { + "description": "Registered Server resources in Sync Group", + "schema": { + "$ref": "#/definitions/RegisteredServer" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "put": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "serverId", + "in": "path", + "description": "GUID identifying the on-premises server.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Registered Server object.", + "required": true, + "schema": { + "$ref": "#/definitions/RegisteredServerCreateParameters" + } + } + ], + "tags": [ + "RegisteredServer Resource" + ], + "operationId": "RegisteredServers_Create", + "description": "Add a new registered server.", + "x-ms-examples": { + "RegisteredServers_Create": { + "$ref": "./examples/RegisteredServers_Create.json" + } + }, + "responses": { + "200": { + "description": "Registered Server resources in Sync Group", + "schema": { + "$ref": "#/definitions/RegisteredServer" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "serverId", + "in": "path", + "description": "GUID identifying the on-premises server.", + "required": true, + "type": "string" + } + ], + "tags": [ + "RegisteredServer Resource" + ], + "operationId": "RegisteredServers_Delete", + "description": "Delete the given registered server.", + "x-ms-examples": { + "RegisteredServers_Delete": { + "$ref": "./examples/RegisteredServers_Delete.json" + } + }, + "responses": { + "200": { + "description": "Ok", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "204": { + "description": "Resource doesn't exist" + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}/triggerRollover": { + "post": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "serverId", + "in": "path", + "description": "Server Id", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Trigger Rollover request.", + "required": true, + "schema": { + "$ref": "#/definitions/TriggerRolloverRequest" + } + } + ], + "tags": [ + "RegisteredServer Resource", + "Actions" + ], + "operationId": "RegisteredServers_triggerRollover", + "description": "Triggers Server certificate rollover.", + "x-ms-examples": { + "RegisteredServers_triggerRollover": { + "$ref": "./examples/RegisteredServers_TriggerRollover.json" + } + }, + "responses": { + "200": { + "description": "Trigger Rollover success status", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows": { + "get": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "Workflow Resource" + ], + "operationId": "Workflows_ListByStorageSyncService", + "description": "Get a Workflow List", + "x-ms-examples": { + "Workflows_ListByStorageSyncService": { + "$ref": "./examples/Workflows_ListByStorageSyncService.json" + } + }, + "responses": { + "200": { + "description": "Array of Workflow resources in Storage Sync Service", + "schema": { + "$ref": "#/definitions/WorkflowArray" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}": { + "get": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "workflowId", + "in": "path", + "description": "workflow Id", + "required": true, + "type": "string" + } + ], + "tags": [ + "Workflow Resource" + ], + "operationId": "Workflows_Get", + "description": "Get Workflows resource", + "x-ms-examples": { + "Workflows_Get": { + "$ref": "./examples/Workflows_Get.json" + } + }, + "responses": { + "200": { + "description": "Workflow object", + "schema": { + "$ref": "#/definitions/Workflow" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}/abort": { + "post": { + "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": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "workflowId", + "in": "path", + "description": "workflow Id", + "required": true, + "type": "string" + } + ], + "tags": [ + "Workflow Resource", + "Actions" + ], + "operationId": "Workflows_Abort", + "description": "Abort the given workflow.", + "x-ms-examples": { + "Workflows_Abort": { + "$ref": "./examples/Workflows_Abort.json" + } + }, + "responses": { + "200": { + "description": "success", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/locations/{locationName}/workflows/{workflowId}/operations/{operationId}": { + "get": { + "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": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The desired region to obtain information from." + }, + { + "name": "workflowId", + "in": "path", + "description": "workflow Id", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "operation Id", + "required": true, + "type": "string" + } + ], + "tags": [ + "Operation Status" + ], + "operationId": "OperationStatus_Get", + "description": "Get Operation status", + "x-ms-examples": { + "Workflows_Get": { + "$ref": "./examples/OperationStatus_Get.json" + } + }, + "responses": { + "200": { + "description": "Operation Status", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + } + } + }, + "definitions": { + "StorageSyncError": { + "type": "object", + "description": "Error type", + "properties": { + "error": { + "$ref": "#/definitions/StorageSyncApiError", + "description": "Error details of the given entry." + }, + "innererror": { + "$ref": "#/definitions/StorageSyncApiError", + "description": "Error details of the given entry." + } + } + }, + "StorageSyncApiError": { + "type": "object", + "description": "Error type", + "properties": { + "code": { + "type": "string", + "description": "Error code of the given entry." + }, + "message": { + "type": "string", + "description": "Error message of the given entry." + }, + "target": { + "type": "string", + "description": "Target of the given error entry." + }, + "details": { + "$ref": "#/definitions/StorageSyncErrorDetails", + "description": "Error details of the given entry." + } + } + }, + "StorageSyncErrorDetails": { + "type": "object", + "description": "Error Details object.", + "properties": { + "code": { + "type": "string", + "description": "Error code of the given entry." + }, + "message": { + "type": "string", + "description": "Error message of the given entry." + }, + "target": { + "type": "string", + "description": "Target of the given entry." + } + } + }, + "SubscriptionState": { + "type": "object", + "description": "Subscription State object.", + "properties": { + "state": { + "type": "string", + "description": "State of Azure Subscription", + "enum": [ + "Registered", + "Unregistered", + "Warned", + "Suspended", + "Deleted" + ], + "x-ms-enum": { + "name": "Reason", + "modelAsString": true + } + }, + "istransitioning": { + "type": "boolean", + "description": "Is Transitioning", + "readOnly": true + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SubscriptionStateProperties", + "description": "Subscription state properties." + } + } + }, + "StorageSyncService": { + "type": "object", + "description": "Storage Sync Service object.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageSyncServiceProperties", + "description": "Storage Sync Service properties." + } + } + }, + "SyncGroup": { + "type": "object", + "description": "Sync Group object.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SyncGroupProperties", + "description": "SyncGroup properties." + } + } + }, + "CloudEndpoint": { + "type": "object", + "description": "Cloud Endpoint object.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CloudEndpointProperties", + "description": "Cloud Endpoint properties." + } + } + }, + "TriggerChangeDetectionParameters": { + "properties": { + "directoryPath": { + "type": "string", + "description": "Relative path to a directory Azure File share for which change detection is to be performed." + }, + "changeDetectionMode": { + "type": "string", + "description": "Change Detection Mode. Applies to a directory specified in directoryPath parameter.", + "enum": [ + "Default", + "Recursive" + ], + "x-ms-enum": { + "name": "changeDetectionMode", + "modelAsString": true + } + }, + "paths": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of relative paths on the Azure File share to be included in the change detection. Can be files and directories." + } + }, + "description": "The parameters used when calling trigger change detection action on cloud endpoint." + }, + "RecallActionParameters": { + "properties": { + "pattern": { + "type": "string", + "description": "Pattern of the files." + }, + "recallPath": { + "type": "string", + "description": "Recall path." + } + }, + "description": "The parameters used when calling recall action on server endpoint." + }, + "StorageSyncServiceCreateParameters": { + "properties": { + "location": { + "type": "string", + "description": "Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageSyncServiceCreateParametersProperties", + "description": "The parameters used to create the storage sync service." + } + }, + "required": [ + "location" + ], + "description": "The parameters used when creating a storage sync service." + }, + "SyncGroupCreateParameters": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SyncGroupCreateParametersProperties", + "description": "The parameters used to create the sync group" + } + }, + "description": "The parameters used when creating a sync group." + }, + "SyncGroupCreateParametersProperties": { + "type": "object", + "description": "Sync Group Create Properties object.", + "properties": {} + }, + "CloudEndpointCreateParameters": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CloudEndpointCreateParametersProperties", + "description": "The parameters used to create the cloud endpoint." + } + }, + "description": "The parameters used when creating a cloud endpoint." + }, + "StorageSyncServiceCreateParametersProperties": { + "description": "StorageSyncService Properties object.", + "properties": { + "incomingTrafficPolicy": { + "$ref": "#/definitions/IncomingTrafficPolicy", + "description": "Incoming Traffic Policy" + } + } + }, + "CloudEndpointCreateParametersProperties": { + "description": "CloudEndpoint Properties object.", + "properties": { + "storageAccountResourceId": { + "type": "string", + "description": "Storage Account Resource Id" + }, + "azureFileShareName": { + "type": "string", + "description": "Azure file share name" + }, + "storageAccountTenantId": { + "type": "string", + "description": "Storage Account Tenant Id" + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + } + } + }, + "ServerEndpointCreateParameters": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServerEndpointCreateParametersProperties", + "description": "The parameters used to create the server endpoint." + } + }, + "description": "The parameters used when creating a server endpoint." + }, + "ServerEndpointCreateParametersProperties": { + "description": "ServerEndpoint Properties object.", + "properties": { + "serverLocalPath": { + "$ref": "#/definitions/PhysicalPath", + "description": "Server Local path." + }, + "cloudTiering": { + "$ref": "#/definitions/FeatureStatus", + "description": "Cloud Tiering." + }, + "volumeFreeSpacePercent": { + "type": "integer", + "minimum": 0, + "maximum": 100, + "description": "Level of free space to be maintained by Cloud Tiering if it is enabled." + }, + "tierFilesOlderThanDays": { + "type": "integer", + "minimum": 0, + "maximum": 2147483647, + "description": "Tier files older than days." + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + }, + "serverResourceId": { + "$ref": "#/definitions/ResourceId", + "description": "Server Resource Id." + }, + "offlineDataTransfer": { + "$ref": "#/definitions/FeatureStatus", + "description": "Offline data transfer" + }, + "offlineDataTransferShareName": { + "type": "string", + "description": "Offline data transfer share name" + }, + "initialDownloadPolicy": { + "$ref": "#/definitions/InitialDownloadPolicy", + "description": "Policy for how namespace and files are recalled during FastDr." + }, + "localCacheMode": { + "$ref": "#/definitions/LocalCacheMode", + "description": "Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access." + } + } + }, + "TriggerRolloverRequest": { + "type": "object", + "description": "Trigger Rollover Request.", + "properties": { + "serverCertificate": { + "type": "string", + "description": "Certificate Data" + } + } + }, + "RegisteredServerCreateParameters": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RegisteredServerCreateParametersProperties", + "description": "The parameters used to create the registered server." + } + }, + "description": "The parameters used when creating a registered server." + }, + "RegisteredServerCreateParametersProperties": { + "description": "RegisteredServer Create Properties object.", + "properties": { + "serverCertificate": { + "type": "string", + "description": "Registered Server Certificate" + }, + "agentVersion": { + "type": "string", + "description": "Registered Server Agent Version" + }, + "serverOSVersion": { + "type": "string", + "description": "Registered Server OS Version" + }, + "lastHeartBeat": { + "type": "string", + "description": "Registered Server last heart beat" + }, + "serverRole": { + "type": "string", + "description": "Registered Server serverRole" + }, + "clusterId": { + "type": "string", + "description": "Registered Server clusterId" + }, + "clusterName": { + "type": "string", + "description": "Registered Server clusterName" + }, + "serverId": { + "type": "string", + "description": "Registered Server serverId" + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + } + } + }, + "ServerEndpointUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServerEndpointUpdateProperties", + "description": "The properties of the server endpoint." + } + }, + "description": "Parameters for updating an Server Endpoint." + }, + "ServerEndpoint": { + "type": "object", + "description": "Server Endpoint object.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServerEndpointProperties", + "description": "Server Endpoint properties." + } + } + }, + "RegisteredServer": { + "type": "object", + "description": "Registered Server resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RegisteredServerProperties", + "description": "RegisteredServer properties." + } + } + }, + "ResourcesMoveInfo": { + "type": "object", + "description": "Resource Move Info.", + "properties": { + "targetResourceGroup": { + "type": "string", + "description": "Target resource group." + }, + "resources": { + "type": "array", + "description": "Collection of Resources.", + "items": { + "$ref": "#/definitions/ResourceId" + } + } + } + }, + "Workflow": { + "type": "object", + "description": "Workflow resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkflowProperties", + "description": "Workflow properties." + } + } + }, + "OperationEntityListResult": { + "description": "The list of storage sync operations.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of operations.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationEntity" + } + } + } + }, + "OperationEntity": { + "description": "The operation supported by storage sync.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplayInfo", + "description": "The operation supported by storage sync." + }, + "origin": { + "type": "string", + "description": "The origin." + } + } + }, + "OperationDisplayInfo": { + "description": "The operation supported by storage sync.", + "type": "object", + "properties": { + "description": { + "description": "The description of the operation.", + "type": "string" + }, + "operation": { + "description": "The action that users can perform, based on their permission level.", + "type": "string" + }, + "provider": { + "description": "Service provider: Microsoft StorageSync.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + } + } + }, + "OperationDisplayResource": { + "type": "object", + "description": "Operation Display Resource object.", + "properties": { + "provider": { + "type": "string", + "description": "Operation Display Resource Provider." + }, + "resource": { + "type": "string", + "description": "Operation Display Resource." + }, + "operation": { + "type": "string", + "description": "Operation Display Resource Operation." + }, + "description": { + "type": "string", + "description": "Operation Display Resource Description." + } + } + }, + "CheckNameAvailabilityParameters": { + "properties": { + "name": { + "type": "string", + "description": "The name to check for availability" + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.StorageSync/storageSyncServices" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": false + }, + "description": "The resource type. Must be set to Microsoft.StorageSync/storageSyncServices" + } + }, + "required": [ + "name", + "type" + ], + "description": "Parameters for a check name availability request." + }, + "CheckNameAvailabilityResult": { + "properties": { + "nameAvailable": { + "readOnly": true, + "type": "boolean", + "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used." + }, + "reason": { + "readOnly": true, + "type": "string", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "NameAvailabilityReason", + "modelAsString": false + }, + "description": "Gets the reason that a Storage Sync Service name could not be used. The Reason element is only returned if NameAvailable is false." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "Gets an error message explaining the Reason value in more detail." + } + }, + "description": "The CheckNameAvailability operation response." + }, + "PostRestoreRequest": { + "type": "object", + "description": "Post Restore Request", + "properties": { + "partition": { + "type": "string", + "description": "Post Restore partition." + }, + "replicaGroup": { + "type": "string", + "description": "Post Restore replica group." + }, + "requestId": { + "type": "string", + "description": "Post Restore request id." + }, + "azureFileShareUri": { + "type": "string", + "description": "Post Restore Azure file share uri." + }, + "status": { + "type": "string", + "description": "Post Restore Azure status." + }, + "sourceAzureFileShareUri": { + "type": "string", + "description": "Post Restore Azure source azure file share uri." + }, + "failedFileList": { + "type": "string", + "description": "Post Restore Azure failed file list." + }, + "restoreFileSpec": { + "type": "array", + "description": "Post Restore restore file spec array.", + "items": { + "$ref": "#/definitions/RestoreFileSpec", + "description": "Post Restore restore file spec items array." + } + } + } + }, + "PreRestoreRequest": { + "type": "object", + "description": "Pre Restore request object.", + "properties": { + "partition": { + "type": "string", + "description": "Pre Restore partition." + }, + "replicaGroup": { + "type": "string", + "description": "Pre Restore replica group." + }, + "requestId": { + "type": "string", + "description": "Pre Restore request id." + }, + "azureFileShareUri": { + "type": "string", + "description": "Pre Restore Azure file share uri." + }, + "status": { + "type": "string", + "description": "Pre Restore Azure status." + }, + "sourceAzureFileShareUri": { + "type": "string", + "description": "Pre Restore Azure source azure file share uri." + }, + "backupMetadataPropertyBag": { + "type": "string", + "description": "Pre Restore backup metadata property bag." + }, + "restoreFileSpec": { + "type": "array", + "description": "Pre Restore restore file spec array.", + "items": { + "$ref": "#/definitions/RestoreFileSpec", + "description": "Pre Restore restore file spec items array." + } + }, + "pauseWaitForSyncDrainTimePeriodInSeconds": { + "type": "integer", + "description": "Pre Restore pause wait for sync drain time period in seconds." + } + } + }, + "BackupRequest": { + "type": "object", + "description": "Backup request", + "properties": { + "azureFileShare": { + "type": "string", + "description": "Azure File Share." + } + } + }, + "PostBackupResponse": { + "type": "object", + "description": "Post Backup Response", + "properties": { + "backupMetadata": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PostBackupResponseProperties", + "description": "Post Backup Response Properties" + } + } + }, + "RestoreFileSpec": { + "type": "object", + "description": "Restore file spec.", + "properties": { + "path": { + "type": "string", + "description": "Restore file spec path" + }, + "isdir": { + "type": "boolean", + "description": "Restore file spec isdir" + } + } + }, + "StorageSyncServiceArray": { + "type": "object", + "description": "Array of StorageSyncServices", + "properties": { + "value": { + "type": "array", + "description": "Collection of StorageSyncServices.", + "items": { + "$ref": "#/definitions/StorageSyncService" + } + } + } + }, + "SyncGroupArray": { + "type": "object", + "description": "Array of SyncGroup", + "properties": { + "value": { + "type": "array", + "description": "Collection of SyncGroup.", + "items": { + "$ref": "#/definitions/SyncGroup" + } + } + } + }, + "CloudEndpointArray": { + "type": "object", + "description": "Array of CloudEndpoint", + "properties": { + "value": { + "type": "array", + "description": "Collection of CloudEndpoint.", + "items": { + "$ref": "#/definitions/CloudEndpoint" + } + } + } + }, + "ServerEndpointArray": { + "description": "Array of ServerEndpoint", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Collection of ServerEndpoint.", + "items": { + "$ref": "#/definitions/ServerEndpoint" + } + } + } + }, + "RegisteredServerArray": { + "description": "Array of RegisteredServer", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Collection of Registered Server.", + "items": { + "$ref": "#/definitions/RegisteredServer" + } + } + } + }, + "WorkflowArray": { + "description": "Array of Workflow", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Collection of workflow items.", + "items": { + "$ref": "#/definitions/Workflow" + } + } + } + }, + "SubscriptionStateProperties": { + "type": "object", + "description": "Subscription State properties." + }, + "PostBackupResponseProperties": { + "type": "object", + "description": "Post Backup Response Properties object.", + "properties": { + "cloudEndpointName": { + "type": "string", + "description": "cloud endpoint Name.", + "readOnly": true + } + } + }, + "StorageSyncServiceUpdateParameters": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The user-specified tags associated with the storage sync service." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageSyncServiceUpdateProperties", + "description": "The properties of the server endpoint." + } + }, + "description": "Parameters for updating an Storage sync service." + }, + "StorageSyncServiceUpdateProperties": { + "type": "object", + "description": "StorageSyncService Properties object.", + "properties": { + "incomingTrafficPolicy": { + "$ref": "#/definitions/IncomingTrafficPolicy", + "description": "Incoming Traffic Policy" + } + } + }, + "StorageSyncServiceProperties": { + "type": "object", + "description": "Storage Sync Service Properties object.", + "properties": { + "incomingTrafficPolicy": { + "$ref": "#/definitions/IncomingTrafficPolicy", + "description": "Incoming Traffic Policy" + }, + "storageSyncServiceStatus": { + "type": "integer", + "description": "Storage Sync service status.", + "readOnly": true + }, + "storageSyncServiceUid": { + "type": "string", + "description": "Storage Sync service Uid", + "readOnly": true + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "StorageSyncService Provisioning State" + }, + "lastWorkflowId": { + "readOnly": true, + "type": "string", + "description": "StorageSyncService lastWorkflowId" + }, + "lastOperationName": { + "readOnly": true, + "type": "string", + "description": "Resource Last Operation Name" + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "List of private endpoint connection associated with the specified storage sync service" + } + } + }, + "WorkflowProperties": { + "type": "object", + "description": "Workflow Properties object.", + "properties": { + "lastStepName": { + "type": "string", + "description": "last step name" + }, + "status": { + "$ref": "#/definitions/WorkflowStatus", + "description": "workflow status." + }, + "operation": { + "$ref": "#/definitions/OperationDirection", + "description": "operation direction." + }, + "steps": { + "type": "string", + "description": "workflow steps" + }, + "lastOperationId": { + "type": "string", + "description": "workflow last operation identifier." + } + } + }, + "SyncGroupProperties": { + "type": "object", + "description": "SyncGroup Properties object.", + "properties": { + "uniqueId": { + "type": "string", + "description": "Unique Id", + "readOnly": true + }, + "syncGroupStatus": { + "type": "string", + "description": "Sync group status", + "readOnly": true + } + } + }, + "RegisteredServerProperties": { + "type": "object", + "description": "RegisteredServer Properties object.", + "properties": { + "serverCertificate": { + "type": "string", + "description": "Registered Server Certificate" + }, + "agentVersion": { + "type": "string", + "description": "Registered Server Agent Version" + }, + "serverOSVersion": { + "type": "string", + "description": "Registered Server OS Version" + }, + "serverManagementErrorCode": { + "type": "integer", + "description": "Registered Server Management Error Code" + }, + "lastHeartBeat": { + "type": "string", + "description": "Registered Server last heart beat" + }, + "provisioningState": { + "type": "string", + "description": "Registered Server Provisioning State" + }, + "serverRole": { + "type": "string", + "description": "Registered Server serverRole" + }, + "clusterId": { + "type": "string", + "description": "Registered Server clusterId" + }, + "clusterName": { + "type": "string", + "description": "Registered Server clusterName" + }, + "serverId": { + "type": "string", + "description": "Registered Server serverId" + }, + "storageSyncServiceUid": { + "type": "string", + "description": "Registered Server storageSyncServiceUid" + }, + "lastWorkflowId": { + "type": "string", + "description": "Registered Server lastWorkflowId" + }, + "lastOperationName": { + "type": "string", + "description": "Resource Last Operation Name" + }, + "discoveryEndpointUri": { + "type": "string", + "description": "Resource discoveryEndpointUri" + }, + "resourceLocation": { + "type": "string", + "description": "Resource Location" + }, + "serviceLocation": { + "type": "string", + "description": "Service Location" + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + }, + "managementEndpointUri": { + "type": "string", + "description": "Management Endpoint Uri" + }, + "monitoringEndpointUri": { + "type": "string", + "description": "Telemetry Endpoint Uri" + }, + "monitoringConfiguration": { + "type": "string", + "description": "Monitoring Configuration" + } + } + }, + "CloudEndpointProperties": { + "type": "object", + "description": "CloudEndpoint Properties object.", + "properties": { + "storageAccountResourceId": { + "type": "string", + "description": "Storage Account Resource Id" + }, + "azureFileShareName": { + "type": "string", + "description": "Azure file share name" + }, + "storageAccountTenantId": { + "type": "string", + "description": "Storage Account Tenant Id" + }, + "partnershipId": { + "type": "string", + "description": "Partnership Id" + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + }, + "backupEnabled": { + "type": "string", + "description": "Backup Enabled", + "readOnly": true + }, + "provisioningState": { + "type": "string", + "description": "CloudEndpoint Provisioning State" + }, + "lastWorkflowId": { + "type": "string", + "description": "CloudEndpoint lastWorkflowId" + }, + "lastOperationName": { + "type": "string", + "description": "Resource Last Operation Name" + } + } + }, + "ServerEndpointUpdateProperties": { + "type": "object", + "description": "ServerEndpoint Update Properties object.", + "properties": { + "cloudTiering": { + "$ref": "#/definitions/FeatureStatus", + "description": "Cloud Tiering." + }, + "volumeFreeSpacePercent": { + "type": "integer", + "minimum": 0, + "maximum": 100, + "description": "Level of free space to be maintained by Cloud Tiering if it is enabled." + }, + "tierFilesOlderThanDays": { + "type": "integer", + "minimum": 0, + "maximum": 2147483647, + "description": "Tier files older than days." + }, + "offlineDataTransfer": { + "$ref": "#/definitions/FeatureStatus", + "description": "Offline data transfer" + }, + "offlineDataTransferShareName": { + "type": "string", + "description": "Offline data transfer share name" + }, + "localCacheMode": { + "$ref": "#/definitions/LocalCacheMode", + "description": "Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access." + } + } + }, + "ServerEndpointProperties": { + "type": "object", + "description": "ServerEndpoint Properties object.", + "properties": { + "serverLocalPath": { + "$ref": "#/definitions/PhysicalPath", + "description": "Server Local path." + }, + "cloudTiering": { + "$ref": "#/definitions/FeatureStatus", + "description": "Cloud Tiering." + }, + "volumeFreeSpacePercent": { + "type": "integer", + "minimum": 0, + "maximum": 100, + "description": "Level of free space to be maintained by Cloud Tiering if it is enabled." + }, + "tierFilesOlderThanDays": { + "type": "integer", + "minimum": 0, + "maximum": 2147483647, + "description": "Tier files older than days." + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + }, + "serverResourceId": { + "$ref": "#/definitions/ResourceId", + "description": "Server Resource Id." + }, + "provisioningState": { + "type": "string", + "description": "ServerEndpoint Provisioning State", + "readOnly": true + }, + "lastWorkflowId": { + "type": "string", + "description": "ServerEndpoint lastWorkflowId", + "readOnly": true + }, + "lastOperationName": { + "type": "string", + "description": "Resource Last Operation Name", + "readOnly": true + }, + "syncStatus": { + "type": "object", + "$ref": "#/definitions/ServerEndpointSyncStatus", + "description": "Server Endpoint sync status", + "readOnly": true + }, + "offlineDataTransfer": { + "$ref": "#/definitions/FeatureStatus", + "description": "Offline data transfer" + }, + "offlineDataTransferStorageAccountResourceId": { + "type": "string", + "description": "Offline data transfer storage account resource ID", + "readOnly": true + }, + "offlineDataTransferStorageAccountTenantId": { + "type": "string", + "description": "Offline data transfer storage account tenant ID", + "readOnly": true + }, + "offlineDataTransferShareName": { + "type": "string", + "description": "Offline data transfer share name" + }, + "cloudTieringStatus": { + "type": "object", + "$ref": "#/definitions/ServerEndpointCloudTieringStatus", + "description": "Cloud tiering status. Only populated if cloud tiering is enabled.", + "readOnly": true + }, + "recallStatus": { + "type": "object", + "$ref": "#/definitions/ServerEndpointRecallStatus", + "description": "Recall status. Only populated if cloud tiering is enabled.", + "readOnly": true + }, + "initialDownloadPolicy": { + "$ref": "#/definitions/InitialDownloadPolicy", + "description": "Policy for how namespace and files are recalled during FastDr." + }, + "localCacheMode": { + "$ref": "#/definitions/LocalCacheMode", + "description": "Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access." + } + } + }, + "ServerEndpointSyncStatus": { + "type": "object", + "description": "Server Endpoint sync status", + "properties": { + "downloadHealth": { + "$ref": "#/definitions/ServerEndpointSyncHealthState", + "description": "Download Health Status.", + "readOnly": true + }, + "uploadHealth": { + "$ref": "#/definitions/ServerEndpointSyncHealthState", + "description": "Upload Health Status.", + "readOnly": true + }, + "combinedHealth": { + "$ref": "#/definitions/ServerEndpointSyncHealthState", + "description": "Combined Health Status.", + "readOnly": true + }, + "syncActivity": { + "$ref": "#/definitions/ServerEndpointSyncActivityState", + "description": "Sync activity", + "readOnly": true + }, + "totalPersistentFilesNotSyncingCount": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Total count of persistent files not syncing (combined upload + download).", + "readOnly": true + }, + "lastUpdatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last Updated Timestamp", + "readOnly": true + }, + "uploadStatus": { + "$ref": "#/definitions/ServerEndpointSyncSessionStatus", + "description": "Upload Status", + "readOnly": true + }, + "downloadStatus": { + "$ref": "#/definitions/ServerEndpointSyncSessionStatus", + "description": "Download Status", + "readOnly": true + }, + "uploadActivity": { + "$ref": "#/definitions/ServerEndpointSyncActivityStatus", + "description": "Upload sync activity", + "readOnly": true + }, + "downloadActivity": { + "$ref": "#/definitions/ServerEndpointSyncActivityStatus", + "description": "Download sync activity", + "readOnly": true + }, + "offlineDataTransferStatus": { + "$ref": "#/definitions/ServerEndpointOfflineDataTransferState", + "description": "Offline Data Transfer State", + "readOnly": true + } + } + }, + "ServerEndpointSyncSessionStatus": { + "type": "object", + "description": "Sync Session status object.", + "properties": { + "lastSyncResult": { + "type": "integer", + "format": "int32", + "description": "Last sync result (HResult)", + "readOnly": true + }, + "lastSyncTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last sync timestamp", + "readOnly": true + }, + "lastSyncSuccessTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last sync success timestamp", + "readOnly": true + }, + "lastSyncPerItemErrorCount": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Last sync per item error count.", + "readOnly": true + }, + "persistentFilesNotSyncingCount": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Count of persistent files not syncing.", + "readOnly": true + }, + "transientFilesNotSyncingCount": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Count of transient files not syncing.", + "readOnly": true + }, + "filesNotSyncingErrors": { + "type": "array", + "items": { + "$ref": "#/definitions/ServerEndpointFilesNotSyncingError" + }, + "description": "Array of per-item errors coming from the last sync session.", + "readOnly": true + } + } + }, + "ServerEndpointSyncActivityStatus": { + "type": "object", + "description": "Sync Session status object.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "Timestamp when properties were updated", + "readOnly": true + }, + "perItemErrorCount": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Per item error count", + "readOnly": true + }, + "appliedItemCount": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Applied item count.", + "readOnly": true + }, + "totalItemCount": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Total item count (if available)", + "readOnly": true + }, + "appliedBytes": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Applied bytes", + "readOnly": true + }, + "totalBytes": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Total bytes (if available)", + "readOnly": true + } + } + }, + "ServerEndpointFilesNotSyncingError": { + "type": "object", + "description": "Files not syncing error object", + "properties": { + "errorCode": { + "type": "integer", + "format": "int32", + "description": "Error code (HResult)", + "readOnly": true + }, + "persistentCount": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Count of persistent files not syncing with the specified error code", + "readOnly": true + }, + "transientCount": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Count of transient files not syncing with the specified error code", + "readOnly": true + } + } + }, + "PhysicalPath": { + "type": "string", + "description": "Server folder used for data synchronization" + }, + "ResourceId": { + "type": "string", + "description": "Arm resource identifier." + }, + "TagsObject": { + "type": "object", + "description": "Tags object." + }, + "FeatureStatus": { + "type": "string", + "description": "Type of the Feature Status", + "enum": [ + "on", + "off" + ], + "x-ms-enum": { + "name": "FeatureStatus", + "modelAsString": true + } + }, + "IncomingTrafficPolicy": { + "type": "string", + "description": "Type of the Incoming Traffic Policy", + "enum": [ + "AllowAllTraffic", + "AllowVirtualNetworksOnly" + ], + "x-ms-enum": { + "name": "IncomingTrafficPolicy", + "modelAsString": true + } + }, + "LocalCacheMode": { + "type": "string", + "description": "Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access.", + "enum": [ + "DownloadNewAndModifiedFiles", + "UpdateLocallyCachedFiles" + ], + "x-ms-enum": { + "name": "LocalCacheMode", + "modelAsString": true + } + }, + "InitialDownloadPolicy": { + "type": "string", + "description": "Policy for how namespace and files are recalled during FastDr", + "enum": [ + "NamespaceOnly", + "NamespaceThenModifiedFiles", + "AvoidTieredFiles" + ], + "x-ms-enum": { + "name": "InitialDownloadPolicy", + "modelAsString": true + } + }, + "ServerEndpointSyncHealthState": { + "type": "string", + "description": "Type of the sync health state", + "enum": [ + "Healthy", + "Error", + "SyncBlockedForRestore", + "SyncBlockedForChangeDetectionPostRestore", + "NoActivity" + ], + "x-ms-enum": { + "name": "ServerEndpointSyncHealthState", + "modelAsString": true + } + }, + "ServerEndpointSyncActivityState": { + "type": "string", + "description": "Type of the sync activity state", + "enum": [ + "Upload", + "Download", + "UploadAndDownload" + ], + "x-ms-enum": { + "name": "ServerEndpointSyncActivityState", + "modelAsString": true + } + }, + "ServerEndpointOfflineDataTransferState": { + "type": "string", + "description": "Type of the Health state", + "enum": [ + "InProgress", + "Stopping", + "NotRunning", + "Complete" + ], + "x-ms-enum": { + "name": "ServerEndpointOfflineDataTransferState", + "modelAsString": true + } + }, + "WorkflowStatus": { + "type": "string", + "description": "Type of the Workflow Status", + "enum": [ + "active", + "expired", + "succeeded", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "WorkflowStatus", + "modelAsString": true + } + }, + "OperationDirection": { + "type": "string", + "description": "Type of the Operation Direction", + "enum": [ + "do", + "undo", + "cancel" + ], + "x-ms-enum": { + "name": "OperationDirection", + "modelAsString": true + } + }, + "ProgressType": { + "type": "string", + "description": "Type of the ProgressType", + "enum": [ + "none", + "initialize", + "download", + "upload", + "recall" + ], + "x-ms-enum": { + "name": "ProgressType", + "modelAsString": true + } + }, + "OperationStatus": { + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation Id" + }, + "status": { + "readOnly": true, + "type": "string", + "description": "Operation status" + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Start time of the operation" + }, + "endTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "End time of the operation" + }, + "error": { + "readOnly": true, + "$ref": "#/definitions/StorageSyncApiError", + "description": "Error details." + } + }, + "description": "Operation status object" + }, + "ServerEndpointCloudTieringStatus": { + "type": "object", + "description": "Server endpoint cloud tiering status object.", + "properties": { + "lastUpdatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last updated timestamp", + "readOnly": true + }, + "health": { + "$ref": "#/definitions/ServerEndpointCloudTieringHealthState", + "description": "Cloud tiering health state.", + "readOnly": true + }, + "healthLastUpdatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "The last updated timestamp of health state", + "readOnly": true + }, + "lastCloudTieringResult": { + "type": "integer", + "format": "int32", + "description": "Last cloud tiering result (HResult)", + "readOnly": true + }, + "lastSuccessTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last cloud tiering success timestamp", + "readOnly": true + }, + "spaceSavings": { + "$ref": "#/definitions/CloudTieringSpaceSavings", + "description": "Information regarding how much local space cloud tiering is saving.", + "readOnly": true + }, + "cachePerformance": { + "$ref": "#/definitions/CloudTieringCachePerformance", + "description": "Information regarding how well the local cache on the server is performing.", + "readOnly": true + }, + "filesNotTiering": { + "$ref": "#/definitions/CloudTieringFilesNotTiering", + "description": "Information regarding files that failed to be tiered", + "readOnly": true + }, + "volumeFreeSpacePolicyStatus": { + "$ref": "#/definitions/CloudTieringVolumeFreeSpacePolicyStatus", + "description": "Status of the volume free space policy", + "readOnly": true + }, + "datePolicyStatus": { + "$ref": "#/definitions/CloudTieringDatePolicyStatus", + "description": "Status of the date policy", + "readOnly": true + } + } + }, + "ServerEndpointCloudTieringHealthState": { + "type": "string", + "description": "Type of the cloud tiering health state", + "enum": [ + "Healthy", + "Error" + ], + "x-ms-enum": { + "name": "ServerEndpointCloudTieringHealthState", + "modelAsString": true + } + }, + "CloudTieringSpaceSavings": { + "type": "object", + "description": "Server endpoint cloud tiering status object.", + "properties": { + "lastUpdatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last updated timestamp", + "readOnly": true + }, + "volumeSizeBytes": { + "type": "integer", + "format": "int64", + "description": "Volume size", + "readOnly": true, + "minimum": 0 + }, + "totalSizeCloudBytes": { + "type": "integer", + "format": "int64", + "description": "Total size of content in the azure file share", + "readOnly": true, + "minimum": 0 + }, + "cachedSizeBytes": { + "type": "integer", + "format": "int64", + "description": "Cached content size on the server", + "readOnly": true, + "minimum": 0 + }, + "spaceSavingsPercent": { + "type": "integer", + "format": "int32", + "description": "Percentage of cached size over total size", + "readOnly": true, + "minimum": 0, + "maximum": 100 + }, + "spaceSavingsBytes": { + "type": "integer", + "format": "int64", + "description": "Count of bytes saved on the server", + "readOnly": true, + "minimum": 0 + } + } + }, + "CloudTieringCachePerformance": { + "type": "object", + "description": "Server endpoint cloud tiering status object.", + "properties": { + "lastUpdatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last updated timestamp", + "readOnly": true + }, + "cacheHitBytes": { + "type": "integer", + "format": "int64", + "description": "Count of bytes that were served from the local server", + "readOnly": true, + "minimum": 0 + }, + "cacheMissBytes": { + "type": "integer", + "format": "int64", + "description": "Count of bytes that were served from the cloud", + "readOnly": true, + "minimum": 0 + }, + "cacheHitBytesPercent": { + "type": "integer", + "format": "int32", + "description": "Percentage of total bytes (hit + miss) that were served from the local server", + "readOnly": true, + "minimum": 0, + "maximum": 100 + } + } + }, + "CloudTieringFilesNotTiering": { + "type": "object", + "description": "Server endpoint cloud tiering status object.", + "properties": { + "lastUpdatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last updated timestamp", + "readOnly": true + }, + "totalFileCount": { + "type": "integer", + "format": "int64", + "description": "Last cloud tiering result (HResult)", + "readOnly": true, + "minimum": 0 + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/FilesNotTieringError" + }, + "description": "Array of tiering errors", + "readOnly": true + } + } + }, + "FilesNotTieringError": { + "type": "object", + "description": "Files not tiering error object", + "properties": { + "errorCode": { + "type": "integer", + "format": "int32", + "description": "Error code (HResult)", + "readOnly": true + }, + "fileCount": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Count of files with this error", + "readOnly": true + } + } + }, + "CloudTieringVolumeFreeSpacePolicyStatus": { + "type": "object", + "description": "Status of the volume free space policy", + "properties": { + "lastUpdatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last updated timestamp", + "readOnly": true + }, + "effectiveVolumeFreeSpacePolicy": { + "type": "integer", + "format": "int32", + "description": "In the case where multiple server endpoints are present in a volume, an effective free space policy is applied.", + "readOnly": true, + "minimum": 0, + "maximum": 100 + }, + "currentVolumeFreeSpacePercent": { + "type": "integer", + "format": "int32", + "description": "Current volume free space percentage.", + "readOnly": true, + "minimum": 0, + "maximum": 100 + } + } + }, + "CloudTieringDatePolicyStatus": { + "type": "object", + "description": "Status of the date policy", + "properties": { + "lastUpdatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last updated timestamp", + "readOnly": true + }, + "tieredFilesMostRecentAccessTimestamp": { + "type": "string", + "format": "date-time", + "description": "Most recent access time of tiered files", + "readOnly": true + } + } + }, + "ServerEndpointRecallStatus": { + "type": "object", + "description": "Server endpoint recall status object.", + "properties": { + "lastUpdatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last updated timestamp", + "readOnly": true + }, + "totalRecallErrorsCount": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Total count of recall errors.", + "readOnly": true + }, + "recallErrors": { + "type": "array", + "items": { + "$ref": "#/definitions/ServerEndpointRecallError" + }, + "description": "Array of recall errors", + "readOnly": true + } + } + }, + "ServerEndpointRecallError": { + "type": "object", + "description": "Server endpoint recall error object", + "properties": { + "errorCode": { + "type": "integer", + "format": "int32", + "description": "Error code (HResult)", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int64", + "minimum": 0, + "description": "Count of occurences of the error", + "readOnly": true + } + } + } + }, + "parameters": { + "StorageSyncServiceNameParameter": { + "name": "storageSyncServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage sync service name within the specified resource group.", + "x-ms-parameter-location": "method" + } + }, + "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" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/storagesync/resource-manager/readme.md b/specification/storagesync/resource-manager/readme.md index efb6bc8c2b57..c1e76d40a214 100644 --- a/specification/storagesync/resource-manager/readme.md +++ b/specification/storagesync/resource-manager/readme.md @@ -26,18 +26,27 @@ These are the global settings for the Storage Sync API. ``` yaml openapi-type: arm -tag: package-2020-03-01 +tag: package-preview-2020-09-01 ``` +### Tag: package-preview-2020-09-01 + +These settings apply only when `--tag=package-preview-2020-09-01` is specified on the command line. + +```yaml $(tag) == 'package-preview-2020-09-01' +input-file: + - Microsoft.StorageSync/preview/2020-09-01/storagesync.json +``` ### Tag: package-2020-03-01 These settings apply only when `--tag=package-2020-03-01` is specified on the command line. -```yaml $(tag) == 'package-2020-03-01' +``` yaml $(tag) == 'package-2020-03-01' input-file: - Microsoft.StorageSync/stable/2020-03-01/storagesync.json ``` + ### Tag: package-2019-10-01 These settings apply only when `--tag=package-2019-10-01` is specified on the command line. From 8ae5a8bc9721e6885c277b8d1ee2db1d9be6f4dc Mon Sep 17 00:00:00 2001 From: Landon Smith Date: Tue, 29 Sep 2020 00:26:30 -0700 Subject: [PATCH 156/164] Fix CDN matchValues and selector fields to be optional (#10950) --- .../Microsoft.Cdn/stable/2019-04-15/cdn.json | 17 ----------------- .../Microsoft.Cdn/stable/2019-06-15/cdn.json | 17 ----------------- .../Microsoft.Cdn/stable/2019-12-31/cdn.json | 17 ----------------- .../Microsoft.Cdn/stable/2020-03-31/cdn.json | 17 ----------------- .../Microsoft.Cdn/stable/2020-04-15/cdn.json | 17 ----------------- 5 files changed, 85 deletions(-) diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-04-15/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-04-15/cdn.json index e3ccabfbb2ca..0f457026f106 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-04-15/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-04-15/cdn.json @@ -2557,7 +2557,6 @@ "description": "Defines the parameters for RemoteAddress match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -2604,7 +2603,6 @@ "description": "Defines the parameters for RequestMethod match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -2651,7 +2649,6 @@ "description": "Defines the parameters for QueryString match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -2704,8 +2701,6 @@ "description": "Defines the parameters for PostArgs match conditions", "required": [ "operator", - "matchValues", - "selector", "@odata.type" ], "properties": { @@ -2762,7 +2757,6 @@ "description": "Defines the parameters for RequestUri match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -2815,8 +2809,6 @@ "description": "Defines the parameters for RequestHeader match conditions", "required": [ "operator", - "matchValues", - "selector", "@odata.type" ], "properties": { @@ -2873,7 +2865,6 @@ "description": "Defines the parameters for RequestBody match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -2926,7 +2917,6 @@ "description": "Defines the parameters for RequestScheme match conditions ", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -2964,7 +2954,6 @@ "description": "Defines the parameters for UrlPath match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3018,7 +3007,6 @@ "description": "Defines the parameters for UrlFileExtension match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3071,7 +3059,6 @@ "description": "Defines the parameters for UrlFilename match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3124,7 +3111,6 @@ "description": "Defines the parameters for HttpVersion match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3162,8 +3148,6 @@ "description": "Defines the parameters for Cookies match conditions", "required": [ "operator", - "matchValues", - "selector", "@odata.type" ], "properties": { @@ -3220,7 +3204,6 @@ "description": "Defines the parameters for IsDevice match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-06-15/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-06-15/cdn.json index e2b319a2e9d7..ce3c308a19ca 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-06-15/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-06-15/cdn.json @@ -2567,7 +2567,6 @@ "description": "Defines the parameters for RemoteAddress match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -2614,7 +2613,6 @@ "description": "Defines the parameters for RequestMethod match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -2661,7 +2659,6 @@ "description": "Defines the parameters for QueryString match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -2714,8 +2711,6 @@ "description": "Defines the parameters for PostArgs match conditions", "required": [ "operator", - "matchValues", - "selector", "@odata.type" ], "properties": { @@ -2772,7 +2767,6 @@ "description": "Defines the parameters for RequestUri match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -2825,8 +2819,6 @@ "description": "Defines the parameters for RequestHeader match conditions", "required": [ "operator", - "matchValues", - "selector", "@odata.type" ], "properties": { @@ -2883,7 +2875,6 @@ "description": "Defines the parameters for RequestBody match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -2936,7 +2927,6 @@ "description": "Defines the parameters for RequestScheme match conditions ", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -2974,7 +2964,6 @@ "description": "Defines the parameters for UrlPath match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3028,7 +3017,6 @@ "description": "Defines the parameters for UrlFileExtension match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3081,7 +3069,6 @@ "description": "Defines the parameters for UrlFilename match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3134,7 +3121,6 @@ "description": "Defines the parameters for HttpVersion match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3172,8 +3158,6 @@ "description": "Defines the parameters for Cookies match conditions", "required": [ "operator", - "matchValues", - "selector", "@odata.type" ], "properties": { @@ -3230,7 +3214,6 @@ "description": "Defines the parameters for IsDevice match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/cdn.json index 4282327a5c0a..47e1d60caf9a 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2019-12-31/cdn.json @@ -3037,7 +3037,6 @@ "description": "Defines the parameters for RemoteAddress match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3084,7 +3083,6 @@ "description": "Defines the parameters for RequestMethod match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3131,7 +3129,6 @@ "description": "Defines the parameters for QueryString match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3184,8 +3181,6 @@ "description": "Defines the parameters for PostArgs match conditions", "required": [ "operator", - "matchValues", - "selector", "@odata.type" ], "properties": { @@ -3242,7 +3237,6 @@ "description": "Defines the parameters for RequestUri match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3295,8 +3289,6 @@ "description": "Defines the parameters for RequestHeader match conditions", "required": [ "operator", - "matchValues", - "selector", "@odata.type" ], "properties": { @@ -3353,7 +3345,6 @@ "description": "Defines the parameters for RequestBody match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3406,7 +3397,6 @@ "description": "Defines the parameters for RequestScheme match conditions ", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3444,7 +3434,6 @@ "description": "Defines the parameters for UrlPath match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3498,7 +3487,6 @@ "description": "Defines the parameters for UrlFileExtension match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3551,7 +3539,6 @@ "description": "Defines the parameters for UrlFilename match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3604,7 +3591,6 @@ "description": "Defines the parameters for HttpVersion match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3642,8 +3628,6 @@ "description": "Defines the parameters for Cookies match conditions", "required": [ "operator", - "matchValues", - "selector", "@odata.type" ], "properties": { @@ -3700,7 +3684,6 @@ "description": "Defines the parameters for IsDevice match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdn.json index 40bda7fa0c28..45c077e9ec15 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdn.json @@ -3054,7 +3054,6 @@ "description": "Defines the parameters for RemoteAddress match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3101,7 +3100,6 @@ "description": "Defines the parameters for RequestMethod match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3148,7 +3146,6 @@ "description": "Defines the parameters for QueryString match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3201,8 +3198,6 @@ "description": "Defines the parameters for PostArgs match conditions", "required": [ "operator", - "matchValues", - "selector", "@odata.type" ], "properties": { @@ -3259,7 +3254,6 @@ "description": "Defines the parameters for RequestUri match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3312,8 +3306,6 @@ "description": "Defines the parameters for RequestHeader match conditions", "required": [ "operator", - "matchValues", - "selector", "@odata.type" ], "properties": { @@ -3370,7 +3362,6 @@ "description": "Defines the parameters for RequestBody match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3423,7 +3414,6 @@ "description": "Defines the parameters for RequestScheme match conditions ", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3461,7 +3451,6 @@ "description": "Defines the parameters for UrlPath match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3515,7 +3504,6 @@ "description": "Defines the parameters for UrlFileExtension match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3568,7 +3556,6 @@ "description": "Defines the parameters for UrlFilename match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3621,7 +3608,6 @@ "description": "Defines the parameters for HttpVersion match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3659,8 +3645,6 @@ "description": "Defines the parameters for Cookies match conditions", "required": [ "operator", - "matchValues", - "selector", "@odata.type" ], "properties": { @@ -3717,7 +3701,6 @@ "description": "Defines the parameters for IsDevice match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json index 2fcd9a9690c9..5276a6090bc1 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json @@ -3054,7 +3054,6 @@ "description": "Defines the parameters for RemoteAddress match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3101,7 +3100,6 @@ "description": "Defines the parameters for RequestMethod match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3148,7 +3146,6 @@ "description": "Defines the parameters for QueryString match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3201,8 +3198,6 @@ "description": "Defines the parameters for PostArgs match conditions", "required": [ "operator", - "matchValues", - "selector", "@odata.type" ], "properties": { @@ -3259,7 +3254,6 @@ "description": "Defines the parameters for RequestUri match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3312,8 +3306,6 @@ "description": "Defines the parameters for RequestHeader match conditions", "required": [ "operator", - "matchValues", - "selector", "@odata.type" ], "properties": { @@ -3370,7 +3362,6 @@ "description": "Defines the parameters for RequestBody match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3423,7 +3414,6 @@ "description": "Defines the parameters for RequestScheme match conditions ", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3461,7 +3451,6 @@ "description": "Defines the parameters for UrlPath match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3515,7 +3504,6 @@ "description": "Defines the parameters for UrlFileExtension match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3568,7 +3556,6 @@ "description": "Defines the parameters for UrlFilename match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3621,7 +3608,6 @@ "description": "Defines the parameters for HttpVersion match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { @@ -3659,8 +3645,6 @@ "description": "Defines the parameters for Cookies match conditions", "required": [ "operator", - "matchValues", - "selector", "@odata.type" ], "properties": { @@ -3717,7 +3701,6 @@ "description": "Defines the parameters for IsDevice match conditions", "required": [ "operator", - "matchValues", "@odata.type" ], "properties": { From f6b56faa8383bb639ccaa7896b2a20ef59e473bc Mon Sep 17 00:00:00 2001 From: ligengatms Date: Tue, 29 Sep 2020 16:04:59 +0800 Subject: [PATCH 157/164] add publicNetworkAccess property to datafactory (#10956) add publicNetworkAccess property to datafactory --- .../stable/2018-06-01/datafactory.json | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json index 43909b01832d..43f2f1614abd 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json @@ -4886,6 +4886,18 @@ "globalParameters": { "$ref": "#/definitions/GlobalParameterDefinitionSpecification", "description": "List of parameters for factory." + }, + "publicNetworkAccess": { + "description": "Whether or not public network access is allowed for the data factory.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } } } }, From c40cc1a3449fcbc902e793f3a34244d9620c3fe3 Mon Sep 17 00:00:00 2001 From: moranraz <59017169+moranraz@users.noreply.github.com> Date: Tue, 29 Sep 2020 12:13:59 +0300 Subject: [PATCH 158/164] added incident alerts and incident bookmarks APIs (#10806) * added incident alerts and incident bookmarks endpoints * changed definition order * style changes * remove labels * change operation ids * changing ids back Co-authored-by: Moran Raz Mizrahi --- .../2019-01-01-preview/SecurityInsights.json | 211 ++++++++++++++++++ .../incidents/GetAllIncidentAlerts.json | 51 +++++ .../incidents/GetAllIncidentBookmarks.json | 78 +++++++ 3 files changed, 340 insertions(+) create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/incidents/GetAllIncidentAlerts.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/incidents/GetAllIncidentBookmarks.json diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json index a70e71a83dc5..682ca4c40b17 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json @@ -2938,6 +2938,102 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/alerts": { + "post": { + "x-ms-examples": { + "Get all incident alerts.": { + "$ref": "./examples/incidents/GetAllIncidentAlerts.json" + } + }, + "tags": [ + "IncidentAlerts" + ], + "description": "Gets all incident alerts.", + "operationId": "Incidents_ListOfAlerts", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentAlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/bookmarks": { + "post": { + "x-ms-examples": { + "Get all incident bookmarks.": { + "$ref": "./examples/incidents/GetAllIncidentBookmarks.json" + } + }, + "tags": [ + "IncidentBookmarks" + ], + "description": "Gets all incident bookmarks.", + "operationId": "Incidents_ListOfBookmarks", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentBookmarkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments": { "get": { "x-ms-examples": { @@ -6687,6 +6783,91 @@ }, "type": "object" }, + "HuntingBookmark": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a Hunting bookmark entity.", + "properties": { + "properties": { + "$ref": "#/definitions/HuntingBookmarkProperties", + "description": "HuntingBookmark entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Bookmark" + }, + "HuntingBookmarkProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Describes bookmark properties", + "properties": { + "created": { + "description": "The time the bookmark was created", + "format": "date-time", + "type": "string" + }, + "createdBy": { + "$ref": "#/definitions/UserInfo", + "description": "Describes a user that created the bookmark", + "type": "object" + }, + "displayName": { + "description": "The display name of the bookmark", + "type": "string" + }, + "eventTime": { + "description": "The time of the event", + "format": "date-time", + "type": "string" + }, + "labels": { + "description": "List of labels relevant to this bookmark", + "items": { + "$ref": "#/definitions/Label" + }, + "type": "array" + }, + "notes": { + "description": "The notes of the bookmark", + "type": "string" + }, + "query": { + "description": "The query of the bookmark.", + "type": "string" + }, + "queryResult": { + "description": "The query result of the bookmark.", + "type": "string" + }, + "updated": { + "description": "The last time the bookmark was updated", + "format": "date-time", + "type": "string" + }, + "updatedBy": { + "$ref": "#/definitions/UserInfo", + "description": "Describes a user that updated the bookmark", + "type": "object" + }, + "incidentInfo": { + "$ref": "#/definitions/IncidentInfo", + "description": "Describes an incident that relates to bookmark", + "type": "object" + } + }, + "required": [ + "displayName", + "query" + ], + "type": "object" + }, "IncidentAdditionalData": { "description": "Incident additional data property bag.", "properties": { @@ -6725,6 +6906,36 @@ }, "type": "object" }, + "IncidentAlertList": { + "description": "List of incident alerts.", + "properties": { + "value": { + "description": "Array of incident alerts.", + "type": "array", + "items": { + "$ref": "#/definitions/SecurityAlert" + } + } + }, + "required": [ + "value" + ] + }, + "IncidentBookmarkList": { + "description": "List of incident bookmarks.", + "properties": { + "value": { + "description": "Array of incident bookmarks.", + "type": "array", + "items": { + "$ref": "#/definitions/HuntingBookmark" + } + } + }, + "required": [ + "value" + ] + }, "IncidentComment": { "allOf": [ { diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/incidents/GetAllIncidentAlerts.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/incidents/GetAllIncidentAlerts.json new file mode 100644 index 000000000000..4a543ecd8e07 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/incidents/GetAllIncidentAlerts.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRG/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Entities/baa8a239-6fde-4ab7-a093-d09f7b75c58c", + "name": "baa8a239-6fde-4ab7-a093-d09f7b75c58c", + "type": "Microsoft.SecurityInsights/Entities", + "kind": "SecurityAlert", + "properties": { + "systemAlertId": "baa8a239-6fde-4ab7-a093-d09f7b75c58c", + "tactics": [], + "alertDisplayName": "myAlert", + "confidenceLevel": "Unknown", + "severity": "Low", + "vendorName": "Microsoft", + "productName": "Azure Security Center", + "alertType": "myAlert", + "processingEndTime": "2020-07-20T18:21:53.6158361Z", + "status": "New", + "endTimeUtc": "2020-07-20T18:21:53.6158361Z", + "startTimeUtc": "2020-07-20T18:21:53.6158361Z", + "timeGenerated": "2020-07-20T18:21:53.6158361Z", + "resourceIdentifiers": [ + { + "type": "LogAnalytics", + "workspaceId": "c8c99641-985d-4e4e-8e91-fb3466cd0e5b", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroup": "myRG" + } + ], + "additionalData": { + "AlertMessageEnqueueTime": "2020-07-20T18:21:57.304Z" + }, + "friendlyName": "myAlert" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/incidents/GetAllIncidentBookmarks.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/incidents/GetAllIncidentBookmarks.json new file mode 100644 index 000000000000..711caaffaf16 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/incidents/GetAllIncidentBookmarks.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/afbd324f-6c48-459c-8710-8d1e1cd03812", + "name": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "type": "Microsoft.SecurityInsights/Entities", + "kind": "Bookmark", + "properties": { + "displayName": "SecurityEvent - 868f40f4698d", + "created": "2020-06-17T15:34:01.4265524+00:00", + "updated": "2020-06-17T15:34:01.4265524+00:00", + "createdBy": { + "objectId": "b03ca914-5eb6-45e5-9417-fe0797c372fd", + "email": "user@microsoft.com", + "name": "user" + }, + "updatedBy": { + "objectId": "b03ca914-5eb6-45e5-9417-fe0797c372fd", + "email": "user@microsoft.com", + "name": "user" + }, + "eventTime": "2020-06-17T15:34:01.4265524+00:00", + "labels": [], + "query": "SecurityEvent\r\n| take 1\n", + "queryResult": "{\"TimeGenerated\":\"2020-05-24T01:24:25.67Z\",\"Account\":\"\\\\ADMINISTRATOR\",\"AccountType\":\"User\",\"Computer\":\"SecurityEvents\",\"EventSourceName\":\"Microsoft-Windows-Security-Auditing\",\"Channel\":\"Security\",\"Task\":12544,\"Level\":\"16\",\"EventID\":4625,\"Activity\":\"4625 - An account failed to log on.\",\"AuthenticationPackageName\":\"NTLM\",\"FailureReason\":\"%%2313\",\"IpAddress\":\"176.113.115.73\",\"IpPort\":\"0\",\"LmPackageName\":\"-\",\"LogonProcessName\":\"NtLmSsp \",\"LogonType\":3,\"LogonTypeName\":\"3 - Network\",\"Process\":\"-\",\"ProcessId\":\"0x0\",\"__entityMapping\":{\"\\\\ADMINISTRATOR\":\"Account\",\"SecurityEvents\":\"Host\"}}", + "additionalData": { + "ETag": "\"3b00acab-0000-0d00-0000-5f15e4ed0000\"", + "EntityId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "friendlyName": "SecurityEvent - 868f40f4698d" + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/bbbd324f-6c48-459c-8710-8d1e1cd03812", + "name": "bbbd324f-6c48-459c-8710-8d1e1cd03812", + "type": "Microsoft.SecurityInsights/Entities", + "kind": "Bookmark", + "properties": { + "displayName": "SecurityEvent - 868f40f4698d", + "created": "2020-06-17T15:34:01.4265524+00:00", + "updated": "2020-06-17T15:34:01.4265524+00:00", + "createdBy": { + "objectId": "303ca914-5eb6-45e5-9417-fe0797c372fd", + "email": "user@microsoft.com", + "name": "user" + }, + "updatedBy": { + "objectId": "b03ca914-5eb6-45e5-9417-fe0797c372fd", + "email": "user@microsoft.com", + "name": "user" + }, + "eventTime": "2020-06-17T15:34:01.4265524+00:00", + "labels": [], + "query": "SecurityEvent\r\n| take 1\n", + "queryResult": "{\"TimeGenerated\":\"2020-05-24T01:24:25.67Z\",\"Account\":\"\\\\ADMINISTRATOR\",\"AccountType\":\"User\",\"Computer\":\"SecurityEvents\",\"EventSourceName\":\"Microsoft-Windows-Security-Auditing\",\"Channel\":\"Security\",\"Task\":12544,\"Level\":\"16\",\"EventID\":4625,\"Activity\":\"4625 - An account failed to log on.\",\"AuthenticationPackageName\":\"NTLM\",\"FailureReason\":\"%%2313\",\"IpAddress\":\"176.113.115.73\",\"IpPort\":\"0\",\"LmPackageName\":\"-\",\"LogonProcessName\":\"NtLmSsp \",\"LogonType\":3,\"LogonTypeName\":\"3 - Network\",\"Process\":\"-\",\"ProcessId\":\"0x0\",\"__entityMapping\":{\"\\\\ADMINISTRATOR\":\"Account\",\"SecurityEvents\":\"Host\"}}", + "additionalData": { + "ETag": "\"3b00acab-0000-0d00-0000-5f15e4ed0000\"", + "EntityId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "friendlyName": "SecurityEvent - 868f40f4698d" + } + } + ] + } + } + } +} From d6ef8ec98cb721be78c6b1a6a26d46287e2546ef Mon Sep 17 00:00:00 2001 From: Liran Chen <1437075+liranc@users.noreply.github.com> Date: Tue, 29 Sep 2020 12:19:15 +0300 Subject: [PATCH 159/164] Microsoft.Security/iotDefenderSettings (2020-08-06-preview) (#10810) * Added unmanaged devices quota * Specify format * rename field * Minimum 1000 * Add sentinelWorkspaceResourceIds Co-authored-by: Liran Chen Co-authored-by: Orel Kayam --- .../examples/IotDefenderSettings/Get.json | 7 +++- .../examples/IotDefenderSettings/List.json | 7 +++- .../examples/IotDefenderSettings/Put.json | 24 +++++++++++-- .../iotDefenderSettings.json | 36 +++++++++++++++++-- 4 files changed, 67 insertions(+), 7 deletions(-) diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Get.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Get.json index 838aa27b70fa..1a4dd8e4a4b5 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Get.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Get.json @@ -9,7 +9,12 @@ "name": "default", "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default", "type": "Microsoft.Security/iotDefenderSettings", - "properties": {} + "properties": { + "deviceQuota": 2000, + "sentinelWorkspaceResourceIds": [ + "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1" + ] + } } } } diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/List.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/List.json index 2cf5f5fee30d..7594b4d7cc01 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/List.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/List.json @@ -11,7 +11,12 @@ "name": "default", "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default", "type": "Microsoft.Security/iotDefenderSettings", - "properties": {} + "properties": { + "deviceQuota": 2000, + "sentinelWorkspaceResourceIds": [ + "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1" + ] + } } ] } diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Put.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Put.json index b4738db76a87..6eb347f06596 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Put.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/examples/IotDefenderSettings/Put.json @@ -1,7 +1,15 @@ { "parameters": { "api-version": "2020-08-06-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "iotDefenderSettingsModel": { + "properties": { + "deviceQuota": 2000, + "sentinelWorkspaceResourceIds": [ + "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1" + ] + } + } }, "responses": { "200": { @@ -9,7 +17,12 @@ "name": "default", "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default", "type": "Microsoft.Security/iotDefenderSettings", - "properties": {} + "properties": { + "deviceQuota": 2000, + "sentinelWorkspaceResourceIds": [ + "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1" + ] + } } }, "201": { @@ -17,7 +30,12 @@ "name": "default", "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Security/iotDefenderSettings/default", "type": "Microsoft.Security/iotDefenderSettings", - "properties": {} + "properties": { + "deviceQuota": 2000, + "sentinelWorkspaceResourceIds": [ + "/subscriptions/c4930e90-cd72-4aa5-93e9-2d081d129569/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace1" + ] + } } } } diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json index afdeadc4a050..8929c118bb08 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-08-06-preview/iotDefenderSettings.json @@ -122,6 +122,9 @@ }, { "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/IotDefenderSettingsModel" } ], "responses": { @@ -251,7 +254,25 @@ "IotDefenderSettingsProperties": { "type": "object", "description": "IoT Defender settings properties", - "properties": {} + "properties": { + "deviceQuota": { + "type": "integer", + "format": "int32", + "minimum": 1000, + "description": "Size of the device quota (as a opposed to a Pay as You Go billing model). Value is required to be in multiples of 1000." + }, + "sentinelWorkspaceResourceIds": { + "type": "array", + "description": "Sentinel Workspace Resource Ids", + "items": { + "type": "string" + } + } + }, + "required": [ + "deviceQuota", + "sentinelWorkspaceResourceIds" + ] }, "DownloadLink": { "type": "string", @@ -445,5 +466,16 @@ } } }, - "parameters": {} + "parameters": { + "IotDefenderSettingsModel": { + "name": "iotDefenderSettingsModel", + "in": "body", + "required": true, + "description": "The IoT defender settings model", + "schema": { + "$ref": "#/definitions/IotDefenderSettingsModel" + }, + "x-ms-parameter-location": "method" + } + } } From 5caf5527783bcefaf39c4b76754cc735bf51fae6 Mon Sep 17 00:00:00 2001 From: vikrampraveen Date: Tue, 29 Sep 2020 15:56:36 -0700 Subject: [PATCH 160/164] Make version int64 (#10984) Co-authored-by: Vikram Praveen Kumar --- .../stable/2018-01-01/AzureCommunicationServices.json | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json index 8d83d520a87a..1b59779ce818 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json @@ -238,7 +238,8 @@ }, "version": { "description": "The version of the thread", - "type": "integer" + "type": "integer", + "format": "int64" } } }, @@ -273,7 +274,8 @@ }, "version": { "description": "The version of the message", - "type": "integer" + "type": "integer", + "format": "int64" } } }, From 44ec11c74634f1afa5bbe0d3f2678b7f819ebf8e Mon Sep 17 00:00:00 2001 From: Artyom Pavlichenko Date: Tue, 29 Sep 2020 19:52:54 -0700 Subject: [PATCH 161/164] [Hub Generated] Review request for Microsoft.DataMigration to add version preview/2018-07-15-preview (#10494) * Adding table map params * Changing the map to selected tables for now * Adding prettier changes Co-authored-by: Artyom Pavlichenko --- .../MigrateMySqlAzureDbForMySqlSyncTask.json | 7 +++++++ ...ePostgreSqlAzureDbForPostgreSqlSyncTask.json | 17 +++++++++++++++++ 2 files changed, 24 insertions(+) diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateMySqlAzureDbForMySqlSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateMySqlAzureDbForMySqlSyncTask.json index fe9b45ba782e..177f0d78f18e 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateMySqlAzureDbForMySqlSyncTask.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateMySqlAzureDbForMySqlSyncTask.json @@ -356,6 +356,13 @@ "additionalProperties": { "type": "string" } + }, + "tableMap": { + "type": "object", + "description": "Mapping of source to target tables", + "additionalProperties": { + "type": "string" + } } } } diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json index 1d7ffee88df1..3ed8bce5713a 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json @@ -374,6 +374,23 @@ "additionalProperties": { "type": "string" } + }, + "selectedTables": { + "type": "array", + "description": "Tables selected for migration", + "items": { + "$ref": "#/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput" + } + } + } + }, + "MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInput": { + "type": "object", + "description": "Selected tables for the migration", + "properties": { + "name": { + "type": "string", + "description": "Name of the table to migrate" } } } From 301b21cd32c7c8a2a591344ec5e357945a902bea Mon Sep 17 00:00:00 2001 From: Phoenix He Date: Wed, 30 Sep 2020 12:10:21 +0800 Subject: [PATCH 162/164] Add sdk_customization.md (#10861) * Add sdk_customization.md * Update doc with detail steps * Add packageName in generateOutput * Use propertyNames * Fix logPrefix * Update: add dryRun to collect info, fix typo --- .../sdkautomation/sdk_customization.md | 801 ++++++++++++++++++ 1 file changed, 801 insertions(+) create mode 100644 documentation/sdkautomation/sdk_customization.md diff --git a/documentation/sdkautomation/sdk_customization.md b/documentation/sdkautomation/sdk_customization.md new file mode 100644 index 000000000000..de083379fcf2 --- /dev/null +++ b/documentation/sdkautomation/sdk_customization.md @@ -0,0 +1,801 @@ +# SDK Automation Customization + +This is the specification of the new SDK Automation customization configuration. +Old customization that hardcoded in sdk automation will still work but this new +approach is preferred. + +## SDK Automation workflow + +### Opened PR Validation Trigger + +SDK Automation is launched with matrix in azure pipeline. For each language configured: + +1. Get the PR merge commit and clone the spec repo on the merge commit. + +2. Get the PR changed file list. For each changed file, find the nearest readme.md in parent folder. Get list of related readme.md. + +3. Filter the list of readme.md with: find the `swagger-to-sdk` section in the readme.md, and see if the specified language is configured for that readme.md. Example of `swagger-to-sdk` in SDK Automation: +``` +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js +``` +``` +If the configured language is not found here, generation for this readme.md will be skipped. + +4. Get `specificationRepositoryConfiguration.json` from spec repo default branch. See [SpecRepoConfig](#specrepoconfig). Get the repo and branch config in the file. + +5. Clone __mainRepository__ and checkout __mainBranch__. If __secondaryRepository__ is specified then checkout __secondaryRepository__ and __secondaryBranch__ instead. + +6. Get `swagger_to_sdk_config.json` from cloned SDK repository. The config file path could be customized by __configFilePath__ in spec config. For the definition of the config see [SwaggerToSdkConfig](#swaggertosdkconfig). + +7. Launch __initScript__ defined in [SwaggerToSdkConfig](#swaggertosdkconfig). All the script's working directory is root folder of cloned SDK repository. + +8. Calculate __PR diff__ and related `readme.md`. If __generationCallMode__ is __one-for-all-configs__ then run ___one pass for the rest steps___, else (__one-per-configs__) ___loop the rest steps___ with each `readme.md`. + +9. Launch __generateScript__ defined in [SwaggerToSdkConfig](#swaggertosdkconfig) with [generateInput.json](#generateinput). The script should produce [generateOutput.json](#generateoutput) if __parseGenerateOutput__ is true. If dryRun is set to true then first run of __generateScript__ will be used to collect package information , then loop each package info and checkout package related branch and launch __generateScript__ with package related readmeMd and dryRun set to false. + +10. Get generated package. If __packageFolderFromFileSearch__ is defined with file search then package folder is detected based on git diff in SDK repository and algorithm described in [SwaggerToSdkConfig Schema](#swaggertosdkconfig-schema). Else package folder is from [generateOutput.json](#generateoutput). For each package ___loop the rest steps___. + +11. Launch __buildScript__ to build the package. Collect the artifacts by config __artifactPathFromFileSearch__. This step could be skipped if it's not defined in [SwaggerToSdkConfig](#swaggertosdkconfig) and it's covered by __generateScript__ and the result could be found in [generateOutput.json](#generateoutput). + +12. Upload all the package related artifacts to Azure Storage Blob Container. All the artifact for one package is uploaded in one folder. These file could be downloaded on URL prefixed by __downloadUrlPrefix__ defined in [InstallInstructionScriptInput](#installinstructionscriptinput). It's redirected by openapiHub by design, and for SDK Automation on public repo the redirect don't need auth, but for SDK Automation in private repo it requires microsoft AAD auth. User could authenticate and download via web page oauth in browser or bearer token auth with `az rest --resource` in command line. + +13. Launch __changelogScript__ to get changelog and detect breaking change. This step could be skipped if changelog and breaking change could be found in [generateOutput.json](#generateoutput). If breaking change is found, the spec PR will be labelled with `CI-BreakingChange-`. + +14. Launch __installInstructionScript__ to get install instruction for that package. This step could be skipped if install instruction could be found in [generateOutput.json](#generateoutput). The lite install instruction will be shown in spec PR comment, the full install instruction will be shown in generated SDK PR. + +15. Commit the package related code in SDK repository. Force push to [GenerationBranch](#generationbranch) in __integrationRepository__. Create or update [GenerationPR](#generationpr) from [GenerationBranch](#generationbranch) to [MainBranch](#mainbranch) in __integrationRepository__. If __integrationRepository__ is a fork of __mainRepository__, its [MainBranch](#mainbranch) should be synced once a day. + +### Continuous Integration (PR Merged) Trigger + +Almost the same as opened PR trigger, with different on step 15: + +15. Commit the package related code in SDK repository. Close [GenerationPR](#generationpr) and delete [GenerationBranch](#generationbranch). Force push to [IntegrationBranch](#integrationbranch) in __integrationRepository__. Create or update [IntegrationPR](#integrationpr) from [IntegrationBranch](#integrationbranch) to [MainBranch](#mainbranch) in __mainRepository__. Close the [integrationPR](#integrationPR) if __closeIntegrationPR__ in [SwaggerToSdkConfig](#swaggertosdkconfig) is set to true. + + +## Definitions + +### SpecRepoConfig +This is type of file `./specificationRepositoryConfiguration.json` in swagger spec repo. + +#### SpecRepoConfig Example +```json +{ + "sdkRepositoryMappings": { + "azure-sdk-for-js": { + "integrationRepository": "AzureSDKAutomation/azure-sdk-for-js", + "mainRepository": "Azure/azure-sdk-for-js" + }, + "azure-sdk-for-python": { + "integrationRepository": "AzureSDKAutomation/azure-sdk-for-python", + "mainRepository": "Azure/azure-sdk-for-python", + "mainBranch": "release/v3" + }, + "azure-sdk-for-python-track2": { + "integrationRepository": "AzureSDKAutomation/azure-sdk-for-python", + "mainRepository": "Azure/azure-sdk-for-python" + }, + "azure-sdk-for-trenton": { + "integrationRepository": "Azure/azure-sdk-for-trenton", + "mainRepository": "Azure/azure-sdk-for-trenton", + "secondaryRepository": "Azure/azure-sdk-for-trenton", + "secondaryBranch": "secondary" + } + }, + "overrides": { + "Azure/azure-rest-api-specs-pr": { + "sdkRepositoryMappings": { + "azure-sdk-for-js": { + "integrationRepository": "azure-sdk/azure-sdk-for-js-pr", + "mainRepository": "Azure/azure-sdk-for-js-pr" + }, + "azure-sdk-for-python": { + "integrationRepository": "azure-sdk/azure-sdk-for-python-pr", + "mainRepository": "Azure/azure-sdk-for-python-pr", + "mainBranch": "release/v3" + }, + "azure-sdk-for-python-track2": { + "integrationRepository": "azure-sdk/azure-sdk-for-python-pr", + "mainRepository": "Azure/azure-sdk-for-python-pr" + } + } + } + } +} +``` + +#### SpecRepoConfig Schema +``` jsonc +{ + "type": "object", + "properties": { + "sdkRepositoryMappings": { + // A mapping of SDK repository names to the names of the SDK repositories + // that all interaction should go to instead. + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SdkRepositoryConfig" + }, + "propertyNames": { + // The property name is the sdk name identifier. + "type": "string" + } + }, + "overrides": { + // Override config for specific repository. + "type": "object", + "additionalProperties": { + "$ref": "#/" + }, + "propertyNames": { + // The property name is the sdk repo ref. + "$ref": "#/definitions/RepositoryName" + } + }, + "required": [ + "sdkRepositoryMappings" + ] + }, + "definitions": { + "RepositoryName": { + // Reference to a repository on github. Could be or /. + // By default the is the same as the owner of the spec repo. + "type": "string" + }, + "SdkRepositoryConfig": { + "type": "object", + "properties": { + "mainRepository": { + // The repository that the final release PR will targeting. + "$ref": "#/definitions/RepositoryName" + }, + "mainBranch": { + // Base branch of codegen branches + "default": "master", + "type": "string" + }, + "integrationRepository": { + // The repository that hold generation branch, generation PR and integration branch. + // By default it's the same as mainRepository + "$ref": "#/definitions/RepositoryName" + }, + "secondaryRepository": { + // Codegen runs on this repository. + // By default it's the same as 'mainRepository' but it could be different. + "$ref": "#/definitions/RepositoryName" + }, + "secondaryBranch": { + // Codegen runs on this branch on secondaryRepository. + // By default it's the same as 'mainBranch' but it could be different. + "type": "string" + }, + "integrationBranchPrefix": { + // The prefix that will be applied to the beginning of integration branches + "type": "string", + "default": "sdkAutomation" + }, + "configFilePath": { + // Path to swagger-to-sdk config in sdk repo + "default": "swagger_to_sdk_config.json" + } + }, + "required": [ + "mainRepository" + ] + } + } +} +``` + +### SwaggerToSdkConfig +This is type of file `./swagger_to_sdk_config.json` in sdk repo. +The running environment of these scripts would be expected to be __Ubuntu 18.04__ on Azure Pipeline. This may change in the future. All the running script should be executable. +The working folder of all the scripts is the __root folder of sdk repo__. + +#### SwaggerToSdkConfig Example +``` jsonc +{ + "advancedOptions": { + "createSdkPullRequests": true, + "generationCallMode": "one-for-all-configs" + }, + "initOptions": { + "initScript": { + "path": "./eng/tools/sdk_init" + } + }, + "generateOptions": { + // Param: + // generateInput.json: See #GenerateInput . + // generateOutput.json: See #GenerateOutput . + "generateScript": { + "path": "./eng/tools/sdk_generate", + "stderr": { + "showInComment": true + }, + "stdout": { + // Show logs start with "[Autorest]" in PR comment. + "showInComment": "^\\[Autorest\\]" + } + }, + + "parseGenerateOutput": true + }, + "packageOptions": { + // Param: + "buildScript": { + "path": "./eng/tools/sdk_package", + "stderr": { + // Everything in stderr will show in comment and mark package with warning. + "showInComment": true, + "scriptWarning": true + }, + "exitCode": { + // If exit code is not zero, mark package with warning instead of error. + "result": "warning" + } + }, + + // Param: + "changelogScript": { + "path": "./eng/tools/sdk_breaking_change", + "breakingChangeDetect": "Breaking Change" + } + }, + "artifactOptions": { + // Param: + // installInstructionInput.json: See #InstallInstructionScriptInput . + // installInstructionOutput.json: See #InstallInstructionScriptOutput . + "installInstructionScript": { + "path": "./eng/tools/sdk_install_instruction" + } + } +} +``` + +#### SwaggerToSdkConfig Schema +``` jsonc +{ + "type": "object", + "properties": { + "advancedOptions": { + // To keep backward compatibility, but will not list schema for old config options. + "properties": { + "createSdkPullRequests": { + // Should SDK Automation create PR or not. + "type": "boolean", + "default": true + }, + "closeIntegrationPR": { + // Should SDK Automation close integrationPR to reduce noise. + "type": "boolean", + "default": true + }, + "generationCallMode": { + // If we have multiple related readme.md, should we call generation once with + // all the readme.md or should we call generation multiple times and one per readme.md. + "type": "string", + "enum": [ + "one-per-config", + "one-for-all-configs" + ], + "default": "one-for-all-configs" + } + } + }, + "initOptions": { + // Init the environment. Install dependencies. + "type": "object", + "properties": { + "initScript": { + // Script to init. + "$ref": "#/definitions/RunOptions" + } + }, + "required": [ + "initScript" + ] + }, + "generateOptions": { + // Generate the SDK code. + "type": "object", + "properties": { + "generateScript": { + // Script to generate the SDK code. + // Param: + // generateInput.json: See #GenerateInput + // generateOutput.json: See #GenerateOutput + "$ref": "#/definitions/RunOptions" + }, + "preprocessDryRunGetPackageName": { + // If this options is set to true, generateScript will first run with + // "dryRun": true to get package name and related readme.md, + // then for each package, checkout the expected branch and launch generateScript. + "type": "boolean", + "default": false + }, + "parseGenerateOutput": { + // Will this script output to generateOutput.json. + // If not, default behavior will be applied that outcome will be + // detected automatically based on filename regex search. + "type": "boolean", + "default": true + } + }, + "required": [ + "generateScript" + ] + }, + "packageOptions": { + // Get package folder and build / get changelog + "type": "object", + "properties": { + "packageFolderFromFileSearch": { + "oneOf": [ + { + // If this option is set to object, then package folder will be detected automatically. + // based on filename regex search. + // This options must be set to object if parseGenerateOutput is false. + "type": "object", + "properties": { + "searchRegex": { + // Search algorithm: + // For each changed file detected after generation + // PotentialPackageFolder = folder of changed file + // While PotentialPackageFolder is not root folder of sdk repo: + // If PotentialPackageFolder contains a file that matches the searchRegex: + // PackageFolder found, break + // Else: + // PotentialPackageFolder = parent folder of PotentialPackageFolder + "type": "string", + "format": "regex" + }, + "pageNamePrefix": { + // Prefix to be appended to packageName. By default packageName will be the folder name of packageFolder + "type": "string" + } + }, + "required": [ + "searchRegex" + ] + }, + { + // If this option is set to false, then package folder will be from generateOutput.json. + "const": false + } + ], + "default": false, + }, + "buildScript": { + // Build the generated sdk. + // Param: + // Package folder could be a list separated by space if it's from generateOutput.json. + "$ref": "#/definitions/RunOptions" + }, + "changelogScript": { + // Changelog generation and breaking-change detection. + // Param: + // Package folder could be a list separated by space if it's from generateOutput.json. + // Expected output from stdout/stderr: Changelog in markdown + "allOf": { + "$ref": "#/definitions/RunOptions" + }, + "properties": { + "breakingChangeDetect": { + // If stdout or stderr matches this in output of changelog tool + // then we assume this SDK has breaking change. + "$ref": "#/definitions/RunLogFilterOptions" + } + } + } + } + }, + "artifactOptions": { + "artifactPathFromFileSearch": { + "oneOf": [ + { + // If this option is set to object, then artifacts will be detected automatically + // based on filename regex search. + // This options must be set to object if parseGenerateOutput is false. + "type": "object", + "properties": { + "searchRegex": { + // Any file under package folder matching the searchRegex is package artifact. + "type": "string", + "format": "regex", + } + } + }, + { + // If this option is set to false, then package folder will be from generateOutput.json + "const": false + } + ], + "default": false + }, + "installInstructionScript": { + // Generate install instruction that could be shown in spec PR comment (lite version) + // or in generated SDK PR (full version). + // If generateOutput.json contains installInstruction then this could be skipped. + // Param: + // installInstructionInput.json: See #InstallInstructionScriptInput . + // installInstructionOutput.json: See #InstallInstructionScriptInput . + "allOf": { + "$ref": "#/definitions/RunOptions" + } + } + } + }, + "definitions": { + "RunOptions": { + // Options to run a script and collect log. + "type": "object", + "properties": { + "path": { + // Script path related to repo root + "type": "string" + }, + "logPrefix": { + // Prefix to be added to SDK Automation log. By default it would be filename of the script. + "type": "string" + }, + "stdout": { + // How should SDK Automation handle the script stdout stream + "$ref": "#/definitions/RunLogOptions" + }, + "stderr": { + // How should SDK Automation handle the script stderr stream + "$ref": "#/definitions/RunLogOptions" + }, + "exitCode": { + // How should SDK Automation handle non-zero exitCode. + "showInComment": { + // Should we show this error in comment. + "type": "boolean", + "default": true + }, + "result": { + // If script has non-error exitCode how should we mark the script's result. + "type": "string", + "enum": [ + "error", "warning", "ignore" + ], + "default": "error" + } + }, + "required": [ + "path" + ] + } + }, + "RunLogOptions": { + // How should SDK Automation handle the log stream. + "showInComment": { + // Should we show this stream in comment. + "$ref": "#/definitions/RunLogFilterOptions" + }, + "scriptError": { + // If any line match, assume the script fails. + "$ref": "#/definitions/RunLogFilterOptions" + }, + "scriptWarning": { + // If any line match, assume the script warns. + "$ref": "#/definitions/RunLogFilterOptions" + } + }, + "RunLogFilterOptions": { + "oneOf": [ + { + // If line of log match this regex then hit + "type": "string", + "format": "regex" + }, + { + // If set to true, any line of log will hit + "type": "boolean" + } + ], + "default": false + } + } +} +``` + +### GenerateInput + +Input file for generate script. + +#### GenerateInput Example + +```jsonc +{ + "dryRun": false, + "specFolder": "/z/work/azure-rest-api-specs", + "headSha": "fce3400431eff281bddd04bed9727e63765b8da0", + "headRef": "refs/pull/1234/merge", + "repoHttpsUrl": "https://github.com/Azure/azure-rest-api-specs.git", + "trigger": "pull_request", + "changedFiles": [ + "specification/cdn/something/cdn.json" + ], + "relatedReadmeMdFiles": [ + "specification/cdn/something/readme.md" + ] +} +``` + +#### GenerateInput Schema + +```jsonc +{ + "type": "object", + "properties": { + "dryRun": { + // If dryRun is true, generateScript is expected to parse readme.md + // and output the package list with package name and related readme.md. + // Should not run codegen at this time. + "type": "boolean" + }, + "specFolder": { + // Path to local spec folder. + "type": "string" + }, + "headSha": { + // Git head sha. + "type": "string" + }, + "headRef": { + // Git head ref. + // Format will be "refs/pull//merge" or "refs/heads/". + "type": "string" + }, + "repoHttpsUrl": { + // Spec repo url in https without auth. + "type": "string" + }, + "trigger": { + // How this generation is triggered. + "type": "string", + "enum": [ + "pullRequest", + "continuousIntegration" + ] + }, + "changedFiles": { + // Changed file list in spec PR. + "type": "array", + "items": { + "type": "string" + } + }, + "relatedReadmeMdFiles": { + // Related readme.md files that pending generation. + "type": "array", + "items": { + "type": "string" + } + }, + "installInstructionInput": { + // See #InstallInstructionScriptInput + "$ref": "#/definitions/InstallInstructionScriptInput" + } + }, + "required": [ + "specFolder", "headSha", "headRef", "repoHttpsUrl", + "trigger", "changedFiles", "relatedReadmeMdFiles" + ] +} +``` + +### GenerateOutput + +Output file for generate script. + +#### GenerateOutput Example + +```jsonc +{ + "packages": [ + { + "packageName": "Microsoft.Cdn", + "path": [ + "sdk/cdn" + ], + "readmeMd": [ + "specification/cdn/something/readme.md" + ], + "changelog": { + "content": "Feature: something \n Breaking Changes: something\n", + "hasBreakingChange": true + }, + "artifacts": [ + "sdk/cdn/cdn.nuget", + "sdk/cdn/cdn.snuget" + ], + "installInstructions": { + "full": "To install something...", + "lite": "dotnet something" + }, + "result": "success" + } + ] +} +``` + +#### GenerateOutput Schema + +```jsonc +{ + "type": "object", + "properties": { + "packages": { + "type": "array", + "items": { + "$ref": "#/definitions/PackageResult" + } + } + }, + "required": [ + "packages" + ], + "definitions": { + "PackageResult": { + "properties": { + "packageName": { + // Name of package. Will be used in branch name and PR title. + // By default it's folder name of first entry in path. + "type": "string", + }, + "path": { + // List of package content paths. + // If the path points to a folder then + // all the content under the folder will be included. + "type": "array", + "items": { + "type": "string" + } + }, + "readmeMd": { + // List of related readmeMd of this package. + // Must provide this field if dryRun is true. + "type": "array", + "items": { + "type": "string" + } + }, + "changelog": { + "type": "object", + "properties": { + "content": { + // Content of changelog in markdown + "type": "string" + }, + "hasBreakingChange": { + // Does the new package has breaking change + "type": "boolean" + } + }, + "required": [ + "content" + ] + }, + "artifacts": { + "type": "array", + "items": { + "type": "string" + } + }, + "installInstructions": { + // See #InstallInstructionScriptOutput + "$ref": "#/definitions/InstallInstructionScriptOutput" + }, + }, + "required": [ + "path" + ] + } + } +} +``` + +### InstallInstructionScriptInput + +Input of install instruction script. + +#### InstallInstructionScriptInput Example + +```jsonc +{ + "packageName": "Microsoft.Cdn", + "artifacts": [ + "sdk/cdn/cdn.nuget", + "sdk/cdn/cdn.snuget" + ], + "isPublic": true, + "downloadUrlPrefix": "https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/azure-rest-api-specs/1234/azure-sdk-for-net/", + "downloadCommandTemplate": "curl -L \"{URL}\" -o {FILENAME}", + "trigger": "pullRequest", +} +``` + +#### InstallInstructionScriptInput Schema + +```jsonc +{ + "type": "object", + "properties": { + "packageName": { + // The package name. May be skipped if sdk automation don't know the info yet. + "type": "string" + }, + "artifacts": { + // List of artifact's path. May be skipped if sdk automation don't know the info yet. + "type": "array", + "items": { + "type": "string" + } + }, + "isPublic": { + // Is the download url public accessible. + // If it's false, the download command template will be + // az rest --resource -u "{URL}" --output-file {FILENAME} + "type": "boolean", + }, + "downloadUrlPrefix": { + // All the artifacts will be uploaded and user could access the artifact via + // a link composed by this prefix and artifact filename. + "type": "string" + }, + "downloadCommandTemplate": { + // Download command template. Replace {URL} and {FILENAME} to get the real command. + "type": "string" + }, + "trigger": { + "type": "string", + "enum": [ + "pullRequest", + "continuousIntegration" + ] + } + } +} +``` + +### InstallInstructionScriptOutput + +Output of install instruction script. + +#### InstallInstructionScriptOutput Example + +```jsonc +{ + "full": "To install something...", +} +``` + +#### InstallInstructionScriptInput Schema + +```jsonc +{ + "type": "object", + "properties": { + "full": { + // Full version of install instruction will be shown in generated SDK PR. + // Should be in markdown format. + "type": "string" + }, + "lite": { + // Lite version of install instruction will be shown in generated SDK PR. + // Should be in markdown format. + "type": "string" + } + }, + "required": [ + "full" + ] +} +``` From c1c45178f4a761b48f1778ac46cdd3304d7e33ef Mon Sep 17 00:00:00 2001 From: Ruoxuan Wang <52271048+ruowan@users.noreply.github.com> Date: Wed, 30 Sep 2020 15:56:44 +0800 Subject: [PATCH 163/164] Update pull_request_assignment.yml (#10974) * Update pull_request_assignment.yml China National Holiday * Update pull_request_assignment.yml * Update pull_request_assignment.yml --- .github/pull_request_assignment.yml | 153 +++++----------------------- 1 file changed, 24 insertions(+), 129 deletions(-) diff --git a/.github/pull_request_assignment.yml b/.github/pull_request_assignment.yml index 44d81ed03425..c6522255b3f0 100644 --- a/.github/pull_request_assignment.yml +++ b/.github/pull_request_assignment.yml @@ -8,122 +8,29 @@ - jhendrixMSFT - lmazuel - tjprescott - -- rule: - paths: - - "specification/network/**" - reviewers: - - MyronFanQiu - - lirenhe - -- rule: - paths: - - "specification/@(applicationinsights|operationalinsights)/**" - reviewers: - - MyronFanQiu - -- rule: - paths: "specification/compute/**" - reviewers: - - ArcturusZhang - - fengzhou-msft - - yungezz - -- rule: - paths: - - "specification/machinelearningservices/**" - reviewers: - - ArcturusZhang - -- rule: - paths: - - "specification/@(azureactivedirectory|appplatform)/**" - reviewers: - - njuCZ - -- rule: - paths: - - "specification/authorization/**" - reviewers: - - qianwens - - yungezz - -- rule: - paths: - - "specification/datafactory/**" - reviewers: - - qianwens - -- rule: - paths: - - "specification/monitor/**" - reviewers: - - weidongxu-microsoft - - MyronFanQiu - -- rule: - paths: - - "specification/storage/**" - reviewers: - - qianwens - - Juliehzl - -- rule: - paths: "specification/mediaservices/**" - reviewers: + +- rule: + paths: "specification/mediaservices/**" + reviewers: - allenjzhang - -- rule: - paths: - - "specification/@(keyvault|notificationhubs)/**" - - "specification/@(databricks|containerregistry)/**" - reviewers: - - fengzhou-msft - -- rule: - paths: - - "specification/@(containerservice|containerinstance)/**" - reviewers: - - PhoenixHe-msft - - fengzhou-msft - - yungezz - -- rule: - paths: - - "specification/mixedreality/**" - - "specification/hdinsight/**" - reviewers: - - leni-msft - -- rule: - paths: - - "specification/portal/**" - reviewers: - - PhoenixHe-msft - -- rule: - paths: - - "specification/web/**" - reviewers: - - weidongxu-microsoft - -- rule: - paths: - - "documentation/**" - reviewers: - - josefree - - akning-ms - -- rule: - paths: - - "**/package.json" - - ".github/**" - - "**/azure-pipelines.yml" - - ".azure-pipelines/**" - - ".azure-pipelines-preproduction/**" - reviewers: - - akning-ms - - PhoenixHe-msft + +- rule: + paths: + - "documentation/**" + reviewers: + - josefree + - akning-ms + +- rule: + paths: + - "**/package.json" + - ".github/**" + - "**/azure-pipelines.yml" + - ".azure-pipelines/**" + - ".azure-pipelines-preproduction/**" + reviewers: + - akning-ms + - PhoenixHe-msft - raych1 - rule: @@ -131,18 +38,6 @@ paths: - "**" reviewers: - - yungezz - - erich-wang - - PhoenixHe-msft - - lirenhe - - weidongxu-microsoft - - ArcturusZhang - - xccc-msft - - ChenTanyi - - fengzhou-msft - - njuCZ - - akning-ms + - allenjzhang - markcowl - - leni-msft - - qianwens - - ruowan + From 3695f4ef3bf65c253509d2708c31c96b71822613 Mon Sep 17 00:00:00 2001 From: vikrampraveen Date: Wed, 30 Sep 2020 08:55:40 -0700 Subject: [PATCH 164/164] Fix the acronym casing for ACSSMS (#10988) Co-authored-by: Vikram Praveen Kumar --- .../2018-01-01/AzureCommunicationServices.json | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json index 1b59779ce818..384521adebae 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json @@ -174,11 +174,11 @@ } } }, - "ACSSMSDeliveryReportReceivedEventData": { + "AcsSmsDeliveryReportReceivedEventData": { "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.SMSDeliveryReportReceived event.", "allOf": [ { - "$ref": "#/definitions/ACSSMSEventBaseProperties" + "$ref": "#/definitions/AcsSmsEventBaseProperties" } ], "properties": { @@ -194,7 +194,7 @@ "description": "List of details of delivery attempts made", "type": "array", "items": { - "$ref": "#/definitions/ACSSMSDeliveryAttemptProperties" + "$ref": "#/definitions/AcsSmsDeliveryAttemptProperties" } }, "receivedTimestamp": { @@ -204,11 +204,11 @@ } } }, - "ACSSMSReceivedEventData": { + "AcsSmsReceivedEventData": { "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.SMSReceived event.", "allOf": [ { - "$ref": "#/definitions/ACSSMSEventBaseProperties" + "$ref": "#/definitions/AcsSmsEventBaseProperties" } ], "properties": { @@ -311,7 +311,7 @@ } } }, - "ACSSMSEventBaseProperties": { + "AcsSmsEventBaseProperties": { "description": "Schema of common properties of all SMS events", "type": "object", "properties": { @@ -329,7 +329,7 @@ } } }, - "ACSSMSDeliveryAttemptProperties": { + "AcsSmsDeliveryAttemptProperties": { "description": "Schema for details of a delivery attempt", "type": "object", "properties": {